From 28b4a28aad2f9542aea8c102fbac91e7a7aa10ff Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Wed, 12 Oct 2022 10:15:36 -0700 Subject: [PATCH 01/15] docs: integrate onvif wsdl definitions with swagger file Signed-off-by: Anthony Casagrande --- doc/openapi/.gitignore | 4 + doc/openapi/Makefile | 37 +- doc/openapi/README.md | 29 +- doc/openapi/python/postprocess.py | 311 +- doc/openapi/python/requirements.txt | 1 + doc/openapi/python/xmlstrip.py | 127 + doc/openapi/ref/analytics.yaml | 25135 ++++++++++++ doc/openapi/ref/device.yaml | 31544 ++++++++++++++++ doc/openapi/ref/event.yaml | 3562 ++ doc/openapi/ref/imaging.yaml | 21663 +++++++++++ doc/openapi/ref/media.yaml | 28997 ++++++++++++++ doc/openapi/ref/media2.yaml | 25522 +++++++++++++ doc/openapi/ref/ptz.yaml | 23668 ++++++++++++ doc/openapi/sidecar.yaml | 394 +- doc/openapi/v2/device-onvif-camera.yaml | 29500 ++++++++++----- doc/postman/config.p2ojx.json | 13 - ...evice-onvif-camera.postman_collection.json | 43 +- 17 files changed, 180873 insertions(+), 9677 deletions(-) create mode 100644 doc/openapi/.gitignore create mode 100755 doc/openapi/python/xmlstrip.py create mode 100644 doc/openapi/ref/analytics.yaml create mode 100644 doc/openapi/ref/device.yaml create mode 100644 doc/openapi/ref/event.yaml create mode 100644 doc/openapi/ref/imaging.yaml create mode 100644 doc/openapi/ref/media.yaml create mode 100644 doc/openapi/ref/media2.yaml create mode 100644 doc/openapi/ref/ptz.yaml delete mode 100644 doc/postman/config.p2ojx.json diff --git a/doc/openapi/.gitignore b/doc/openapi/.gitignore new file mode 100644 index 00000000..6e193a4b --- /dev/null +++ b/doc/openapi/.gitignore @@ -0,0 +1,4 @@ +tmp/ +ref/out/ +schemas/_extracted.json +openapi.json diff --git a/doc/openapi/Makefile b/doc/openapi/Makefile index 0302d11f..31e3d208 100644 --- a/doc/openapi/Makefile +++ b/doc/openapi/Makefile @@ -1,43 +1,36 @@ -.PHONY: gen install schema-gen +.PHONY: gen install clean + +SHELL := /bin/bash POSTMAN_COLLECTION = ../postman/device-onvif-camera.postman_collection.json OPENAPI_FILE = v2/device-onvif-camera.yaml -OPENAPI_TEMP_FILE = ./tmp/device-onvif-camera.yaml +OPENAPI_TEMP_FILE = tmp/device-onvif-camera.yaml POSTMAN_2_OPENAPI_OPTIONS = p2o-options.json SIDECAR_FILE = sidecar.yaml PROFILE_FILE = ../../cmd/res/profiles/camera.yaml -SCHEMA_POSTMAN = ./device-onvif-camera.postman_collection.json -SCHEMA_TEMP = ../postman/openapi.json -OPENAPI_SCHEMA_TEMP_FILE = ./tmp/device-onvif-camera.schema.yaml -EXTRACTED_SCHEMA = ../postman/schemas/_extracted.json +# list of all services in the ./ref folder +SERVICES = analytics device event imaging media media2 ptz # todo: replace the API version number based on the actual source code version -$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_SCHEMA_TEMP_FILE) $(PROFILE_FILE) python/postprocess.py - python3 python/postprocess.py $(OPENAPI_SCHEMA_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) - rm -rf ./tmp - +$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) python/postprocess.py Makefile + python3 python/postprocess.py $(OPENAPI_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) $(OPENAPI_TEMP_FILE): $(POSTMAN_COLLECTION) $(POSTMAN_2_OPENAPI_OPTIONS) | ./tmp - p2o $(POSTMAN_COLLECTION) -f $(OPENAPI_TEMP_FILE) -o $(POSTMAN_2_OPENAPI_OPTIONS) + p2o $(POSTMAN_COLLECTION) -f $(OPENAPI_TEMP_FILE) -o $(POSTMAN_2_OPENAPI_OPTIONS) > /dev/null -./tmp: +./tmp ./ref/out: mkdir -p $@ install: npm install -g postman-to-openapi - npm install -g postman-to-openapi-json-extended pip3 install -r python/requirements.txt - snap install yq -$(SCHEMA_TEMP) schema-gen: - cd ../postman && \ - p2ojx extract $(SCHEMA_POSTMAN) && \ - p2ojx build - rm -f $(EXTRACTED_SCHEMA) +# generate the ref/out/.yaml files from the ref/.yaml files +$(SERVICES:%=ref/out/%.yaml) : ref/out/%.yaml : ref/%.yaml python/xmlstrip.py | ./ref/out + python/xmlstrip.py "$*" "ref/$*.yaml" "ref/out/$*.yaml" -$(OPENAPI_SCHEMA_TEMP_FILE): $(SCHEMA_TEMP) | ./tmp - yq . -o=yaml $(SCHEMA_TEMP) -P > $(OPENAPI_SCHEMA_TEMP_FILE) - rm -f $(SCHEMA_TEMP) +clean: + rm -rf ref/out tmp $(SCHEMA_TEMP_JSON) $(EXTRACTED_SCHEMA) diff --git a/doc/openapi/README.md b/doc/openapi/README.md index 2bef0d12..7ac2ba9b 100644 --- a/doc/openapi/README.md +++ b/doc/openapi/README.md @@ -1,8 +1,35 @@ -This code generates OpenAPI spec based on the Postman Collection +# OpenAPI / Swagger Spec Files +This code generates OpenAPI 3.0 spec based on the Postman Collection [device-onvif-camera.postman_collection.json](../postman/device-onvif-camera.postman_collection.json). It also does some automated find and replace to insert some missing example values. +> **TODO:** update usage + Usage: - Install `postman-to-openapi` by running `make install` from this directory. - Update the latest postman collection [device-onvif-camera.postman_collection.json](../postman/device-onvif-camera.postman_collection.json) - Run `make gen` to re-generate the OpenAPI files. + +## [python](python) folder +Contains scripts for processing the input and output files when +generating the OpenAPI spec file. + +### [xmlstrip.py](python/xmlstrip.py) +This script cleans up the yaml files in the [ref](ref) folder by removing all the xml +references in the schema, and tweaking the schema values to clean them up for use in +the [postprocess.py](#postprocesspypythonpostprocesspy) script. + +### [postprocess.py](python/postprocess.py) +This script takes in the preliminary OpenAPI file that was generated from the Postman collection +and adds additional metadata to it, as well as cleaning up the data and format. + + +## [ref](ref) folder +This folder contains files generated from the official Onvif wsdl +spec files. The wsdl files were imported into [apimatic.io](https://apimatic.io) +and exported as OpenAPI 3.0 spec yaml files. + +## [v2](v2) folder +This folder contains the final exported OpenAPI 3.0 spec file, to be +exported to SwaggerHub. + diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index ee29d437..0f28bb99 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -1,15 +1,20 @@ #!/usr/bin/env python3 import dataclasses +import io import sys +import copy +import textwrap -import yaml +from ruamel.yaml import YAML +from ruamel.yaml.scalarstring import LiteralScalarString +yaml = YAML() EDGEX = 'EdgeX' EDGEX_DEVICE_NAME = 'Camera001' API_PREFIX = '/api/v2/device/name/{EDGEX_DEVICE_NAME}' - +# mapping of service name to wsdl file for externalDocs SERVICE_WSDL = { 'Analytics': 'https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl', 'Device': 'https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl', @@ -20,11 +25,23 @@ 'PTZ': 'https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl' } +# list of superfluous headers to remove from response objects +HEADERS_TO_REMOVE = [ + 'Content-Length', + 'Content-Type', + 'Date', + 'Transfer-Encoding', +] + class ProcessingError(RuntimeError): pass +def make_scalar(val): + return LiteralScalarString(textwrap.dedent(val)) + + @dataclasses.dataclass class YamlProcessor: input_file: str @@ -35,34 +52,38 @@ class YamlProcessor: sidecar = None profile = None resources = {} + wsdl_files = {} - """Read input yaml file and sidecar yaml files""" def _load(self): + """Read input yaml file and sidecar yaml files""" print(f'Reading input OpenAPI file: {self.input_file}') with open(self.input_file) as f: - self.yml = yaml.safe_load(f.read()) + self.yml = yaml.load(f) print(f'Reading sidecar file: {self.sidecar_file}') with open(self.sidecar_file) as f: - self.sidecar = yaml.safe_load(f.read()) + self.sidecar = yaml.load(f) print(f'Reading profile file: {self.profile_file}') with open(self.profile_file) as f: - self.profile = yaml.safe_load(f.read()) + self.profile = yaml.load(f) - """Parse the device resources into a lookup table""" def _parse(self): + """Parse the device resources into a lookup table""" for resource in self.profile['deviceResources']: self.resources[resource['name']] = resource - """Output modified yaml file""" def _write(self): + """Output modified yaml file""" print(f'Writing output OpenAPI file: {self.output_file}') with open(self.output_file, 'w') as w: - w.write(yaml.dump(self.yml)) + yaml.dump(self.yml, w) + + def _process_apis(self): + """ + Sideload externalDocs using EdgeX profile file, update descriptions, and set schemas + """ - """Sideload externalDocs using EdgeX profile file""" - def _sideload_external_docs(self): for path, path_obj in self.yml['paths'].items(): for method, method_obj in path_obj.items(): cmd = path.split('/')[-1] @@ -73,46 +94,270 @@ def _sideload_external_docs(self): fn = attrs[f'{prefix}Function'] service = attrs['service'] - if service != EDGEX: - print(f'| {method.upper()} | {cmd} | {fn} | {fn.replace(cmd, "")} |') - # print(f'Patching external docs for {method.upper()} {cmd}') - method_obj = path_obj[method] - method_obj['externalDocs'] = { - 'description': 'Onvif Specification', - 'url': f'{SERVICE_WSDL[service]}#op.{fn}' + # add all responses + for code, resp_obj in self.sidecar['responses']['canned'].items(): + if code not in method_obj['responses']: + method_obj['responses'][code] = resp_obj + elif code == '200': + content = method_obj['responses']['200']['content'] + if 'application/json' not in content or \ + len(content['application/json']) == 0 or \ + ('example' in content['application/json'] and len(content['application/json']['example']) == 2): + print(f'Overriding empty 200 response for {service}_{fn}') + method_obj['responses'][code] = resp_obj + + if service == EDGEX: + # --- Custom EdgeX function patching --- + if method == 'get': + if cmd in self.sidecar['responses']['edgex']: + # clone the 200 response to avoid mangling pointer references + resp_200 = copy.deepcopy(method_obj['responses']['200']) + # apply the defined schema + resp_200['content']['application/json']['schema'] = self.sidecar['responses']['edgex'][cmd] + # override with cloned one + method_obj['responses']['200'] = resp_200 + else: + print(f'\033[33m[WARNING] \t -- Missing schema response definition for EdgeX command {method.upper()} {cmd}\033[0m') + elif method == 'put': + if cmd in self.sidecar['requests']['edgex']: + # look for the json response object, so we can modify it + jscontent = method_obj['requestBody']['content']['application/json'] + + # move the example outside the schema to preserve it (and it belongs better up there) + if 'example' in jscontent['schema']: + jscontent['example'] = jscontent['schema']['example'] + + # patch PUT call schema by using service name and onvif function name + jscontent['schema'] = { + 'properties': { + cmd: self.sidecar['requests']['edgex'][cmd] + }, + 'required': [cmd], + 'type': 'object' + } + else: + print(f'\033[33m[WARNING] \t -- Missing schema request definition for EdgeX command {method.upper()} {cmd}\033[0m') + + # override the response schema with default 200 response + method_obj['responses']['200'] = self.sidecar['responses']['canned']['200'] + + # nothing left to patch for custom edgex functions, as they do not exist in onvif spec + continue + + # --- ONVIF function patching --- + + method_obj = path_obj[method] + method_obj['externalDocs'] = { + 'description': 'Onvif Specification', + 'url': f'{SERVICE_WSDL[service]}#op.{fn}' + } + + # patch description for endpoints missing it + paths = self.wsdl_files[service]['paths'] + if f'/{fn}' in paths: + # note: all SOAP calls are POST + api = paths[f'/{fn}']['post'] + if 'description' in api and \ + ('description' not in method_obj or method_obj['description'].strip() == ''): + print(f'Copying description for {service}_{fn}') + method_obj['description'] = api['description'] + + # Special handling for PUT calls: + # - Move example out of schema into json object itself + # - Patch the input body schema based on the EdgeX command name and the Onvif function name + if method == 'put': + # look for the json response object, so we can modify it + jscontent = method_obj['requestBody']['content']['application/json'] + + # move the example outside the schema to preserve it (and it belongs better up there) + if 'example' in jscontent['schema']: + jscontent['example'] = jscontent['schema']['example'] + + # patch PUT call schema by using service name and onvif function name + jscontent['schema'] = { + 'properties': { + # EdgeX commands always require the command name as the object key. + # Note that this will actually insert the name of the command + cmd: { + # this generated name assumes the onvif schemas are named after the commands, + # prefixed by the service name by the xmlstrip.py script. + '$ref': f'#/components/schemas/{service.lower()}_{fn}' + } + }, + 'required': [cmd], + 'type': 'object' } + # Special handling for GET calls: + # - Ensure a 200 OK json response exists + # - Generate and override response schema for 200 OK data types based on Onvif spec + elif method == 'get': + # clone the 200 response to avoid mangling pointer references + resp_200 = copy.deepcopy(method_obj['responses']['200']) + # get a pointer to the json response body content + resp_content = resp_200['content']['application/json'] + # clone our example get response schema + schema = copy.deepcopy(self.sidecar['responses']['onvif']['get']) + + # patch the response schema to set the objectValue portion to be a reference to the + # onvif spec's function response. This assumes the onvif schemas are in the proper format of + # function name followed by Response, with the service as the prefix, as set by xmlstrip.py. + schema['allOf'][1]['properties']['event']['properties']['readings']['items']['properties']['objectValue'] = { + '$ref': f'#/components/schemas/{service.lower()}_{fn}Response' + } + # override the original schema with this modified one + resp_content['schema'] = schema + # override with cloned one + method_obj['responses']['200'] = resp_200 + + req_schema = f'{service.lower()}_{fn}' + if req_schema in self.yml['components']['schemas']: + schema = self.yml['components']['schemas'][req_schema] + if 'type' in schema and schema['type'] == 'object' and len(schema) == 1: + print(f'Skipping empty request schema for {service}_{fn}') + else: + buf = io.BytesIO() + yaml.dump({ + f'{service.lower()}_{fn}': + self.yml['components']['schemas'][f'{service.lower()}_{fn}']}, + buf) + method_obj['description'] = make_scalar(method_obj['description'] + f''' + +
+ +**`jsonObject` Schema:** + +_See: [{service.lower()}_{fn}](#{service.lower()}_{fn})_ + +```yaml +{self._gen_pretty_schema(None, self.yml['components']['schemas'][f'{service.lower()}_{fn}'], + indent=0, all_types=set(f'{service.lower()}_{fn}'))} +```''') + + def _combine_schemas(self): + """ + Load all schema files for the onvif spec, and combine them into the loaded yaml file. + This will also append the pre-defined schemas from the sidecar.yaml file. + """ + self.wsdl_files = {} + for service in SERVICE_WSDL.keys(): + fname = f'ref/out/{service.lower()}.yaml' + print(f'Loading schema file: {fname}') + with open(fname) as f: + self.wsdl_files[service] = yaml.load(f) + + print('Combining schema files') + schemas = {} + for schema_file in self.wsdl_files.values(): + for k, v in schema_file['components']['schemas'].items(): + schemas[k] = v + + self.yml['components'] = { + 'schemas': schemas, + 'headers': {}, + 'examples': {}, + } + + # note: sidecar should always be added last to override the onvif schemas + if 'components' in self.sidecar: + for component in ['schemas', 'headers', 'examples']: + # for each of the component types, copy the items to the output file + if component in self.sidecar['components']: + for k, v in self.sidecar['components'][component].items(): + self.yml['components'][component][k] = v + + def _gen_pretty_schema(self, name, val, indent, all_types): + if 'allOf' in val: + return self._gen_pretty_schema(name, val['allOf'][0], indent, all_types) + if '$ref' in val: + typ = val['$ref'].split('/')[-1] + if typ in all_types: + return " "*indent + '"%s": { $ref: %s }' % (name, typ) + all_types.add(typ) + return self._gen_pretty_schema(name, self.yml['components']['schemas'][typ], indent, all_types) + + if val['type'] == 'object': + if name is None: + output = " "*indent + '{\n' + else: + output = " "*indent + '"%s": {\n' % name + inners = [] + for prop, prop_val in val['properties'].items(): + inners.append(self._gen_pretty_schema(prop, prop_val, indent+2, all_types)) + output += ',\n'.join(inners) + '\n' + " "*indent + '}' + return output + + elif val['type'] == 'array': + return f'{" "*indent}"{name}": []' + + elif val['type'] == 'string': + return f'{" "*indent}"{name}": "<{name}>"' + + elif val['type'] == 'integer' or val['type'] == 'number': + return f'{" "*indent}"{name}": <{name}>' + + elif val['type'] == 'boolean': + return f'{" "*indent}"{name}": true|false' + + raise ProcessingError('unsupported data type') + def _verify_complete(self): + """ + _verify_complete checks that all functions from the device profile exist in the openapi file + """ for cmd, cmd_obj in self.resources.items(): + if cmd_obj['isHidden'] is True: + continue # skip hidden commands (not callable by the core-command service) + api = f'{API_PREFIX}/{cmd}' + path_obj = None if api not in self.yml['paths']: print(f'\033[33m[WARNING] API "{api}" is missing from input collection!\033[0m') - continue - - path_obj = self.yml['paths'][api] - if 'getFunction' in cmd_obj['attributes'] and 'get' not in path_obj: - print(f'\033[33m[WARNING] Expected call GET "{cmd}" was not found in input yaml!\033[0m') - if 'setFunction' in cmd_obj['attributes'] and 'put' not in path_obj: - print(f'\033[33m[WARNING] Expected call PUT "{cmd}" was not found in input yaml!\033[0m') - - """ - Goes through the paths and adds example values to all missing fields - - paths/[path]/[method]/parameters/[name=EDGEX_DEVICE_NAME] - """ + else: + path_obj = self.yml['paths'][api] + + if 'getFunction' in cmd_obj['attributes'] and (path_obj is None or 'get' not in path_obj): + print(f'\033[33m[WARNING] \t -- Expected call GET "{cmd}" was not found in input yaml!\033[0m') + if 'setFunction' in cmd_obj['attributes'] and (path_obj is None or 'put' not in path_obj): + print(f'\033[33m[WARNING] \t -- Expected call PUT "{cmd}" was not found in input yaml!\033[0m') + def _add_example_vars(self): + """ + Goes through the paths and adds example values to all missing fields + + paths/[path]/[method]/parameters/[name=EDGEX_DEVICE_NAME] + """ for _, path_obj in self.yml['paths'].items(): for _, method_obj in path_obj.items(): for param_obj in method_obj['parameters']: if param_obj['name'] == 'EDGEX_DEVICE_NAME': param_obj['example'] = EDGEX_DEVICE_NAME - """Process the input yaml files, and create the final output yaml file""" + def _clean_response_headers(self): + """ + Remove superfluous headers from response objects + """ + for _, path_obj in self.yml['paths'].items(): + for _, method_obj in path_obj.items(): + for _, response_obj in method_obj['responses'].items(): + if 'headers' in response_obj: + for header in HEADERS_TO_REMOVE: + if header in response_obj['headers']: + del response_obj['headers'][header] + # patch the correlation id to reference the stock one + if 'X-Correlation-Id' in response_obj['headers']: + response_obj['headers']['X-Correlation-Id'] = { + '$ref': '#/components/headers/correlatedResponseHeader' + } + def process(self): + """Process the input yaml files, and create the final output yaml file""" self._load() self._parse() - self._sideload_external_docs() + self._combine_schemas() + self._process_apis() self._add_example_vars() + self._clean_response_headers() self._verify_complete() self._write() diff --git a/doc/openapi/python/requirements.txt b/doc/openapi/python/requirements.txt index 5500f007..5c941d7f 100644 --- a/doc/openapi/python/requirements.txt +++ b/doc/openapi/python/requirements.txt @@ -1 +1,2 @@ PyYAML +ruamel.yaml diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py new file mode 100755 index 00000000..63abd710 --- /dev/null +++ b/doc/openapi/python/xmlstrip.py @@ -0,0 +1,127 @@ +#!/usr/bin/env python3 + +import re +import sys +import yaml + +# schemas to not include in the exported file +EXCLUDED_SCHEMAS = ['wstop_Topic', 'wstop_TopicNamespaceType', 'wstop_TopicType'] + +TITLE_REGEX = re.compile(r' +title: .*') +TNS_REGEX = re.compile(r'([ /])tns_') +TT_REGEX = re.compile(r'([ /])tt_') + + +def main(): + if len(sys.argv) != 4: + print(f'Usage: {sys.argv[0]} ') + + with open(sys.argv[2]) as f: + yml = yaml.safe_load(f.read()) + + for name, obj in yml.items(): + strip_xml(name, obj) + + for name, obj in yml.items(): + fix_refs(name, obj) + + yml['components']['schemas'] = fix_schemas(yml['components']['schemas']) + + service = sys.argv[1] + with open(sys.argv[3], 'w') as w: + # todo: this can be optimized better using streams. Right now it Dumps the yaml to a string + # and then processes each raw line before actually writing it to the output file. + lines = yaml.dump(yml).split('\n') + for line in lines: + if TITLE_REGEX.match(line): + continue # skip the title elements as they are all just superfluous + # namespace all tns schemas to this specific service + line = TNS_REGEX.sub(fr'\1{service}_', line) + # namespace all tt schemas as common onvif + line = TT_REGEX.sub(r'\1onvif_', line) + w.write(line) + w.write('\n') + + +def fix_schemas(schemas): + """ + Namespace all schemas by service name + """ + out = {} + service = sys.argv[1] + for k, v in schemas.items(): + + # note: this section is a bit redundant with the output writer that does a raw replace all, though + # this has the benefit of printing out the transformations. + if k.startswith('tt_') | k.startswith('tns_'): + k2 = k.replace('tt_', f'onvif_').replace('tns_', f'{service}_') + print(f'{k} -> {k2}') + out[k2] = v + + # only add schemas which are namespaced (ie. contain an underscore) + elif '_' in k and k not in EXCLUDED_SCHEMAS: + out[k] = v + return out + + +def fix_refs(name, obj): + """ + Turns this: + + PullMessagesFaultResponse: + allOf: + - $ref: '#/components/schemas/event_PullMessagesFaultResponse' + + into this: + + PullMessagesFaultResponse: + $ref: '#/components/schemas/event_PullMessagesFaultResponse' + """ + if type(obj) is dict: + if 'allOf' in obj and len(obj) == 1: + if len(obj['allOf']) == 1 and '$ref' in obj['allOf'][0]: + print(f'fixing schema ref for {name}') + obj['$ref'] = obj['allOf'][0]['$ref'] + del obj['allOf'] + else: + for n2, o2 in obj.items(): + fix_refs(f'{name}.{n2}', o2) + + elif type(obj) is list: + for o2 in obj: + fix_refs(f'{name}[]', o2) + + +def strip_xml(name, obj): + """ + - Remove xml definitions from openapi schema objects + - Remove empty description fields + - Redefine application/xml mime types to application/json + - Remove empty values from arrays + """ + if type(obj) is dict: + if 'xml' in obj: + print(f'Stripping xml field from {name}') + del obj['xml'] + + if 'description' in obj and obj['description'].strip() == '': + del obj['description'] + + if 'application/xml' in obj: + print('Redefining mime type to application/json') + obj['application/json'] = obj['application/xml'] + del obj['application/xml'] + + for n2, o2 in obj.items(): + strip_xml(f'{name}.{n2}', o2) + + elif type(obj) is list: + for o2 in obj: + strip_xml(f'{name}[]', o2) + if len(obj) == 2 and obj[1] == {}: + print('Removing empty value from array') + del obj[1] + + +if __name__ == '__main__': + main() diff --git a/doc/openapi/ref/analytics.yaml b/doc/openapi/ref/analytics.yaml new file mode 100644 index 00000000..f346abe7 --- /dev/null +++ b/doc/openapi/ref/analytics.yaml @@ -0,0 +1,25135 @@ +openapi: 3.0.0 +info: + title: Untitled API + contact: {} + version: '1.0' +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +paths: + /GetSupportedRules: + post: + tags: + - RuleEngineBinding + summary: GetSupportedRules + description: List all rules that are supported by the given VideoAnalyticsConfiguration. + operationId: GetSupportedRules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSupportedRulesRequest' + - xml: + name: GetSupportedRulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSupportedRulesResponse' + - xml: + name: GetSupportedRulesResponse + attribute: false + wrapped: false + deprecated: false + /CreateRules: + post: + tags: + - RuleEngineBinding + summary: CreateRules + description: >- + Add one or more rules to an existing VideoAnalyticsConfiguration. + The available supported types can be retrieved via + operationId: CreateRules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateRulesRequest' + - xml: + name: CreateRulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateRulesResponse' + - xml: + name: CreateRulesResponse + attribute: false + wrapped: false + deprecated: false + /DeleteRules: + post: + tags: + - RuleEngineBinding + summary: DeleteRules + description: Remove one or more rules from a VideoAnalyticsConfiguration. + operationId: DeleteRules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteRulesRequest' + - xml: + name: DeleteRulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteRulesResponse' + - xml: + name: DeleteRulesResponse + attribute: false + wrapped: false + deprecated: false + /GetRules: + post: + tags: + - RuleEngineBinding + summary: GetRules + description: List the currently assigned set of rules of a VideoAnalyticsConfiguration. + operationId: GetRules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRulesRequest' + - xml: + name: GetRulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRulesResponse' + - xml: + name: GetRulesResponse + attribute: false + wrapped: false + deprecated: false + /GetRuleOptions: + post: + tags: + - RuleEngineBinding + summary: GetRuleOptions + description: Return the options for the supported rules that specify an Option attribute. + operationId: GetRuleOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRuleOptionsRequest' + - xml: + name: GetRuleOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRuleOptionsResponse' + - xml: + name: GetRuleOptionsResponse + attribute: false + wrapped: false + deprecated: false + /ModifyRules: + post: + tags: + - RuleEngineBinding + summary: ModifyRules + description: Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names. + operationId: ModifyRules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ModifyRulesRequest' + - xml: + name: ModifyRulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ModifyRulesResponse' + - xml: + name: ModifyRulesResponse + attribute: false + wrapped: false + deprecated: false + /GetServiceCapabilities: + post: + tags: + - AnalyticsEngineBinding + summary: GetServiceCapabilities + description: Returns the capabilities of the analytics service. The result is returned in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + name: GetServiceCapabilitiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + deprecated: false + /GetSupportedAnalyticsModules: + post: + tags: + - AnalyticsEngineBinding + summary: GetSupportedAnalyticsModules + description: List all analytics modules that are supported by the given VideoAnalyticsConfiguration. + operationId: GetSupportedAnalyticsModules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSupportedAnalyticsModulesRequest' + - xml: + name: GetSupportedAnalyticsModulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSupportedAnalyticsModulesResponse' + - xml: + name: GetSupportedAnalyticsModulesResponse + attribute: false + wrapped: false + deprecated: false + /GetAnalyticsModuleOptions: + post: + tags: + - AnalyticsEngineBinding + summary: GetAnalyticsModuleOptions + description: Return the options for the supported analytics modules that specify an Option attribute. + operationId: GetAnalyticsModuleOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAnalyticsModuleOptionsRequest' + - xml: + name: GetAnalyticsModuleOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAnalyticsModuleOptionsResponse' + - xml: + name: GetAnalyticsModuleOptionsResponse + attribute: false + wrapped: false + deprecated: false + /CreateAnalyticsModules: + post: + tags: + - AnalyticsEngineBinding + summary: CreateAnalyticsModules + description: >- + Add one or more analytics modules to an existing VideoAnalyticsConfiguration. + The available supported types can be retrieved via + operationId: CreateAnalyticsModules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateAnalyticsModulesRequest' + - xml: + name: CreateAnalyticsModulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateAnalyticsModulesResponse' + - xml: + name: CreateAnalyticsModulesResponse + attribute: false + wrapped: false + deprecated: false + /DeleteAnalyticsModules: + post: + tags: + - AnalyticsEngineBinding + summary: DeleteAnalyticsModules + description: Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names. + operationId: DeleteAnalyticsModules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteAnalyticsModulesRequest' + - xml: + name: DeleteAnalyticsModulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteAnalyticsModulesResponse' + - xml: + name: DeleteAnalyticsModulesResponse + attribute: false + wrapped: false + deprecated: false + /GetAnalyticsModules: + post: + tags: + - AnalyticsEngineBinding + summary: GetAnalyticsModules + description: List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. + operationId: GetAnalyticsModules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAnalyticsModulesRequest' + - xml: + name: GetAnalyticsModulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAnalyticsModulesResponse' + - xml: + name: GetAnalyticsModulesResponse + attribute: false + wrapped: false + deprecated: false + /ModifyAnalyticsModules: + post: + tags: + - AnalyticsEngineBinding + summary: ModifyAnalyticsModules + 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. + operationId: ModifyAnalyticsModules + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ModifyAnalyticsModulesRequest' + - xml: + name: ModifyAnalyticsModulesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ModifyAnalyticsModulesResponse' + - xml: + name: ModifyAnalyticsModulesResponse + attribute: false + wrapped: false + deprecated: false + /GetSupportedMetadata: + post: + tags: + - AnalyticsEngineBinding + summary: GetSupportedMetadata + description: "This method provides a computer readable description of the metadata that the selected analytics modules can generate. \n 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." + operationId: GetSupportedMetadata + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSupportedMetadataRequest' + - xml: + name: GetSupportedMetadataRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSupportedMetadataResponse' + - xml: + name: GetSupportedMetadataResponse + attribute: false + wrapped: false + deprecated: false +components: + schemas: + tns_GetServiceCapabilities: + title: tns_GetServiceCapabilities + type: object + description: '' + xml: + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetServiceCapabilitiesResponse: + title: tns_GetServiceCapabilitiesResponse + required: + - Capabilities + type: object + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities' + - description: The capabilities for the analytics service is returned in the Capabilities element. + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Capabilities: + title: tns_Capabilities + type: object + properties: + RuleSupport: + type: boolean + description: Indication that the device supports the rules interface and the rules syntax. + xml: + name: RuleSupport + prefix: tns + attribute: true + wrapped: false + AnalyticsModuleSupport: + type: boolean + description: Indication that the device supports the scene analytics module interface. + xml: + name: AnalyticsModuleSupport + prefix: tns + attribute: true + wrapped: false + CellBasedSceneDescriptionSupported: + type: boolean + description: Indication that the device produces the cell based scene description + xml: + name: CellBasedSceneDescriptionSupported + prefix: tns + attribute: true + wrapped: false + RuleOptionsSupported: + type: boolean + description: Indication that the device supports the GetRuleOptions operation on the rules interface + xml: + name: RuleOptionsSupported + prefix: tns + attribute: true + wrapped: false + AnalyticsModuleOptionsSupported: + type: boolean + description: Indication that the device supports the GetAnalyticsModuleOptions operation on the analytics interface + xml: + name: AnalyticsModuleOptionsSupported + prefix: tns + attribute: true + wrapped: false + SupportedMetadata: + type: boolean + description: Indication that the device supports the GetSupportedMetadata operation. + xml: + name: SupportedMetadata + prefix: tns + attribute: true + wrapped: false + ImageSendingType: + type: string + description: Indication what kinds of method that the device support for sending image, acceptable values are defined in tt:ImageSendingType. + xml: + name: ImageSendingType + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSupportedRules: + title: tns_GetSupportedRules + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: >- + References an existing Video Analytics configuration. The list of available tokens can be obtained + via the Media service GetVideoAnalyticsConfigurations method. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSupportedRules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSupportedRulesResponse: + title: tns_GetSupportedRulesResponse + required: + - SupportedRules + type: object + properties: + SupportedRules: + allOf: + - $ref: '#/components/schemas/tt_SupportedRules' + - xml: + name: SupportedRules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSupportedRulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateRules: + title: tns_CreateRules + required: + - ConfigurationToken + - Rule + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateRules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateRulesResponse: + title: tns_CreateRulesResponse + type: object + description: '' + xml: + name: CreateRulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteRules: + title: tns_DeleteRules + required: + - ConfigurationToken + - RuleName + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + RuleName: + type: array + items: + type: string + xml: + name: RuleName + attribute: false + wrapped: false + description: References the specific rule to be deleted (e.g. "MyLineDetector"). + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteRules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteRulesResponse: + title: tns_DeleteRulesResponse + type: object + description: '' + xml: + name: DeleteRulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ModifyRules: + title: tns_ModifyRules + required: + - ConfigurationToken + - Rule + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: ModifyRules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ModifyRulesResponse: + title: tns_ModifyRulesResponse + type: object + description: '' + xml: + name: ModifyRulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetRules: + title: tns_GetRules + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetRules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetRulesResponse: + title: tns_GetRulesResponse + type: object + properties: + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetRulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetRuleOptions: + title: tns_GetRuleOptions + required: + - ConfigurationToken + type: object + properties: + RuleType: + type: string + description: Reference to an SupportedRule Type returned from GetSupportedRules. + xml: + name: RuleType + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing analytics configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetRuleOptions + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetRuleOptionsResponse: + title: tns_GetRuleOptionsResponse + type: object + properties: + RuleOptions: + type: array + items: + $ref: '#/components/schemas/tns_ConfigOptions' + 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. + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetRuleOptionsResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ConfigOptions: + title: tns_ConfigOptions + required: + - Name + type: object + properties: + RuleType: + type: string + description: The RuleType the ConfigOptions applies to if the Name attribute is ambiguous. + xml: + name: RuleType + prefix: tns + attribute: true + wrapped: false + Name: + type: string + description: >- + The Name of the SimpleItemDescription/ElementItemDescription + the ConfigOptions applies to. + xml: + name: Name + prefix: tns + attribute: true + wrapped: false + Type: + type: string + description: "Type of the Rule Options represented by a unique QName. \n The Type defines the element contained in this structure.\n This attribute is deprecated since its value must be identical to the embedded element." + xml: + name: Type + prefix: tns + attribute: true + wrapped: false + AnalyticsModule: + type: string + 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. + xml: + name: AnalyticsModule + prefix: tns + attribute: true + wrapped: false + minOccurs: + type: integer + description: Minimal number of occurrences. Defaults to one. + format: int32 + xml: + name: minOccurs + prefix: tns + attribute: true + wrapped: false + maxOccurs: + type: integer + description: Maximum number of occurrences. Defaults to one. + format: int32 + xml: + name: maxOccurs + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: ConfigOptions + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSupportedAnalyticsModules: + title: tns_GetSupportedAnalyticsModules + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSupportedAnalyticsModules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSupportedAnalyticsModulesResponse: + title: tns_GetSupportedAnalyticsModulesResponse + required: + - SupportedAnalyticsModules + type: object + properties: + SupportedAnalyticsModules: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModules' + - xml: + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSupportedAnalyticsModulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateAnalyticsModules: + title: tns_CreateAnalyticsModules + required: + - ConfigurationToken + - AnalyticsModule + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateAnalyticsModules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateAnalyticsModulesResponse: + title: tns_CreateAnalyticsModulesResponse + type: object + description: '' + xml: + name: CreateAnalyticsModulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteAnalyticsModules: + title: tns_DeleteAnalyticsModules + required: + - ConfigurationToken + - AnalyticsModuleName + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing Video Analytics configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + AnalyticsModuleName: + type: array + items: + type: string + xml: + name: AnalyticsModuleName + attribute: false + wrapped: false + description: Name of the AnalyticsModule to be deleted. + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteAnalyticsModules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteAnalyticsModulesResponse: + title: tns_DeleteAnalyticsModulesResponse + type: object + description: '' + xml: + name: DeleteAnalyticsModulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ModifyAnalyticsModules: + title: tns_ModifyAnalyticsModules + required: + - ConfigurationToken + - AnalyticsModule + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: ModifyAnalyticsModules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ModifyAnalyticsModulesResponse: + title: tns_ModifyAnalyticsModulesResponse + type: object + description: '' + xml: + name: ModifyAnalyticsModulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAnalyticsModules: + title: tns_GetAnalyticsModules + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing VideoAnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAnalyticsModules + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAnalyticsModulesResponse: + title: tns_GetAnalyticsModulesResponse + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAnalyticsModulesResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAnalyticsModuleOptions: + title: tns_GetAnalyticsModuleOptions + required: + - ConfigurationToken + type: object + properties: + Type: + type: string + description: Reference to an SupportedAnalyticsModule Type returned from GetSupportedAnalyticsModules. + xml: + name: Type + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Reference to an existing AnalyticsConfiguration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAnalyticsModuleOptions + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAnalyticsModuleOptionsResponse: + title: tns_GetAnalyticsModuleOptionsResponse + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tns_ConfigOptions' + description: List of options for the specified analytics module. The response Options shall not contain any RuleType attribute. + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAnalyticsModuleOptionsResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSupportedMetadata: + title: tns_GetSupportedMetadata + type: object + properties: + Type: + type: string + description: Optional reference to an AnalyticsModule Type returned from GetSupportedAnalyticsModules. + xml: + name: Type + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSupportedMetadata + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSupportedMetadataResponse: + title: tns_GetSupportedMetadataResponse + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tns_MetadataInfo' + description: '' + xml: + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSupportedMetadataResponse + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MetadataInfo: + title: tns_MetadataInfo + required: + - Type + - SampleFrame + type: object + properties: + Type: + type: string + description: Reference to an AnalyticsModule Type. + xml: + name: Type + prefix: tns + attribute: true + wrapped: false + SampleFrame: + allOf: + - $ref: '#/components/schemas/tt_Frame' + - description: Sample frame content starting with the tt:Frame node. + xml: + name: SampleFrame + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: MetadataInfo + namespace: http://www.onvif.org/ver20/analytics/wsdl + prefix: tns + attribute: false + wrapped: false + tt_IntRange: + title: tt_IntRange + required: + - Min + - Max + type: object + properties: + Min: + type: integer + format: int32 + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: integer + format: int32 + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: IntRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector2D: + title: tt_Vector2D + required: + - x + - y + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Pan/tilt coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector2D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector1D: + title: tt_Vector1D + required: + - x + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Zoom coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector1D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZVector: + title: tt_PTZVector + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan and the y component to tilt. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom position. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZVector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatus: + title: tt_PTZStatus + required: + - UtcTime + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - 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. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: States a current PTZ error. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UtcTime: + type: string + description: Specifies the UTC time when this status was generated. + format: date-time + xml: + name: UtcTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZMoveStatus: + title: tt_PTZMoveStatus + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZMoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveStatus: + title: tt_MoveStatus + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + description: '' + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector: + title: tt_Vector + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rectangle: + title: tt_Rectangle + type: object + properties: + bottom: + type: number + xml: + name: bottom + prefix: tt + attribute: true + wrapped: false + top: + type: number + xml: + name: top + prefix: tt + attribute: true + wrapped: false + right: + type: number + xml: + name: right + prefix: tt + attribute: true + wrapped: false + left: + type: number + xml: + name: left + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Rectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polygon: + title: tt_Polygon + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polygon + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Color: + title: tt_Color + required: + - X + - Y + - Z + type: object + properties: + X: + type: number + xml: + name: X + prefix: tt + attribute: true + wrapped: false + Y: + type: number + xml: + name: Y + prefix: tt + attribute: true + wrapped: false + Z: + type: number + xml: + name: Z + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: 'Acceptable values:' + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorCovariance: + title: tt_ColorCovariance + required: + - XX + - YY + - ZZ + type: object + properties: + XX: + type: number + xml: + name: XX + prefix: tt + attribute: true + wrapped: false + YY: + type: number + xml: + name: YY + prefix: tt + attribute: true + wrapped: false + ZZ: + type: number + xml: + name: ZZ + prefix: tt + attribute: true + wrapped: false + XY: + type: number + xml: + name: XY + prefix: tt + attribute: true + wrapped: false + XZ: + type: number + xml: + name: XZ + prefix: tt + attribute: true + wrapped: false + YZ: + type: number + xml: + name: YZ + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: ColorCovariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorDescriptor: + title: tt_ColorDescriptor + type: object + properties: + ColorCluster: + type: array + items: + $ref: '#/components/schemas/tt_ColorCluster' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transformation: + title: tt_Transformation + type: object + properties: + Translate: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Translate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Scale: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Scale + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TransformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransformationExtension: + title: tt_TransformationExtension + type: object + description: '' + xml: + name: TransformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoLocation: + title: tt_GeoLocation + type: object + properties: + lon: + type: number + description: East west location as angle. + xml: + name: lon + prefix: tt + attribute: true + wrapped: false + lat: + type: number + description: North south location as angle. + xml: + name: lat + prefix: tt + attribute: true + wrapped: false + elevation: + type: number + description: Hight in meters above sea level. + xml: + name: elevation + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoOrientation: + title: tt_GeoOrientation + type: object + properties: + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + pitch: + type: number + description: Rotation around the y axis. + xml: + name: pitch + prefix: tt + attribute: true + wrapped: false + yaw: + type: number + description: Rotation around the z axis. + xml: + name: yaw + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalLocation: + title: tt_LocalLocation + type: object + properties: + x: + type: number + description: East west location as angle. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: North south location as angle. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + z: + type: number + description: Offset in meters from the sea level. + xml: + name: z + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalOrientation: + title: tt_LocalOrientation + type: object + properties: + pan: + type: number + description: Rotation around the y axis. + xml: + name: pan + prefix: tt + attribute: true + wrapped: false + tilt: + type: number + description: Rotation around the z axis. + xml: + name: tilt + prefix: tt + attribute: true + wrapped: false + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Entity: + title: tt_Entity + enum: + - Device + - VideoSource + - AudioSource + type: string + description: '' + xml: + name: Entity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocationEntity: + title: tt_LocationEntity + type: object + properties: + Entity: + type: string + description: Entity type the entry refers to, use a value from the tt:Entity enumeration. + xml: + name: Entity + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + description: Optional entity token. + xml: + name: Token + prefix: tt + attribute: true + wrapped: false + Fixed: + type: boolean + description: If this value is true the entity cannot be deleted. + xml: + name: Fixed + prefix: tt + attribute: true + wrapped: false + GeoSource: + type: string + description: Optional reference to the XAddr of another devices DeviceManagement service. + xml: + name: GeoSource + prefix: tt + attribute: true + wrapped: false + AutoGeo: + type: boolean + description: If set the geo location is obtained internally. + xml: + name: AutoGeo + prefix: tt + attribute: true + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: Location on earth. + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GeoOrientation: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Orientation relative to earth. + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalLocation: + allOf: + - $ref: '#/components/schemas/tt_LocalLocation' + - description: Indoor location offset. + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalOrientation: + allOf: + - $ref: '#/components/schemas/tt_LocalOrientation' + - description: Indoor orientation offset. + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LocationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceEntity: + title: tt_DeviceEntity + required: + - token + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier referencing the physical entity. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + description: Base class for physical entities like inputs and outputs. + xml: + name: DeviceEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangle: + title: tt_IntRectangle + required: + - x + - y + - width + - height + type: object + properties: + x: + type: integer + format: int32 + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: integer + format: int32 + xml: + name: y + prefix: tt + attribute: true + wrapped: false + width: + type: integer + format: int32 + xml: + name: width + prefix: tt + attribute: true + wrapped: false + height: + type: integer + format: int32 + xml: + name: height + prefix: tt + attribute: true + wrapped: false + description: Rectangle defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangleRange: + title: tt_IntRectangleRange + required: + - XRange + - YRange + - WidthRange + - HeightRange + type: object + properties: + XRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of X-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of Y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WidthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of width. + xml: + name: WidthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HeightRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of height. + xml: + name: HeightRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangleRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatRange: + title: tt_FloatRange + required: + - Min + - Max + type: object + properties: + Min: + type: number + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: number + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: FloatRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DurationRange: + title: tt_DurationRange + required: + - Min + - Max + type: object + properties: + Min: + type: string + format: date-time + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: string + format: date-time + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of duration greater equal Min duration and less equal Max duration. + xml: + name: DurationRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntItems: + title: tt_IntItems + type: object + properties: + Items: + type: array + items: + type: integer + format: int32 + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: List of values. + xml: + name: IntItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatItems: + title: tt_FloatItems + type: object + properties: + Items: + type: array + items: + type: number + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FloatItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StringItems: + title: tt_StringItems + required: + - Item + type: object + properties: + Item: + type: array + items: + type: string + xml: + name: Item + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StringItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnyHolder: + title: tt_AnyHolder + type: object + description: '' + xml: + name: AnyHolder + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSource: + title: tt_VideoSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Framerate + - Resolution + type: object + properties: + Framerate: + type: number + description: Frame rate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Horizontal and vertical resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings' + - description: Optional configuration of the image sensor. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video input. + tt_VideoSourceExtension: + title: tt_VideoSourceExtension + type: object + properties: + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if imaging service 2.00 is supported. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceExtension2: + title: tt_VideoSourceExtension2 + type: object + description: '' + xml: + name: VideoSourceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSource: + title: tt_AudioSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Channels + type: object + properties: + Channels: + type: integer + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + xml: + name: Channels + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio input. + tt_Profile: + title: tt_Profile + required: + - token + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of the profile. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: A value of true signals that the profile cannot be deleted. Default is false. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and rule engine. + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + A media profile consists of a set of media configurations. Media profiles are used by a client + to configure properties of a media stream from an NVT. + xml: + name: Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension: + title: tt_ProfileExtension + type: object + properties: + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension2: + title: tt_ProfileExtension2 + type: object + description: '' + xml: + name: ProfileExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfiguration: + title: tt_VideoSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + - Bounds + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Reference to the physical input. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bounds: + allOf: + - $ref: '#/components/schemas/tt_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area. + xml: + name: Bounds + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ViewMode: + type: string + description: Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes. + xml: + name: ViewMode + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioSourceConfiguration: + title: tt_AudioSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Token of the Audio Source the configuration applies to + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncoderConfiguration: + title: tt_VideoEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Configuration' + - description: Optional element to configure H.264 related parameters. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related video stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoderConfiguration: + title: tt_AudioEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoAnalyticsConfiguration: + title: tt_VideoAnalyticsConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfiguration' + - xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZConfiguration: + title: tt_PTZConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - NodeToken + type: object + properties: + NodeToken: + maxLength: 64 + type: string + description: A mandatory reference to the PTZ Node that the PTZ Configuration belongs to. + xml: + name: NodeToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsolutePantTiltPositionSpace: + type: string + description: If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default. + xml: + name: DefaultAbsolutePantTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsoluteZoomPositionSpace: + type: string + description: If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default. + xml: + name: DefaultAbsoluteZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativePanTiltTranslationSpace: + type: string + description: If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default. + xml: + name: DefaultRelativePanTiltTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativeZoomTranslationSpace: + type: string + description: If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default. + xml: + name: DefaultRelativeZoomTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousPanTiltVelocitySpace: + type: string + description: If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default. + xml: + name: DefaultContinuousPanTiltVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousZoomVelocitySpace: + type: string + description: If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default. + xml: + name: DefaultContinuousZoomVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds. + xml: + name: DefaultPTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZTimeout: + type: string + description: If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops. + format: date-time + xml: + name: DefaultPTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/tt_PanTiltLimits' + - 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. + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomLimits: + allOf: + - $ref: '#/components/schemas/tt_ZoomLimits' + - 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. + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveRamp: + type: integer + description: The optional acceleration ramp used by the device when moving. + format: int32 + xml: + name: MoveRamp + prefix: tt + attribute: true + wrapped: false + PresetRamp: + type: integer + description: The optional acceleration ramp used by the device when recalling presets. + format: int32 + xml: + name: PresetRamp + prefix: tt + attribute: true + wrapped: false + PresetTourRamp: + type: integer + description: The optional acceleration ramp used by the device when executing PresetTours. + format: int32 + xml: + name: PresetTourRamp + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_MetadataConfiguration: + title: tt_MetadataConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Multicast + - SessionTimeout + type: object + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZFilter' + - description: optional element to configure which PTZ related data is to include in the metadata stream + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventSubscription' + - description: "Optional element to configure the streaming of events. A client might be interested in receiving all, \n none or some of the events produced by the device:" + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Analytics: + type: boolean + description: Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.) + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored) + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - description: >- + Indication which AnalyticsModules shall output metadata. + Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration. + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CompressionType: + type: string + description: Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType. + xml: + name: CompressionType + prefix: tt + attribute: true + wrapped: false + GeoLocation: + type: boolean + description: Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + ShapePolygon: + type: boolean + description: Optional parameter to configure if the generated metadata stream should contain shape information as polygon. + xml: + name: ShapePolygon + prefix: tt + attribute: true + wrapped: false + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioOutputConfiguration: + title: tt_AudioOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + - OutputLevel + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the phsycial Audio output. + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacy: + type: string + description: >- + An audio channel MAY support different types of audio transmission. While for full duplex + operation no special handling is required, in half duplex operation the transmission direction + needs to be switched. + The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which + direction is currently active. An NVC can switch between different modes by setting the + AudioOutputConfiguration. + xml: + name: SendPrimacy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevel: + type: integer + description: Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange. + format: int32 + xml: + name: OutputLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioDecoderConfiguration: + title: tt_AudioDecoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - type: object + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The Audio Decoder Configuration does not contain any that parameter to configure the + + decoding .A decoder shall decode every data it receives (according to its capabilities). + tt_ConfigurationEntity: + title: tt_ConfigurationEntity + required: + - token + - Name + - UseCount + type: object + properties: + token: + maxLength: 64 + type: string + description: Token that uniquely references this configuration. Length up to 64 characters. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name. Length up to 64 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseCount: + type: integer + description: Number of internal references currently using this configuration. + format: int32 + xml: + name: UseCount + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Base type defining the common properties of a configuration. + xml: + name: ConfigurationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension: + title: tt_VideoSourceConfigurationExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_Rotate' + - description: >- + Optional element to configure rotation of captured image. + What resolutions a device supports shall be unaffected by the Rotate parameters. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension2: + title: tt_VideoSourceConfigurationExtension2 + type: object + properties: + LensDescription: + type: array + items: + $ref: '#/components/schemas/tt_LensDescription' + description: Optional element describing the geometric lens distortion. Multiple instances for future variable lens support. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneOrientation: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientation' + - description: Optional element describing the scene orientation in the camera’s field of view. + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rotate: + title: tt_Rotate + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RotateMode' + - description: Parameter to enable/disable Rotation feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Degree: + type: integer + 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. + format: int32 + xml: + name: Degree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateExtension: + title: tt_RotateExtension + type: object + description: '' + xml: + name: RotateExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateMode: + title: tt_RotateMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: RotateMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensProjection: + title: tt_LensProjection + required: + - Angle + - Radius + type: object + properties: + Angle: + type: number + description: Angle of incidence. + xml: + name: Angle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Radius: + type: number + description: Mapping radius as a consequence of the emergent angle. + xml: + name: Radius + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transmittance: + type: number + description: Optional ray absorption at the given angle due to vignetting. A value of one means no absorption. + xml: + name: Transmittance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensProjection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensOffset: + title: tt_LensOffset + type: object + properties: + x: + type: number + description: Optional horizontal offset of the lens center in normalized coordinates. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: Optional vertical offset of the lens center in normalized coordinates. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LensOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensDescription: + title: tt_LensDescription + required: + - Offset + - Projection + - XFactor + type: object + properties: + FocalLength: + type: number + description: Optional focal length of the optical system. + xml: + name: FocalLength + prefix: tt + attribute: true + wrapped: false + Offset: + allOf: + - $ref: '#/components/schemas/tt_LensOffset' + - description: Offset of the lens center to the imager center in normalized coordinates. + xml: + name: Offset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Projection: + type: array + items: + $ref: '#/components/schemas/tt_LensProjection' + description: "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation \n over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. \n Items outside the last projection Radius shall be assumed to be invisible (black)." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XFactor: + type: number + description: Compensation of the x coordinate needed for the ONVIF normalized coordinate system. + xml: + name: XFactor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptions: + title: tt_VideoSourceConfigurationOptions + required: + - BoundsRange + - VideoSourceTokensAvailable + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tt + attribute: true + wrapped: false + BoundsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRectangleRange' + - description: >- + Supported range for the capturing area. + Device that does not support cropped streaming shall express BoundsRange option as mentioned below + BoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits. + xml: + name: BoundsRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: VideoSourceTokensAvailable + attribute: false + wrapped: false + description: List of physical inputs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension: + title: tt_VideoSourceConfigurationOptionsExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_RotateOptions' + - description: Options of parameters for Rotation feature. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension2: + title: tt_VideoSourceConfigurationOptionsExtension2 + type: object + properties: + SceneOrientationMode: + type: array + items: + $ref: '#/components/schemas/tt_SceneOrientationMode' + description: Scene orientation modes supported by the device for this configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptions: + title: tt_RotateOptions + required: + - Mode + type: object + properties: + Reboot: + type: boolean + description: >- + After setting the rotation, if a device starts to reboot this value is true. + If a device can handle rotation setting without rebooting this value is false. + xml: + name: Reboot + prefix: tt + attribute: true + wrapped: false + Mode: + type: array + items: + $ref: '#/components/schemas/tt_RotateMode' + description: Supported options of Rotate mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DegreeList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported degree value for rotation. + xml: + name: DegreeList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RotateOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptionsExtension: + title: tt_RotateOptionsExtension + type: object + description: '' + xml: + name: RotateOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationMode: + title: tt_SceneOrientationMode + enum: + - MANUAL + - AUTO + type: string + description: '' + xml: + name: SceneOrientationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationOption: + title: tt_SceneOrientationOption + enum: + - Below + - Horizon + - Above + type: string + description: Defines the acceptable values for the Orientation element of the SceneOrientation type + xml: + name: SceneOrientationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientation: + title: tt_SceneOrientation + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene orientation. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Orientation: + type: string + description: "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field \n is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required \n and the device will return an InvalidArgs fault if missing." + xml: + name: Orientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ViewModes: + title: tt_ViewModes + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + type: string + description: Source view modes supported by device. + xml: + name: ViewModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoding: + title: tt_VideoEncoding + enum: + - JPEG + - MPEG4 + - H264 + type: string + description: '' + xml: + name: VideoEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Profile: + title: tt_Mpeg4Profile + enum: + - SP + - ASP + type: string + description: '' + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Profile: + title: tt_H264Profile + enum: + - Baseline + - Main + - Extended + - High + type: string + description: '' + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoResolution: + title: tt_VideoResolution + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl: + title: tt_VideoRateControl + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + type: object + properties: + FrameRateLimit: + type: integer + description: Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor. + format: int32 + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingInterval: + type: integer + 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 ...) + format: int32 + xml: + name: EncodingInterval + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Configuration: + title: tt_Mpeg4Configuration + required: + - GovLength + - Mpeg4Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP) + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Configuration: + title: tt_H264Configuration + required: + - GovLength + - H264Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264Profile: + allOf: + - $ref: '#/components/schemas/tt_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderConfigurationOptions: + title: tt_VideoEncoderConfigurationOptions + required: + - QualityRange + type: object + properties: + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension element). + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension element). + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension element). + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension: + title: tt_VideoEncoderOptionsExtension + type: object + properties: + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options2' + - description: Optional H.264 encoder settings ranges. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension2: + title: tt_VideoEncoderOptionsExtension2 + type: object + description: '' + xml: + name: VideoEncoderOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions: + title: tt_JpegOptions + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions2: + title: tt_JpegOptions2 + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: JpegOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_Mpeg4Options: + title: tt_Mpeg4Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported MPEG-4 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Options2: + title: tt_Mpeg4Options2 + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Mpeg4Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_H264Options: + title: tt_H264Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H.264 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Options2: + title: tt_H264Options2 + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: H264Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncodingMimeNames: + title: tt_VideoEncodingMimeNames + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + type: string + description: Video Media Subtypes as referenced by IANA (without the leading "video/" Video Media Type). See also + xml: + name: VideoEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncodingProfiles: + title: tt_VideoEncodingProfiles + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + type: string + description: '' + xml: + name: VideoEncodingProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2Configuration: + title: tt_VideoEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + type: object + properties: + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution2' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + prefix: tt + attribute: true + wrapped: false + Profile: + type: string + description: The encoder profile as defined in tt:VideoEncodingProfiles. + xml: + name: Profile + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoResolution2: + title: tt_VideoResolution2 + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl2: + title: tt_VideoRateControl2 + required: + - FrameRateLimit + - BitrateLimit + type: object + properties: + ConstantBitRate: + type: boolean + description: Enforce constant bitrate. + xml: + name: ConstantBitRate + prefix: tt + attribute: true + wrapped: false + FrameRateLimit: + type: number + description: Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations. + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2ConfigurationOptions: + title: tt_VideoEncoder2ConfigurationOptions + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + type: object + properties: + GovLengthRange: + type: integer + 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. + format: int32 + xml: + name: GovLengthRange + prefix: tt + attribute: true + wrapped: false + FrameRatesSupported: + type: number + description: List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first. + xml: + name: FrameRatesSupported + prefix: tt + attribute: true + wrapped: false + ProfilesSupported: + type: string + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + xml: + name: ProfilesSupported + prefix: tt + attribute: true + wrapped: false + ConstantBitRateSupported: + type: boolean + description: Signal whether enforcing constant bitrate is supported. + xml: + name: ConstantBitRateSupported + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution2' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceConfigurationOptions: + title: tt_AudioSourceConfigurationOptions + required: + - InputTokensAvailable + type: object + properties: + InputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the audio source the configuration can be used for. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceOptionsExtension: + title: tt_AudioSourceOptionsExtension + type: object + description: '' + xml: + name: AudioSourceOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoding: + title: tt_AudioEncoding + enum: + - G711 + - G726 + - AAC + type: string + description: '' + xml: + name: AudioEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOptions: + title: tt_AudioEncoderConfigurationOptions + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfigurationOption' + description: list of supported AudioEncoderConfigurations + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOption: + title: tt_AudioEncoderConfigurationOption + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncodingMimeNames: + title: tt_AudioEncodingMimeNames + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + type: string + description: Audio Media Subtypes as referenced by IANA (without the leading "audio/" Audio Media Type and except for the audio types defined in the restriction). See also + xml: + name: AudioEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoder2Configuration: + title: tt_AudioEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoder2ConfigurationOptions: + title: tt_AudioEncoder2ConfigurationOptions + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationExtension: + title: tt_MetadataConfigurationExtension + type: object + description: '' + xml: + name: MetadataConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZFilter: + title: tt_PTZFilter + required: + - Status + - Position + type: object + properties: + Status: + type: boolean + description: True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN) + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + type: boolean + description: True if the metadata stream shall contain the PTZ position + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventSubscription: + title: tt_EventSubscription + type: object + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Subcription handling in the same way as base notification subscription. + xml: + name: EventSubscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptions: + title: tt_MetadataConfigurationOptions + required: + - PTZStatusFilterOptions + type: object + properties: + GeoLocation: + type: boolean + description: True if the device is able to stream the Geo Located positions of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + MaxContentFilterSize: + type: integer + description: A device signalling support for content filtering shall support expressions with the provided expression size. + format: int32 + xml: + name: MaxContentFilterSize + prefix: tt + attribute: true + wrapped: false + PTZStatusFilterOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptions' + - xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension: + title: tt_MetadataConfigurationOptionsExtension + type: object + properties: + CompressionType: + type: array + items: + type: string + xml: + name: CompressionType + attribute: false + wrapped: false + description: List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension2: + title: tt_MetadataConfigurationOptionsExtension2 + type: object + description: '' + xml: + name: MetadataConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataCompressionType: + title: tt_MetadataCompressionType + enum: + - None + - GZIP + - EXI + type: string + description: '' + xml: + name: MetadataCompressionType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptions: + title: tt_PTZStatusFilterOptions + required: + - PanTiltStatusSupported + - ZoomStatusSupported + type: object + properties: + PanTiltStatusSupported: + type: boolean + description: True if the device is able to stream pan or tilt status information. + xml: + name: PanTiltStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomStatusSupported: + type: boolean + description: True if the device is able to stream zoom status inforamtion. + xml: + name: ZoomStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSupported: + type: boolean + description: True if the device is able to stream the pan or tilt position. + xml: + name: PanTiltPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSupported: + type: boolean + description: True if the device is able to stream zoom position information. + xml: + name: ZoomPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptionsExtension: + title: tt_PTZStatusFilterOptionsExtension + type: object + description: '' + xml: + name: PTZStatusFilterOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutput: + title: tt_VideoOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Layout + type: object + properties: + Layout: + allOf: + - $ref: '#/components/schemas/tt_Layout' + - xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Resolution of the display in Pixel. + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RefreshRate: + type: number + description: Refresh rate of the display in Hertz. + xml: + name: RefreshRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AspectRatio: + type: number + description: Aspect ratio of the display as physical extent of width divided by height. + xml: + name: AspectRatio + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoOutputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video outputs. + tt_VideoOutputExtension: + title: tt_VideoOutputExtension + type: object + description: '' + xml: + name: VideoOutputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutputConfiguration: + title: tt_VideoOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the Video Output the configuration applies to + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoOutputConfigurationOptions: + title: tt_VideoOutputConfigurationOptions + type: object + description: '' + xml: + name: VideoOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptions: + title: tt_VideoDecoderConfigurationOptions + type: object + properties: + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/tt_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element describes the supported codecs and configurations + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264DecOptions: + allOf: + - $ref: '#/components/schemas/tt_H264DecOptions' + - description: If the device is able to decode H.264 streams this element describes the supported codecs and configurations + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264DecOptions: + title: tt_H264DecOptions + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported H.264 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedH264Profiles: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H264 Profiles (either baseline, main, extended or high) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegDecOptions: + title: tt_JpegDecOptions + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Jpeg Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4DecOptions: + title: tt_Mpeg4DecOptions + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Mpeg4 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedMpeg4Profiles: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported Mpeg4 Profiles (either SP or ASP) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptionsExtension: + title: tt_VideoDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: VideoDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioOutput: + title: tt_AudioOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + xml: + name: AudioOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio outputs. + tt_AudioOutputConfigurationOptions: + title: tt_AudioOutputConfigurationOptions + required: + - OutputTokensAvailable + - OutputLevelRange + type: object + properties: + OutputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: OutputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the physical Audio outputs (typically one). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacyOptions: + type: array + items: + type: string + xml: + name: SendPrimacyOptions + attribute: false + wrapped: false + description: An + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Minimum and maximum level range supported for this Output. + xml: + name: OutputLevelRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptions: + title: tt_AudioDecoderConfigurationOptions + type: object + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/tt_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section describes the supported configurations + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G711DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section describes the supported configurations + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G726DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section describes the supported configurations + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G711DecOptions: + title: tt_G711DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AACDecOptions: + title: tt_AACDecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G726DecOptions: + title: tt_G726DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptionsExtension: + title: tt_AudioDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: AudioDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MulticastConfiguration: + title: tt_MulticastConfiguration + required: + - Address + - Port + - TTL + - AutoStart + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/tt_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast streaming is enaled) + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: integer + description: The RTP mutlicast 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. + format: int32 + xml: + name: Port + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: integer + 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. + format: int32 + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Read only property signalling that streaming is persistant. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MulticastConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamSetup: + title: tt_StreamSetup + required: + - Stream + - Transport + type: object + properties: + Stream: + allOf: + - $ref: '#/components/schemas/tt_StreamType' + - description: Defines if a multicast or unicast stream is requested + xml: + name: Stream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transport: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamType: + title: tt_StreamType + enum: + - RTP-Unicast + - RTP-Multicast + type: string + description: '' + xml: + name: StreamType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transport: + title: tt_Transport + required: + - Protocol + type: object + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/tt_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + xml: + name: Protocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tunnel: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - description: Optional element to describe further tunnel options. This element is normally not needed + xml: + name: Tunnel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransportProtocol: + title: tt_TransportProtocol + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + description: '' + xml: + name: TransportProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaUri: + title: tt_MediaUri + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting the media stream + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterConnect: + type: boolean + description: Indicates if the Uri is only valid until the connection is established. The value shall be set to "false". + xml: + name: InvalidAfterConnect + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterReboot: + type: boolean + description: Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false". + xml: + name: InvalidAfterReboot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Timeout: + type: string + 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 + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ScopeDefinition: + title: tt_ScopeDefinition + enum: + - Fixed + - Configurable + type: string + description: '' + xml: + name: ScopeDefinition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Scope: + title: tt_Scope + required: + - ScopeDef + - ScopeItem + type: object + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/tt_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + xml: + name: ScopeDef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScopeItem: + type: string + description: Scope item URI. + xml: + name: ScopeItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Scope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DiscoveryMode: + title: tt_DiscoveryMode + enum: + - Discoverable + - NonDiscoverable + type: string + description: '' + xml: + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterface: + title: tt_NetworkInterface + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Info: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceInfo' + - description: Network interface information + xml: + name: Info + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceLink' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_NetworkInterfaceExtension: + title: tt_NetworkInterfaceExtension + required: + - InterfaceType + type: object + properties: + InterfaceType: + type: integer + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: Extension point prepared for future 802.3 configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot3Configuration: + title: tt_Dot3Configuration + type: object + description: '' + xml: + name: Dot3Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceExtension2: + title: tt_NetworkInterfaceExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceLink: + title: tt_NetworkInterfaceLink + required: + - AdminSettings + - OperSettings + - InterfaceType + type: object + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + xml: + name: AdminSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OperSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + xml: + name: OperSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InterfaceType: + type: integer + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceLink + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceConnectionSetting: + title: tt_NetworkInterfaceConnectionSetting + required: + - AutoNegotiation + - Speed + - Duplex + type: object + properties: + AutoNegotiation: + type: boolean + description: Auto negotiation on/off. + xml: + name: AutoNegotiation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: integer + description: Speed. + format: int32 + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Duplex: + allOf: + - $ref: '#/components/schemas/tt_Duplex' + - description: Duplex type, Half or Full. + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceConnectionSetting + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Duplex: + title: tt_Duplex + enum: + - Full + - Half + type: string + description: '' + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceInfo: + title: tt_NetworkInterfaceInfo + required: + - HwAddress + type: object + properties: + Name: + type: string + description: Network interface name, for example eth0. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HwAddress: + type: string + description: Network interface MAC address. + xml: + name: HwAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterface: + title: tt_IPv6NetworkInterface + required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv6Configuration' + - description: IPv6 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterface: + title: tt_IPv4NetworkInterface + required: + - Enabled + - Config + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv4Configuration' + - description: IPv4 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4Configuration: + title: tt_IPv4Configuration + required: + - DHCP + type: object + properties: + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: Link local address. + xml: + name: LinkLocal + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6Configuration: + title: tt_IPv6Configuration + required: + - DHCP + type: object + properties: + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually entered IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of link local IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromRA: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using router advertisment. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPv6ConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6ConfigurationExtension: + title: tt_IPv6ConfigurationExtension + type: object + description: '' + xml: + name: IPv6ConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6DHCPConfiguration: + title: tt_IPv6DHCPConfiguration + enum: + - Auto + - Stateful + - Stateless + - Off + type: string + description: '' + xml: + name: IPv6DHCPConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocol: + title: tt_NetworkProtocol + required: + - Name + - Enabled + - Port + type: object + properties: + Name: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolType' + - description: Network protocol type string. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates if the protocol is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: array + items: + type: integer + format: int32 + xml: + name: Port + attribute: false + wrapped: false + description: The port that is used by the protocol. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolExtension: + title: tt_NetworkProtocolExtension + type: object + description: '' + xml: + name: NetworkProtocolExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolType: + title: tt_NetworkProtocolType + enum: + - HTTP + - HTTPS + - RTSP + type: string + description: '' + xml: + name: NetworkProtocolType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostType: + title: tt_NetworkHostType + enum: + - IPv4 + - IPv6 + - DNS + type: string + description: '' + xml: + name: NetworkHostType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHost: + title: tt_NetworkHost + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address. + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSname: + type: string + description: DNS name. + xml: + name: DNSname + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkHost + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostExtension: + title: tt_NetworkHostExtension + type: object + description: '' + xml: + name: NetworkHostExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddress: + title: tt_IPAddress + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv4Address: + title: tt_PrefixedIPv4Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv4 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv6Address: + title: tt_PrefixedIPv6Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv6 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPType: + title: tt_IPType + enum: + - IPv4 + - IPv6 + type: string + description: '' + xml: + name: IPType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformation: + title: tt_HostnameInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether the hostname is obtained from DHCP or not. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: Indicates the hostname. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: HostnameInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformationExtension: + title: tt_HostnameInformationExtension + type: object + description: '' + xml: + name: HostnameInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformation: + title: tt_DNSInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether or not DNS information is retrieved from DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SearchDomain: + type: array + items: + type: string + xml: + name: SearchDomain + attribute: false + wrapped: false + description: Search domain. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of DNS addresses received from DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSManual: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of manually entered DNS addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformationExtension: + title: tt_DNSInformationExtension + type: object + description: '' + xml: + name: DNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformation: + title: tt_NTPInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates if NTP information is to be retrieved by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of NTP addresses retrieved by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPManual: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of manually entered NTP addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NTPInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NTPInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformationExtension: + title: tt_NTPInformationExtension + type: object + description: '' + xml: + name: NTPInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterType: + title: tt_IPAddressFilterType + enum: + - Allow + - Deny + type: string + description: '' + xml: + name: IPAddressFilterType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformation: + title: tt_DynamicDNSInformation + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: DNS name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: string + description: Time to live. + format: date-time + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformationExtension: + title: tt_DynamicDNSInformationExtension + type: object + description: '' + xml: + name: DynamicDNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSType: + title: tt_DynamicDNSType + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + type: string + description: '' + xml: + name: DynamicDNSType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfiguration: + title: tt_NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension: + title: tt_NetworkInterfaceSetConfigurationExtension + type: object + properties: + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterfaceSetConfiguration: + title: tt_IPv6NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually added IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterfaceSetConfiguration: + title: tt_IPv4NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkGateway: + title: tt_NetworkGateway + type: object + properties: + IPv4Address: + type: array + items: + type: string + xml: + name: IPv4Address + attribute: false + wrapped: false + description: IPv4 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + type: string + xml: + name: IPv6Address + attribute: false + wrapped: false + description: IPv6 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkGateway + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfiguration: + title: tt_NetworkZeroConfiguration + required: + - InterfaceToken + - Enabled + type: object + properties: + InterfaceToken: + maxLength: 64 + type: string + description: Unique identifier of network interface. + xml: + name: InterfaceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates whether the zero-configuration is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Addresses: + type: array + items: + type: string + xml: + name: Addresses + attribute: false + wrapped: false + description: The zero-configuration IPv4 address(es) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension: + title: tt_NetworkZeroConfigurationExtension + type: object + properties: + Additional: + type: array + items: + $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + description: Optional array holding the configuration for the second and possibly further interfaces. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension2: + title: tt_NetworkZeroConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkZeroConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilter: + title: tt_IPAddressFilter + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterExtension: + title: tt_IPAddressFilterExtension + type: object + description: '' + xml: + name: IPAddressFilterExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Configuration: + title: tt_Dot11Configuration + required: + - SSID + - Mode + - Alias + - Priority + - Security + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11StationMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Alias: + maxLength: 64 + type: string + xml: + name: Alias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + maximum: 31 + minimum: 0 + type: integer + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfiguration' + - xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11StationMode: + title: tt_Dot11StationMode + enum: + - Ad-hoc + - Infrastructure + - Extended + type: string + description: '' + xml: + name: Dot11StationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfiguration: + title: tt_Dot11SecurityConfiguration + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Algorithm: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: Algorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PSK: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSet' + - xml: + name: PSK + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot1X: + maxLength: 64 + type: string + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11SecurityConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfigurationExtension: + title: tt_Dot11SecurityConfigurationExtension + type: object + description: '' + xml: + name: Dot11SecurityConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityMode: + title: tt_Dot11SecurityMode + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + type: string + description: '' + xml: + name: Dot11SecurityMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Cipher: + title: tt_Dot11Cipher + enum: + - CCMP + - TKIP + - Any + - Extended + type: string + description: '' + xml: + name: Dot11Cipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSet: + title: tt_Dot11PSKSet + type: object + properties: + Key: + type: string + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex + format: binary + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Passphrase: + pattern: '[ -~]{8,63}' + type: string + description: >- + According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and + each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. + xml: + name: Passphrase + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSetExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11PSKSet + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSetExtension: + title: tt_Dot11PSKSetExtension + type: object + description: '' + xml: + name: Dot11PSKSetExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension2: + title: tt_NetworkInterfaceSetConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Capabilities: + title: tt_Dot11Capabilities + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + type: object + properties: + TKIP: + type: boolean + xml: + name: TKIP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScanAvailableNetworks: + type: boolean + xml: + name: ScanAvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MultipleConfiguration: + type: boolean + xml: + name: MultipleConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AdHocStationMode: + type: boolean + xml: + name: AdHocStationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WEP: + type: boolean + xml: + name: WEP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SignalStrength: + title: tt_Dot11SignalStrength + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + type: string + description: '' + xml: + name: Dot11SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Status: + title: tt_Dot11Status + required: + - SSID + - ActiveConfigAlias + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: PairCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: GroupCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ActiveConfigAlias: + maxLength: 64 + type: string + xml: + name: ActiveConfigAlias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AuthAndMangementSuite: + title: tt_Dot11AuthAndMangementSuite + enum: + - None + - Dot1X + - PSK + - Extended + type: string + description: '' + xml: + name: Dot11AuthAndMangementSuite + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworks: + title: tt_Dot11AvailableNetworks + required: + - SSID + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuthAndMangementSuite: + type: array + items: + $ref: '#/components/schemas/tt_Dot11AuthAndMangementSuite' + description: See IEEE802.11 7.3.2.25.2 for details. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11AvailableNetworksExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11AvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworksExtension: + title: tt_Dot11AvailableNetworksExtension + type: object + description: '' + xml: + name: Dot11AvailableNetworksExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilityCategory: + title: tt_CapabilityCategory + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + type: string + description: '' + xml: + name: CapabilityCategory + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Capabilities: + title: tt_Capabilities + type: object + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsCapabilities' + - description: Analytics capabilities + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Device: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilities' + - description: Device capabilities + xml: + name: Device + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventCapabilities' + - description: Event capabilities + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingCapabilities' + - description: Imaging capabilities + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Media: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilities' + - description: Media capabilities + xml: + name: Media + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZCapabilities' + - description: PTZ capabilities + xml: + name: PTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension: + title: tt_CapabilitiesExtension + type: object + properties: + DeviceIO: + allOf: + - $ref: '#/components/schemas/tt_DeviceIOCapabilities' + - xml: + name: DeviceIO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Display: + allOf: + - $ref: '#/components/schemas/tt_DisplayCapabilities' + - xml: + name: Display + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Recording: + allOf: + - $ref: '#/components/schemas/tt_RecordingCapabilities' + - xml: + name: Recording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Search: + allOf: + - $ref: '#/components/schemas/tt_SearchCapabilities' + - xml: + name: Search + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Replay: + allOf: + - $ref: '#/components/schemas/tt_ReplayCapabilities' + - xml: + name: Replay + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tt_ReceiverCapabilities' + - xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsDevice: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceCapabilities' + - xml: + name: AnalyticsDevice + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extensions: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension2' + - xml: + name: Extensions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension2: + title: tt_CapabilitiesExtension2 + type: object + description: '' + xml: + name: CapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsCapabilities: + title: tt_AnalyticsCapabilities + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + type: object + properties: + XAddr: + type: string + description: Analytics service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Indicates whether or not rules are supported. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleSupport: + type: boolean + description: Indicates whether or not modules are supported. + xml: + name: AnalyticsModuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilities: + title: tt_DeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Device service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilities' + - description: Network capabilities. + xml: + name: Network + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilities' + - description: System capabilities. + xml: + name: System + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IO: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilities' + - description: I/O capabilities. + xml: + name: IO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilities' + - description: Security capabilities. + xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilitiesExtension: + title: tt_DeviceCapabilitiesExtension + type: object + description: '' + xml: + name: DeviceCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventCapabilities: + title: tt_EventCapabilities + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + type: object + properties: + XAddr: + type: string + description: Event service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSSubscriptionPolicySupport: + type: boolean + description: Indicates whether or not WS Subscription policy is supported. + xml: + name: WSSubscriptionPolicySupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPullPointSupport: + type: boolean + description: Indicates whether or not WS Pull Point is supported. + xml: + name: WSPullPointSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPausableSubscriptionManagerInterfaceSupport: + type: boolean + description: Indicates whether or not WS Pausable Subscription Manager Interface is supported. + xml: + name: WSPausableSubscriptionManagerInterfaceSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EventCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilities: + title: tt_IOCapabilities + type: object + properties: + InputConnectors: + type: integer + description: Number of input connectors. + format: int32 + xml: + name: InputConnectors + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + description: Number of relay outputs. + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension: + title: tt_IOCapabilitiesExtension + required: + - Extension + type: object + properties: + Auxiliary: + type: boolean + xml: + name: Auxiliary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension2: + title: tt_IOCapabilitiesExtension2 + type: object + description: '' + xml: + name: IOCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilities: + title: tt_MediaCapabilities + required: + - XAddr + - StreamingCapabilities + type: object + properties: + XAddr: + type: string + description: Media service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilitiesExtension: + title: tt_MediaCapabilitiesExtension + required: + - ProfileCapabilities + type: object + properties: + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tt_ProfileCapabilities' + - xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilities: + title: tt_RealTimeStreamingCapabilities + type: object + properties: + RTPMulticast: + type: boolean + description: Indicates whether or not RTP multicast is supported. + xml: + name: RTPMulticast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether or not RTP over TCP is supported. + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether or not RTP/RTSP/TCP is supported. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RealTimeStreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilitiesExtension: + title: tt_RealTimeStreamingCapabilitiesExtension + type: object + description: '' + xml: + name: RealTimeStreamingCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileCapabilities: + title: tt_ProfileCapabilities + required: + - MaximumNumberOfProfiles + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilities: + title: tt_NetworkCapabilities + type: object + properties: + IPFilter: + type: boolean + description: Indicates whether or not IP filtering is supported. + xml: + name: IPFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZeroConfiguration: + type: boolean + description: Indicates whether or not zeroconf is supported. + xml: + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPVersion6: + type: boolean + description: Indicates whether or not IPv6 is supported. + xml: + name: IPVersion6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynDNS: + type: boolean + description: Indicates whether or not is supported. + xml: + name: DynDNS + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension: + title: tt_NetworkCapabilitiesExtension + type: object + properties: + Dot11Configuration: + type: boolean + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension2: + title: tt_NetworkCapabilitiesExtension2 + type: object + description: '' + xml: + name: NetworkCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilities: + title: tt_SecurityCapabilities + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + type: object + properties: + TLS1.1: + type: boolean + description: Indicates whether or not TLS 1.1 is supported. + xml: + name: TLS1.1 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TLS1.2: + type: boolean + description: Indicates whether or not TLS 1.2 is supported. + xml: + name: TLS1.2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OnboardKeyGeneration: + type: boolean + description: Indicates whether or not onboard key generation is supported. + xml: + name: OnboardKeyGeneration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AccessPolicyConfig: + type: boolean + description: Indicates whether or not access policy configuration is supported. + xml: + name: AccessPolicyConfig + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + X.509Token: + type: boolean + description: Indicates whether or not WS-Security X.509 token is supported. + xml: + name: X.509Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SAMLToken: + type: boolean + description: Indicates whether or not WS-Security SAML token is supported. + xml: + name: SAMLToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KerberosToken: + type: boolean + description: Indicates whether or not WS-Security Kerberos token is supported. + xml: + name: KerberosToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RELToken: + type: boolean + description: Indicates whether or not WS-Security REL token is supported. + xml: + name: RELToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension: + title: tt_SecurityCapabilitiesExtension + required: + - TLS1.0 + type: object + properties: + TLS1.0: + type: boolean + xml: + name: TLS1.0 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension2: + title: tt_SecurityCapabilitiesExtension2 + required: + - Dot1X + - RemoteUserHandling + type: object + properties: + Dot1X: + type: boolean + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedEAPMethod: + type: array + items: + type: integer + format: int32 + xml: + name: SupportedEAPMethod + attribute: false + wrapped: false + description: EAP Methods supported by the device. The int values refer to the + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteUserHandling: + type: boolean + xml: + name: RemoteUserHandling + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilities: + title: tt_SystemCapabilities + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + type: object + properties: + DiscoveryResolve: + type: boolean + description: Indicates whether or not WS Discovery resolve requests are supported. + xml: + name: DiscoveryResolve + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DiscoveryBye: + type: boolean + description: Indicates whether or not WS-Discovery Bye is supported. + xml: + name: DiscoveryBye + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteDiscovery: + type: boolean + description: Indicates whether or not remote discovery is supported. + xml: + name: RemoteDiscovery + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemBackup: + type: boolean + description: Indicates whether or not system backup is supported. + xml: + name: SystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemLogging: + type: boolean + description: Indicates whether or not system logging is supported. + xml: + name: SystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FirmwareUpgrade: + type: boolean + description: Indicates whether or not firmware upgrade is supported. + xml: + name: FirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedVersions: + type: array + items: + $ref: '#/components/schemas/tt_OnvifVersion' + description: Indicates supported ONVIF version(s). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension: + title: tt_SystemCapabilitiesExtension + type: object + properties: + HttpFirmwareUpgrade: + type: boolean + xml: + name: HttpFirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemBackup: + type: boolean + xml: + name: HttpSystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemLogging: + type: boolean + xml: + name: HttpSystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSupportInformation: + type: boolean + xml: + name: HttpSupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension2: + title: tt_SystemCapabilitiesExtension2 + type: object + description: '' + xml: + name: SystemCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OnvifVersion: + title: tt_OnvifVersion + required: + - Major + - Minor + type: object + properties: + Major: + type: integer + description: Major version number. + format: int32 + xml: + name: Major + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minor: + type: integer + description: >- + Two digit minor version number. + If 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. + Otherwise, minor number is month of release, such as "06" for June. + format: int32 + xml: + name: Minor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OnvifVersion + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingCapabilities: + title: tt_ImagingCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Imaging service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZCapabilities: + title: tt_PTZCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: PTZ service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceIOCapabilities: + title: tt_DeviceIOCapabilities + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSources: + type: integer + format: int32 + xml: + name: VideoSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoOutputs: + type: integer + format: int32 + xml: + name: VideoOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSources: + type: integer + format: int32 + xml: + name: AudioSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputs: + type: integer + format: int32 + xml: + name: AudioOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceIOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DisplayCapabilities: + title: tt_DisplayCapabilities + required: + - XAddr + - FixedLayout + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedLayout: + type: boolean + description: Indication that the SetLayout command supports only predefined layouts. + xml: + name: FixedLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DisplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingCapabilities: + title: tt_RecordingCapabilities + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverSource: + type: boolean + xml: + name: ReceiverSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaProfileSource: + type: boolean + xml: + name: MediaProfileSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicRecordings: + type: boolean + xml: + name: DynamicRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicTracks: + type: boolean + xml: + name: DynamicTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxStringLength: + type: integer + format: int32 + xml: + name: MaxStringLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchCapabilities: + title: tt_SearchCapabilities + required: + - XAddr + - MetadataSearch + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataSearch: + type: boolean + xml: + name: MetadataSearch + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SearchCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayCapabilities: + title: tt_ReplayCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: The address of the replay service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverCapabilities: + title: tt_ReceiverCapabilities + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + type: object + properties: + XAddr: + type: string + description: The address of the receiver service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_Multicast: + type: boolean + description: Indicates whether the device can receive RTP multicast streams. + xml: + name: RTP_Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/TCP streams + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedReceivers: + type: integer + description: The maximum number of receivers supported by the device. + format: int32 + xml: + name: SupportedReceivers + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRTSPURILength: + type: integer + description: The maximum allowed length for RTSP URIs. + format: int32 + xml: + name: MaximumRTSPURILength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReceiverCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceCapabilities: + title: tt_AnalyticsDeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Obsolete property. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceExtension: + title: tt_AnalyticsDeviceExtension + type: object + description: '' + xml: + name: AnalyticsDeviceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogType: + title: tt_SystemLogType + enum: + - System + - Access + type: string + description: Enumeration describing the available system log modes. + xml: + name: SystemLogType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLog: + title: tt_SystemLog + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The log information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The log information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLog + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportInformation: + title: tt_SupportInformation + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The support information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The support information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BinaryData: + title: tt_BinaryData + required: + - Data + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Data: + type: string + description: base64 encoded binary data. + format: binary + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BinaryData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AttachmentData: + title: tt_AttachmentData + required: + - Include + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Include: + allOf: + - $ref: '#/components/schemas/xop_Include' + - xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + description: '' + xml: + name: AttachmentData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BackupFile: + title: tt_BackupFile + required: + - Name + - Data + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BackupFile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUriList: + title: tt_SystemLogUriList + type: object + properties: + SystemLog: + type: array + items: + $ref: '#/components/schemas/tt_SystemLogUri' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUriList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUri: + title: tt_SystemLogUri + required: + - Type + - Uri + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Uri: + type: string + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FactoryDefaultType: + title: tt_FactoryDefaultType + enum: + - Hard + - Soft + type: string + description: Enumeration describing the available factory default modes. + xml: + name: FactoryDefaultType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SetDateTimeType: + title: tt_SetDateTimeType + enum: + - Manual + - NTP + type: string + description: '' + xml: + name: SetDateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTime: + title: tt_SystemDateTime + required: + - DateTimeType + - DaylightSavings + type: object + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + xml: + name: DateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DaylightSavings: + type: boolean + description: Informative indicator whether daylight savings is currently on/off. + xml: + name: DaylightSavings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: Timezone information in Posix format. + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Current system date and time in UTC format. This field is mandatory since version 2.0. + xml: + name: UTCDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in local format. + xml: + name: LocalDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTimeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: General date time inforamtion returned by the GetSystemDateTime method. + xml: + name: SystemDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTimeExtension: + title: tt_SystemDateTimeExtension + type: object + description: '' + xml: + name: SystemDateTimeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTime: + title: tt_DateTime + required: + - Time + - Date + type: object + properties: + Time: + allOf: + - $ref: '#/components/schemas/tt_Time' + - xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Date: + allOf: + - $ref: '#/components/schemas/tt_Date' + - xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Date: + title: tt_Date + required: + - Year + - Month + - Day + type: object + properties: + Year: + type: integer + format: int32 + xml: + name: Year + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Month: + type: integer + description: Range is 1 to 12. + format: int32 + xml: + name: Month + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Day: + type: integer + description: Range is 1 to 31. + format: int32 + xml: + name: Day + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Time: + title: tt_Time + required: + - Hour + - Minute + - Second + type: object + properties: + Hour: + type: integer + description: Range is 0 to 23. + format: int32 + xml: + name: Hour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minute: + type: integer + description: Range is 0 to 59. + format: int32 + xml: + name: Minute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Second: + type: integer + description: Range is 0 to 61 (typically 59). + format: int32 + xml: + name: Second + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TimeZone: + title: tt_TimeZone + required: + - TZ + type: object + properties: + TZ: + type: string + description: Posix timezone string. + xml: + name: TZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3 + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RemoteUser: + title: tt_RemoteUser + required: + - Username + - UseDerivedPassword + type: object + properties: + Username: + type: string + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseDerivedPassword: + type: boolean + xml: + name: UseDerivedPassword + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RemoteUser + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserLevel: + title: tt_UserLevel + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + description: '' + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_User: + title: tt_User + required: + - Username + - UserLevel + type: object + properties: + Username: + type: string + description: Username string. + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password string. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UserLevel: + allOf: + - $ref: '#/components/schemas/tt_UserLevel' + - description: User level string. + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_UserExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: User + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserExtension: + title: tt_UserExtension + type: object + description: '' + xml: + name: UserExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParameters: + title: tt_CertificateGenerationParameters + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subject: + type: string + xml: + name: Subject + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotBefore: + type: string + xml: + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotAfter: + type: string + xml: + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateGenerationParametersExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateGenerationParameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParametersExtension: + title: tt_CertificateGenerationParametersExtension + type: object + description: '' + xml: + name: CertificateGenerationParametersExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Certificate: + title: tt_Certificate + required: + - CertificateID + - Certificate + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateStatus: + title: tt_CertificateStatus + required: + - CertificateID + - Status + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + type: boolean + description: Indicates whether or not a certificate is used in a HTTPS configuration. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateWithPrivateKey: + title: tt_CertificateWithPrivateKey + required: + - Certificate + - PrivateKey + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrivateKey: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: PrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformation: + title: tt_CertificateInformation + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IssuerDN: + type: string + xml: + name: IssuerDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubjectDN: + type: string + xml: + name: SubjectDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: KeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExtendedKeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: ExtendedKeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyLength: + type: integer + format: int32 + xml: + name: KeyLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Version: + type: string + xml: + name: Version + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SerialNum: + type: string + xml: + name: SerialNum + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignatureAlgorithm: + type: string + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding DateTimeRange is from "From" to "Until" + xml: + name: SignatureAlgorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Validity: + allOf: + - $ref: '#/components/schemas/tt_DateTimeRange' + - xml: + name: Validity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateUsage: + title: tt_CertificateUsage + required: + - Critical + type: object + properties: + Critical: + type: boolean + xml: + name: Critical + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: CertificateUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformationExtension: + title: tt_CertificateInformationExtension + type: object + description: '' + xml: + name: CertificateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfiguration: + title: tt_Dot1XConfiguration + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + type: object + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Identity: + type: string + xml: + name: Identity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnonymousID: + type: string + xml: + name: AnonymousID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethod: + type: integer + description: EAP Method type as defined in + format: int32 + xml: + name: EAPMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CACertificateID: + type: array + items: + type: string + xml: + name: CACertificateID + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethodConfiguration: + allOf: + - $ref: '#/components/schemas/tt_EAPMethodConfiguration' + - xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfigurationExtension: + title: tt_Dot1XConfigurationExtension + type: object + description: '' + xml: + name: Dot1XConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EAPMethodConfiguration: + title: tt_EAPMethodConfiguration + type: object + properties: + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/tt_TLSConfiguration' + - description: Confgiuration information for TLS Method. + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password for those EAP Methods that require a password. The password shall never be returned on a get method. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EapMethodExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EapMethodExtension: + title: tt_EapMethodExtension + type: object + description: '' + xml: + name: EapMethodExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TLSConfiguration: + title: tt_TLSConfiguration + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GenericEapPwdConfigurationExtension: + title: tt_GenericEapPwdConfigurationExtension + type: object + description: '' + xml: + name: GenericEapPwdConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayLogicalState: + title: tt_RelayLogicalState + enum: + - active + - inactive + type: string + description: '' + xml: + name: RelayLogicalState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayIdleState: + title: tt_RelayIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: RelayIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutputSettings: + title: tt_RelayOutputSettings + required: + - Mode + - DelayTime + - IdleState + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RelayMode' + - description: "'Bistable' or 'Monostable'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DelayTime: + type: string + 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. + format: date-time + xml: + name: DelayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IdleState: + allOf: + - $ref: '#/components/schemas/tt_RelayIdleState' + - description: "'open' or 'closed'" + xml: + name: IdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelayOutputSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayMode: + title: tt_RelayMode + enum: + - Monostable + - Bistable + type: string + description: '' + xml: + name: RelayMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutput: + title: tt_RelayOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Properties + type: object + properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + name: Properties + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: RelayOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_DigitalIdleState: + title: tt_DigitalIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: DigitalIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DigitalInput: + title: tt_DigitalInput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + properties: + IdleState: + allOf: + - $ref: '#/components/schemas/tt_DigitalIdleState' + - description: Indicate the Digital IdleState status. + xml: + name: IdleState + prefix: tt + attribute: true + wrapped: false + xml: + name: DigitalInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNode: + title: tt_PTZNode + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + properties: + Name: + maxLength: 64 + type: string + description: A unique identifier that is used to reference PTZ Nodes. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range. + xml: + name: SupportedPTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumNumberOfPresets: + type: integer + description: All preset operations MUST be available for this PTZ Node if one preset is supported. + format: int32 + xml: + name: MaximumNumberOfPresets + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HomeSupported: + type: boolean + 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. + xml: + name: HomeSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedHomePosition: + type: boolean + description: Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command. + xml: + name: FixedHomePosition + prefix: tt + attribute: true + wrapped: false + GeoMove: + type: boolean + description: Indication whether the Node supports the geo-referenced move command. + xml: + name: GeoMove + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZNode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNodeExtension: + title: tt_PTZNodeExtension + type: object + properties: + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + xml: + name: SupportedPresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZNodeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZNodeExtension2: + title: tt_PTZNodeExtension2 + type: object + description: '' + xml: + name: PTZNodeExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupported: + title: tt_PTZPresetTourSupported + required: + - MaximumNumberOfPresetTours + type: object + properties: + MaximumNumberOfPresetTours: + type: integer + 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. + format: int32 + xml: + name: MaximumNumberOfPresetTours + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPresetTourOperation: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourOperation' + description: Indicates which preset tour operations are available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupportedExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupportedExtension: + title: tt_PTZPresetTourSupportedExtension + type: object + description: '' + xml: + name: PTZPresetTourSupportedExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension: + title: tt_PTZConfigurationExtension + type: object + properties: + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirection' + - description: Optional element to configure PT Control Direction related features. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension2: + title: tt_PTZConfigurationExtension2 + type: object + description: '' + xml: + name: PTZConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirection: + title: tt_PTControlDirection + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlip' + - description: Optional element to configure related parameters for E-Flip. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_Reverse' + - description: Optional element to configure related parameters for reversing of PT Control Direction. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionExtension: + title: tt_PTControlDirectionExtension + type: object + description: '' + xml: + name: PTControlDirectionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlip: + title: tt_EFlip + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Reverse: + title: tt_Reverse + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipMode: + title: tt_EFlipMode + enum: + - OFF + - ON + - Extended + type: string + description: '' + xml: + name: EFlipMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseMode: + title: tt_ReverseMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ReverseMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions: + title: tt_PTZConfigurationOptions + required: + - Spaces + - PTZTimeout + type: object + properties: + PTZRamps: + type: integer + description: >- + The list of acceleration ramps supported by the device. The + smallest acceleration value corresponds to the minimal index, the + highest acceleration corresponds to the maximum index. + format: int32 + xml: + name: PTZRamps + prefix: tt + attribute: true + wrapped: false + Spaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of supported coordinate systems including their range limitations. + xml: + name: Spaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZTimeout: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the PTZ Node. + xml: + name: PTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions2: + title: tt_PTZConfigurationOptions2 + type: object + description: '' + xml: + name: PTZConfigurationOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptions: + title: tt_PTControlDirectionOptions + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptions' + - description: Supported options for EFlip feature. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptions' + - description: Supported options for Reverse feature. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirectionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptionsExtension: + title: tt_PTControlDirectionOptionsExtension + type: object + description: '' + xml: + name: PTControlDirectionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptions: + title: tt_EFlipOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_EFlipMode' + description: Options of EFlip mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlipOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptionsExtension: + title: tt_EFlipOptionsExtension + type: object + description: '' + xml: + name: EFlipOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptions: + title: tt_ReverseOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ReverseMode' + description: Options of Reverse mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReverseOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptionsExtension: + title: tt_ReverseOptionsExtension + type: object + description: '' + xml: + name: ReverseOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PanTiltLimits: + title: tt_PanTiltLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: A range of pan tilt limits. + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ZoomLimits: + title: tt_ZoomLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: A range of zoom limit + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpaces: + title: tt_PTZSpaces + type: object + properties: + AbsolutePanTiltPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AbsoluteZoomPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). \n There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePanTiltTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativeZoomTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, 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 where 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 There 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousPanTiltVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 rotation 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousZoomVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt \n movement is represented by a single non-negative scalar value." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZSpacesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpacesExtension: + title: tt_PTZSpacesExtension + type: object + description: '' + xml: + name: PTZSpacesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space2DDescription: + title: tt_Space2DDescription + required: + - URI + - XRange + - YRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space2DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space1DDescription: + title: tt_Space1DDescription + required: + - URI + - XRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space1DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpeed: + title: tt_PTZSpeed + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - 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. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPreset: + title: tt_PTZPreset + type: object + properties: + token: + maxLength: 64 + type: string + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: A list of preset position name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A list of preset position. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPreset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourState: + title: tt_PTZPresetTourState + enum: + - Idle + - Touring + - Paused + - Extended + type: string + description: '' + xml: + name: PTZPresetTourState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourDirection: + title: tt_PTZPresetTourDirection + enum: + - Forward + - Backward + - Extended + type: string + description: '' + xml: + name: PTZPresetTourDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOperation: + title: tt_PTZPresetTourOperation + enum: + - Start + - Stop + - Pause + - Extended + type: string + description: '' + xml: + name: PTZPresetTourOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PresetTour: + title: tt_PresetTour + required: + - Status + - AutoStart + - StartingCondition + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of this preset tour. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: Readable name of the preset tour. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset tour. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Auto Start flag of the preset tour. True allows the preset tour to be activated always. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourSpot' + description: A list of detail of touring spots including preset positions. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourExtension: + title: tt_PTZPresetTourExtension + type: object + description: '' + xml: + name: PTZPresetTourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpot: + title: tt_PTZPresetTourSpot + required: + - PresetDetail + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + type: string + description: Optional parameter to specify time duration of staying on this tour sport. + format: date-time + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotExtension: + title: tt_PTZPresetTourSpotExtension + type: object + description: '' + xml: + name: PTZPresetTourSpotExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetail: + title: tt_PTZPresetTourPresetDetail + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourTypeExtension: + title: tt_PTZPresetTourTypeExtension + type: object + description: '' + xml: + name: PTZPresetTourTypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatus: + title: tt_PTZPresetTourStatus + required: + - State + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + xml: + name: CurrentTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatusExtension: + title: tt_PTZPresetTourStatusExtension + type: object + description: '' + xml: + name: PTZPresetTourStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingCondition: + title: tt_PTZPresetTourStartingCondition + type: object + properties: + RandomPresetOrder: + type: 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. + xml: + name: RandomPresetOrder + prefix: tt + attribute: true + wrapped: false + RecurringTime: + type: integer + description: Optional parameter to specify how many times the preset tour is recurred. + format: int32 + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + type: string + description: Optional parameter to specify how long time duration the preset tour is recurred. + format: date-time + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted. + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionExtension: + title: tt_PTZPresetTourStartingConditionExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOptions: + title: tt_PTZPresetTourOptions + required: + - AutoStart + - StartingCondition + - TourSpot + type: object + properties: + AutoStart: + type: boolean + description: Indicates whether or not the AutoStart is supported. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + xml: + name: TourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotOptions: + title: tt_PTZPresetTourSpotOptions + required: + - PresetDetail + - StayTime + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of stay time for a tour spot. + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpotOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptions: + title: tt_PTZPresetTourPresetDetailOptions + type: object + properties: + PresetToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: PresetToken + attribute: false + wrapped: false + description: A list of available Preset Tokens for tour spots. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + description: An option to indicate Home postion for tour spots. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + xml: + name: PanTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + xml: + name: ZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetailOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptionsExtension: + title: tt_PTZPresetTourPresetDetailOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourPresetDetailOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptions: + title: tt_PTZPresetTourStartingConditionOptions + type: object + properties: + RecurringTime: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of Recurring Time. + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of Recurring Duration. + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourDirection' + description: Supported options for Direction of Preset Tour. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingConditionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptionsExtension: + title: tt_PTZPresetTourStartingConditionOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveAndTrackMethod: + title: tt_MoveAndTrackMethod + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + type: string + description: '' + xml: + name: MoveAndTrackMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus: + title: tt_ImagingStatus + required: + - FocusStatus + type: object + properties: + FocusStatus: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus' + - xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus: + title: tt_FocusStatus + required: + - Position + - MoveStatus + - Error + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration: + title: tt_FocusConfiguration + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: >- + Parameter to set autofocus far limit (unit: meter). + + If set to 0.0, infinity will be used. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AutoFocusMode: + title: tt_AutoFocusMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AFModes: + title: tt_AFModes + enum: + - OnceAfterMove + type: string + description: '' + xml: + name: AFModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings: + title: tt_ImagingSettings + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension: + title: tt_ImagingSettingsExtension + type: object + description: '' + xml: + name: ImagingSettingsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure: + title: tt_Exposure + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + description: Minimum value of the iris range allowed to be used by the algorithm. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + description: Maximum value of the iris range allowed to be used by the algorithm. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + description: The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicMode: + title: tt_WideDynamicMode + enum: + - OFF + - ON + type: string + description: '' + xml: + name: WideDynamicMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange: + title: tt_WideDynamicRange + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: White dynamic range (on/off) + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unitless) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationMode: + title: tt_BacklightCompensationMode + enum: + - OFF + - ON + type: string + description: Enumeration describing the available backlight compenstation modes. + xml: + name: BacklightCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation: + title: tt_BacklightCompensation + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposurePriority: + title: tt_ExposurePriority + enum: + - LowNoise + - FrameRate + type: string + description: '' + xml: + name: ExposurePriority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions: + title: tt_ImagingOptions + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions' + - xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions' + - xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions' + - xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions' + - xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions' + - xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions: + title: tt_WideDynamicRangeOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions: + title: tt_BacklightCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions: + title: tt_FocusOptions + required: + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions: + title: tt_ExposureOptions + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions: + title: tt_WhiteBalanceOptions + required: + - Mode + - YrGain + - YbGain + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusMove: + title: tt_FocusMove + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocus' + - description: Parameters for the absolute focus control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocus' + - description: Parameters for the relative focus control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocus' + - description: Parameter for the continuous focus control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusMove + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocus: + title: tt_AbsoluteFocus + required: + - Position + type: object + properties: + Position: + type: number + description: Position parameter for the absolute focus control. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the absolute focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocus: + title: tt_RelativeFocus + required: + - Distance + type: object + properties: + Distance: + type: number + description: Distance parameter for the relative focus control. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the relative focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocus: + title: tt_ContinuousFocus + required: + - Speed + type: object + properties: + Speed: + type: number + description: Speed parameter for the Continuous focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions: + title: tt_MoveOptions + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions' + - xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocusOptions: + title: tt_AbsoluteFocusOptions + required: + - Position + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions: + title: tt_RelativeFocusOptions + required: + - Distance + - Speed + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocusOptions: + title: tt_ContinuousFocusOptions + required: + - Speed + type: object + properties: + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureMode: + title: tt_ExposureMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: ExposureMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Enabled: + title: tt_Enabled + enum: + - ENABLED + - DISABLED + type: string + description: '' + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceMode: + title: tt_WhiteBalanceMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: WhiteBalanceMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterMode: + title: tt_IrCutFilterMode + enum: + - ON + - OFF + - AUTO + type: string + description: '' + xml: + name: IrCutFilterMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance: + title: tt_WhiteBalance + required: + - Mode + - CrGain + - CbGain + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20: + title: tt_ImagingStatus20 + type: object + properties: + FocusStatus20: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20' + - description: Status of focus. + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20Extension: + title: tt_ImagingStatus20Extension + type: object + description: '' + xml: + name: ImagingStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20: + title: tt_FocusStatus20 + required: + - Position + - MoveStatus + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20Extension: + title: tt_FocusStatus20Extension + type: object + description: '' + xml: + name: FocusStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings20: + title: tt_ImagingSettings20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure20' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange20' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension20' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command. + xml: + name: ImagingSettings20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension20: + title: tt_ImagingSettingsExtension20 + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension202' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension202: + title: tt_ImagingSettingsExtension202 + type: object + properties: + IrCutFilterAutoAdjustment: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustment' + description: An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension203' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension202 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension203: + title: tt_ImagingSettingsExtension203 + type: object + properties: + ToneCompensation: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Defogging: + allOf: + - $ref: '#/components/schemas/tt_Defogging' + - description: Optional element to configure Image Defogging. + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReduction: + allOf: + - $ref: '#/components/schemas/tt_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension204' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension203 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension204: + title: tt_ImagingSettingsExtension204 + type: object + description: '' + xml: + name: ImagingSettingsExtension204 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilization: + title: tt_ImageStabilization + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationExtension: + title: tt_ImageStabilizationExtension + type: object + description: '' + xml: + name: ImageStabilizationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationMode: + title: tt_ImageStabilizationMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ImageStabilizationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustment: + title: tt_IrCutFilterAutoAdjustment + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: string + description: Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + name: BoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: number + 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). + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTime: + type: string + description: Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels. + format: date-time + xml: + name: ResponseTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentExtension: + title: tt_IrCutFilterAutoAdjustmentExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoBoundaryType: + title: tt_IrCutFilterAutoBoundaryType + enum: + - Common + - ToOn + - ToOff + - Extended + type: string + description: '' + xml: + name: IrCutFilterAutoBoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange20: + title: tt_WideDynamicRange20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether WDR mode is enabled or disabled (on/off). + xml: + name: WideDynamicRange20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation20: + title: tt_BacklightCompensation20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether BLC mode is enabled or disabled (on/off). + xml: + name: BacklightCompensation20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure20: + title: tt_Exposure20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + 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. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + 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. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + 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. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the exposure settings. + xml: + name: Exposure20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensation: + title: tt_ToneCompensation + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationExtension: + title: tt_ToneCompensationExtension + type: object + description: '' + xml: + name: ToneCompensationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationMode: + title: tt_ToneCompensationMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: ToneCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Defogging: + title: tt_Defogging + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DefoggingExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingExtension: + title: tt_DefoggingExtension + type: object + description: '' + xml: + name: DefoggingExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingMode: + title: tt_DefoggingMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: DefoggingMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReduction: + title: tt_NoiseReduction + required: + - Level + type: object + properties: + Level: + type: number + description: Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20: + title: tt_ImagingOptions20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Brightness. + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Color Saturation. + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Contrast. + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions20' + - description: Valid range of Exposure. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20' + - description: Valid range of Focus. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: Valid range of IrCutFilterModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Sharpness. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension: + title: tt_ImagingOptions20Extension + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension2: + title: tt_ImagingOptions20Extension2 + type: object + properties: + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto mode. + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension3' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension3: + title: tt_ImagingOptions20Extension3 + type: object + properties: + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/tt_DefoggingOptions' + - description: Options of parameters for Defogging feature. + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/tt_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension4' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension3 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension4: + title: tt_ImagingOptions20Extension4 + type: object + description: '' + xml: + name: ImagingOptions20Extension4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptions: + title: tt_ImageStabilizationOptions + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ImageStabilizationMode' + description: Supported options of Image Stabilization mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Image Stabilization. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilizationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptionsExtension: + title: tt_ImageStabilizationOptionsExtension + type: object + description: '' + xml: + name: ImageStabilizationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptions: + title: tt_IrCutFilterAutoAdjustmentOptions + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: array + items: + type: string + xml: + name: BoundaryType + attribute: false + wrapped: false + description: Supported options of boundary types for adjustment of Ir cut filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: boolean + description: Indicates whether or not boundary offset for toggling Ir cut filter is supported. + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + xml: + name: ResponseTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptionsExtension: + title: tt_IrCutFilterAutoAdjustmentOptionsExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions20: + title: tt_WideDynamicRangeOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions20: + title: tt_BacklightCompensationOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_BacklightCompensationMode' + description: "'ON' or 'OFF'" + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Level range of BacklightCompensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions20: + title: tt_ExposureOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: Exposure Mode + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: The exposure priority mode (low noise/framerate). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum ExposureTime. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum ExposureTime. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Gain. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Gain. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Iris. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Iris. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the ExposureTime. + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Gain. + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions20: + title: tt_MoveOptions20 + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions20: + title: tt_RelativeFocusOptions20 + required: + - Distance + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20: + title: tt_WhiteBalance20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: "'AUTO' or 'MANUAL'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20Extension: + title: tt_WhiteBalance20Extension + type: object + description: '' + xml: + name: WhiteBalance20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20: + title: tt_FocusConfiguration20 + required: + - AutoFocusMode + type: object + properties: + AFMode: + type: string + description: Zero or more modes as defined in enumeration tt:AFModes. + xml: + name: AFMode + prefix: tt + attribute: true + wrapped: false + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - description: Mode of auto focus. + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: 'Parameter to set autofocus far limit (unit: meter).' + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20Extension: + title: tt_FocusConfiguration20Extension + type: object + description: '' + xml: + name: FocusConfiguration20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20: + title: tt_WhiteBalanceOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: Mode of WhiteBalance. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20Extension: + title: tt_WhiteBalanceOptions20Extension + type: object + description: '' + xml: + name: WhiteBalanceOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20: + title: tt_FocusOptions20 + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: Supported modes for auto focus. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of DefaultSpeed. + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of NearLimit. + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of FarLimit. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20Extension: + title: tt_FocusOptions20Extension + type: object + properties: + AFModes: + type: array + items: + type: string + xml: + name: AFModes + attribute: false + wrapped: false + description: Supported options for auto focus. Options shall be chosen from tt:AFModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationOptions: + title: tt_ToneCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Tone Compensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingOptions: + title: tt_DefoggingOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Defogging. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReductionOptions: + title: tt_NoiseReductionOptions + required: + - Level + type: object + properties: + Level: + type: boolean + description: Indicates whether or not support Level parameter for NoiseReduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageSendingType: + title: tt_ImageSendingType + enum: + - Embedded + - LocalStorage + - RemoteStorage + type: string + description: '' + xml: + name: ImageSendingType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PropertyOperation: + title: tt_PropertyOperation + enum: + - Initialized + - Deleted + - Changed + type: string + description: '' + xml: + name: PropertyOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Message: + title: tt_Message + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + PropertyOperation: + allOf: + - $ref: '#/components/schemas/tt_PropertyOperation' + - xml: + name: PropertyOperation + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: Token value pairs that triggered this message. Typically only one item is present. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Message + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageExtension: + title: tt_MessageExtension + type: object + description: '' + xml: + name: MessageExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemList: + title: tt_ItemList + type: object + properties: + SimpleItem: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItem' + description: Value name pair as defined by the corresponding description. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItem: + type: array + items: + $ref: '#/components/schemas/tt_ElementItem' + description: Complex value structure. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ItemList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListExtension: + title: tt_ItemListExtension + type: object + description: '' + xml: + name: ItemListExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescription: + title: tt_MessageDescription + type: object + properties: + IsProperty: + type: 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. + xml: + name: IsProperty + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + Set of tokens producing this message. The list may only contain SimpleItemDescription items. + The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key. + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes the payload of the message. + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MessageDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescriptionExtension: + title: tt_MessageDescriptionExtension + type: object + description: '' + xml: + name: MessageDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescription: + title: tt_ItemListDescription + type: object + properties: + SimpleItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItemDescription' + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_ElementItemDescription' + description: Description of a complex type. The Type must reference a defined type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + Describes a list of items. Each item in the list shall have a unique name. + The list is designed as linear structure without optional or unbounded elements. + Use ElementItems only when complex structures are inevitable. + xml: + name: ItemListDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescriptionExtension: + title: tt_ItemListDescriptionExtension + type: object + description: '' + xml: + name: ItemListDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polyline: + title: tt_Polyline + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polyline + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Direction: + title: tt_Direction + enum: + - Left + - Right + - Any + type: string + description: '' + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfiguration: + title: tt_AnalyticsEngineConfiguration + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfigurationExtension: + title: tt_AnalyticsEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfiguration: + title: tt_RuleEngineConfiguration + type: object + properties: + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfigurationExtension: + title: tt_RuleEngineConfigurationExtension + type: object + description: '' + xml: + name: RuleEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Config: + title: tt_Config + required: + - Name + - Type + - Parameters + type: object + properties: + Name: + type: string + description: Name of the configuration. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + 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. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: List of configuration parameters as defined in the corresponding description. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescription: + title: tt_ConfigDescription + required: + - Name + - Parameters + type: object + properties: + Name: + type: string + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies the type of rule, not a type definition in a schema. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: The fixed attribute signals that it is not allowed to add or remove this type of configuration. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + maxInstances: + type: integer + description: The maxInstances attribute signals the maximum number of instances per configuration. + format: int32 + xml: + name: maxInstances + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems + should be used to transport the information to ease parsing of dynamically defined messages by a client + application. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Messages: + type: array + items: + $ref: '#/components/schemas/tt_Messages' + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ConfigDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ConfigDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescriptionExtension: + title: tt_ConfigDescriptionExtension + type: object + description: '' + xml: + name: ConfigDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRules: + title: tt_SupportedRules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + RuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: RuleContentSchemaLocation + attribute: false + wrapped: false + description: Lists the location of all schemas that are referenced in the rules. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: List of rules supported by the Video Analytics configuration.. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedRulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedRules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRulesExtension: + title: tt_SupportedRulesExtension + type: object + description: '' + xml: + name: SupportedRulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModules: + title: tt_SupportedAnalyticsModules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + AnalyticsModuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: AnalyticsModuleContentSchemaLocation + attribute: false + wrapped: false + description: >- + It optionally contains a list of URLs that provide the location of schema files. + These schema files describe the types and elements used in the analytics module descriptions. + Analytics module descriptions that reference types or elements imported from any ONVIF defined schema files + need not explicitly list those schema files. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModulesExtension: + title: tt_SupportedAnalyticsModulesExtension + type: object + description: '' + xml: + name: SupportedAnalyticsModulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArray: + title: tt_PolylineArray + required: + - Segment + type: object + properties: + Segment: + type: array + items: + $ref: '#/components/schemas/tt_Polyline' + description: Contains array of Polyline + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PolylineArrayExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayExtension: + title: tt_PolylineArrayExtension + type: object + description: '' + xml: + name: PolylineArrayExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayConfiguration: + title: tt_PolylineArrayConfiguration + required: + - PolylineArray + type: object + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/tt_PolylineArray' + - description: Contains PolylineArray configuration data + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArrayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpression: + title: tt_MotionExpression + required: + - Expression + type: object + properties: + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Expression: + type: string + description: Motion Expression data structure contains motion expression which is based on Scene Descriptor schema with XPATH syntax. The Type argument could allow introduction of different dialects + xml: + name: Expression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpressionConfiguration: + title: tt_MotionExpressionConfiguration + required: + - MotionExpression + type: object + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/tt_MotionExpression' + - description: Contains Rule MotionExpression configuration + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpressionConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CellLayout: + title: tt_CellLayout + required: + - Columns + - Rows + - Transformation + type: object + properties: + Columns: + type: integer + description: Number of columns of the cell grid (x dimension) + format: int32 + xml: + name: Columns + prefix: tt + attribute: true + wrapped: false + Rows: + type: integer + description: Number of rows of the cell grid (y dimension) + format: int32 + xml: + name: Rows + prefix: tt + attribute: true + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid is starting from the upper left corner and x dimension is going from left to right and the y dimension from up to down. + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CellLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneConfiguration: + title: tt_PaneConfiguration + required: + - Token + type: object + properties: + PaneName: + type: string + description: Optional name of the pane configuration. + xml: + name: PaneName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputToken: + maxLength: 64 + type: string + description: >- + If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client + + can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. + xml: + name: AudioOutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceToken: + maxLength: 64 + type: string + description: >- + If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. + + The 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 + + DeviceIO service. + xml: + name: AudioSourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: >- + The configuration of the audio encoder including codec, bitrate + + and sample rate. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + maxLength: 64 + type: string + description: >- + A pointer to a Receiver that has the necessary information to receive + data 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 + GetReceivers command of the Receiver Service. + xml: + name: ReceiverToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: A unique identifier in the display device. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration of the streaming and coding settings of a Video window. + xml: + name: PaneConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayout: + title: tt_PaneLayout + required: + - Pane + - Area + type: object + properties: + Pane: + maxLength: 64 + type: string + description: Reference to the configuration of the streaming and coding parameters. + xml: + name: Pane + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Area: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Describes the location and size of the area on the monitor. The area coordinate values are espressed in normalized units [-1.0, 1.0]. + xml: + name: Area + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen. + xml: + name: PaneLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Layout: + title: tt_Layout + required: + - PaneLayout + type: object + properties: + PaneLayout: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayout' + description: List of panes assembling the display layout. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A layout describes a set of Video windows that are displayed simultaniously on a display. + xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutExtension: + title: tt_LayoutExtension + type: object + description: '' + xml: + name: LayoutExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CodingCapabilities: + title: tt_CodingCapabilities + required: + - VideoDecodingCapabilities + type: object + properties: + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes the supported codecs and their configuration. + xml: + name: AudioEncodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes the supported codecs and their settings. + xml: + name: AudioDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their configuration. + xml: + name: VideoDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: This type contains the Audio and Video coding capabilities of a display service. + xml: + name: CodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptions: + title: tt_LayoutOptions + required: + - PaneLayoutOptions + type: object + properties: + PaneLayoutOptions: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayoutOptions' + description: Lists the possible Pane Layouts of the Video Output + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The options supported for a display layout. + xml: + name: LayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptionsExtension: + title: tt_LayoutOptionsExtension + type: object + description: '' + xml: + name: LayoutOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayoutOptions: + title: tt_PaneLayoutOptions + required: + - Area + type: object + properties: + Area: + type: array + items: + $ref: '#/components/schemas/tt_Rectangle' + description: List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PaneOptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a pane layout describing a complete display layout. + xml: + name: PaneLayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneOptionExtension: + title: tt_PaneOptionExtension + type: object + description: '' + xml: + name: PaneOptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Receiver: + title: tt_Receiver + required: + - Token + - Configuration + type: object + properties: + Token: + maxLength: 64 + type: string + description: Unique identifier of the receiver. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a receiver, including its token and configuration. + xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverConfiguration: + title: tt_ReceiverConfiguration + required: + - Mode + - MediaUri + - StreamSetup + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReceiverMode' + - description: 'The following connection modes are defined:' + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaUri: + type: string + description: Details of the URI to which the receiver should connect. + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream connection parameters. + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describes the configuration of a receiver. + xml: + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverMode: + title: tt_ReceiverMode + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + description: Specifies a receiver connection mode. + xml: + name: ReceiverMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverState: + title: tt_ReceiverState + enum: + - NotConnected + - Connecting + - Connected + - Unknown + type: string + description: Specifies the current connection state of the receiver. + xml: + name: ReceiverState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverStateInformation: + title: tt_ReceiverStateInformation + required: + - State + - AutoCreated + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_ReceiverState' + - description: 'The connection state of the receiver may have one of the following states:' + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreated: + type: boolean + description: Indicates whether or not the receiver was created automatically. + xml: + name: AutoCreated + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Contains information about a receiver's current state. + xml: + name: ReceiverStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceReference: + title: tt_SourceReference + required: + - Token + type: object + properties: + Type: + type: string + default: http://www.onvif.org/ver10/schema/Receiver + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTimeRange: + title: tt_DateTimeRange + required: + - From + - Until + type: object + properties: + From: + type: string + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSummary: + title: tt_RecordingSummary + required: + - DataFrom + - DataUntil + - NumberRecordings + type: object + properties: + DataFrom: + type: string + description: The earliest point in time where there is recorded data on the device. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataUntil: + type: string + description: The most recent point in time where there is recorded data on the device. + format: date-time + xml: + name: DataUntil + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NumberRecordings: + type: integer + description: The device contains this many recordings. + format: int32 + xml: + name: NumberRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingSummary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScope: + title: tt_SearchScope + type: object + properties: + IncludedSources: + type: array + items: + $ref: '#/components/schemas/tt_SourceReference' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IncludedRecordings: + type: array + items: + maxLength: 64 + type: string + xml: + name: IncludedRecordings + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformationFilter: + type: string + 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. + xml: + name: RecordingInformationFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SearchScopeExtension' + - description: Extension point + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A structure for defining a limited scope when searching in recorded data. + xml: + name: SearchScope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScopeExtension: + title: tt_SearchScopeExtension + type: object + description: '' + xml: + name: SearchScopeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventFilter: + title: tt_EventFilter + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + xml: + name: EventFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZPositionFilter: + title: tt_PTZPositionFilter + required: + - MinPosition + - MaxPosition + - EnterOrExit + type: object + properties: + MinPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + xml: + name: MinPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + xml: + name: MaxPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EnterOrExit: + type: boolean + description: If true, search for when entering the specified PTZ volume. + xml: + name: EnterOrExit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPositionFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataFilter: + title: tt_MetadataFilter + required: + - MetadataStreamFilter + type: object + properties: + MetadataStreamFilter: + type: string + xml: + name: MetadataStreamFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindRecordingResultList: + title: tt_FindRecordingResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformation: + type: array + items: + $ref: '#/components/schemas/tt_RecordingInformation' + description: A RecordingInformation structure for each found recording matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindRecordingResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResultList: + title: tt_FindEventResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindEventResult' + description: A FindEventResult structure for each found event matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResult: + title: tt_FindEventResult + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: The recording where this event was found. Empty string if no recording is associated with this event. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the track where this event was found. Empty string if no track is associated with this event. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the event occured. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + xml: + name: Event + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartStateEvent: + type: boolean + 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. + xml: + name: StartStateEvent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResultList: + title: tt_FindPTZPositionResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindPTZPositionResult' + description: A FindPTZPositionResult structure for each found PTZ position matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResult: + title: tt_FindPTZPositionResult + required: + - RecordingToken + - TrackToken + - Time + - Position + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the PTZ position. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the PTZ position. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the PTZ position was valid. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The PTZ position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResultList: + title: tt_FindMetadataResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindMetadataResult' + description: A FindMetadataResult structure for each found set of Metadata matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResult: + title: tt_FindMetadataResult + required: + - RecordingToken + - TrackToken + - Time + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the metadata. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the matching metadata. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The point in time when the matching metadata occurs in the metadata track. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchState: + title: tt_SearchState + enum: + - Queued + - Searching + - Completed + - Unknown + type: string + description: '' + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingInformation: + title: tt_RecordingInformation + required: + - RecordingToken + - Source + - Content + - RecordingStatus + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: >- + Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single + recording is intended to record related material, there is just one source. It is indicates the physical location or the + major data source for the recording. Currently the recordingconfiguration cannot describe each individual data source. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EarliestRecording: + type: string + format: date-time + xml: + name: EarliestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LatestRecording: + type: string + format: date-time + xml: + name: LatestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Track: + type: array + items: + $ref: '#/components/schemas/tt_TrackInformation' + description: Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingStatus: + allOf: + - $ref: '#/components/schemas/tt_RecordingStatus' + - xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSourceInformation: + title: tt_RecordingSourceInformation + required: + - SourceId + - Name + - Location + - Description + - Address + type: object + properties: + SourceId: + type: string + description: >- + Identifier for the source chosen by the client that creates the structure. + This identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters. + xml: + name: SourceId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + maxLength: 64 + type: string + description: Informative user readable name of the source, e.g. "Camera23". A device shall support at least 20 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Location: + type: string + description: Informative description of the physical location of the source, e.g. the coordinates on a map. + xml: + name: Location + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the source. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Address: + type: string + description: URI provided by the service supplying data to be recorded. A device shall support at least 128 characters. + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of informative desciptions of a data source. The Search searvice allows a client to filter on recordings based on information in this structure. + xml: + name: RecordingSourceInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingStatus: + title: tt_RecordingStatus + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + type: string + description: '' + xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackInformation: + title: tt_TrackInformation + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + type: object + properties: + TrackToken: + maxLength: 64 + type: string + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track: "Video", "Audio" or "Metadata". + The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the contents of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataFrom: + type: string + description: The start date and time of the oldest recorded data in the track. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataTo: + type: string + description: The stop date and time of the newest recorded data in the track. + format: date-time + xml: + name: DataTo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackType: + title: tt_TrackType + enum: + - Video + - Audio + - Metadata + - Extended + type: string + description: '' + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaAttributes: + title: tt_MediaAttributes + required: + - RecordingToken + - From + - Until + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording that has these attributes. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackAttributes: + type: array + items: + $ref: '#/components/schemas/tt_TrackAttributes' + description: A set of attributes for each track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + From: + type: string + description: The attributes are valid from this point in time in the recording. + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + 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. + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of media attributes valid for a recording at a point in time or for a time interval. + xml: + name: MediaAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributes: + title: tt_TrackAttributes + required: + - TrackInformation + type: object + properties: + TrackInformation: + allOf: + - $ref: '#/components/schemas/tt_TrackInformation' + - description: The basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAttributes: + allOf: + - $ref: '#/components/schemas/tt_VideoAttributes' + - description: If the track is a video track, exactly one of this structure shall be present and contain the video attributes. + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioAttributes: + allOf: + - $ref: '#/components/schemas/tt_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure shall be present and contain the audio attributes. + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/tt_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure shall be present and contain the metadata attributes. + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TrackAttributesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributesExtension: + title: tt_TrackAttributesExtension + type: object + description: '' + xml: + name: TrackAttributesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAttributes: + title: tt_VideoAttributes + required: + - Width + - Height + - Encoding + - Framerate + type: object + properties: + Bitrate: + type: integer + description: Average bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Width: + type: integer + description: The width of the video in pixels. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: The height of the video in pixels. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Video encoding of the track. Use value from tt:VideoEncoding for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Framerate: + type: number + description: Average framerate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAttributes: + title: tt_AudioAttributes + required: + - Encoding + - Samplerate + type: object + properties: + Bitrate: + type: integer + description: The bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Audio encoding of the track. Use values from tt:AudioEncoding for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Samplerate: + type: integer + description: The sample rate in kHz. + format: int32 + xml: + name: Samplerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataAttributes: + title: tt_MetadataAttributes + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + type: object + properties: + PtzSpaces: + type: 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. + xml: + name: PtzSpaces + prefix: tt + attribute: true + wrapped: false + CanContainPTZ: + type: boolean + description: Indicates that there can be PTZ data in the metadata track in the specified time interval. + xml: + name: CanContainPTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainAnalytics: + type: boolean + description: Indicates that there can be analytics data in the metadata track in the specified time interval. + xml: + name: CanContainAnalytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainNotifications: + type: boolean + description: Indicates that there can be notifications in the metadata track in the specified time interval. + xml: + name: CanContainNotifications + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingConfiguration: + title: tt_RecordingConfiguration + required: + - Source + - Content + - MaximumRetentionTime + type: object + properties: + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: Information about the source of the recording. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + description: Informative description of the source. + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRetentionTime: + type: string + description: >- + Sspecifies the maximum time that data in any track within the + recording shall be stored. The device shall delete any data older than the maximum retention + time. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0, + the device shall not limit the retention time of stored data, except by resource constraints. + Whatever the value of MaximumRetentionTime, the device may automatically delete + recordings to free up storage space for new recordings. + format: date-time + xml: + name: MaximumRetentionTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackConfiguration: + title: tt_TrackConfiguration + required: + - TrackType + - Description + type: object + properties: + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track. It shall be equal to the strings “Video”, + “Audio” or “Metadata”. The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingsResponseItem: + title: tt_GetRecordingsResponseItem + required: + - RecordingToken + - Configuration + - Tracks + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Token of the recording. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_RecordingConfiguration' + - description: Configuration of the recording. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_GetTracksResponseList' + - description: List of tracks. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseList: + title: tt_GetTracksResponseList + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_GetTracksResponseItem' + description: Configuration of a track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseItem: + title: tt_GetTracksResponseItem + required: + - TrackToken + - Configuration + type: object + properties: + TrackToken: + maxLength: 64 + type: string + description: Token of the track. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_TrackConfiguration' + - description: Configuration of the track. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfiguration: + title: tt_RecordingJobConfiguration + required: + - RecordingToken + - Mode + - Priority + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identifies the recording to which this job shall store the received data. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + type: string + description: >- + The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try + to obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: integer + description: >- + This shall be a non-negative number. If there are multiple recording jobs that store data to + the same track, the device will only store the data for the recording job with the highest + priority. The priority is specified per recording job, but the device shall determine the priority + of each track individually. If there are two recording jobs with the same priority, the device + shall record the data corresponding to the recording job that was activated the latest. + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobSource' + description: Source of the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfigurationExtension: + title: tt_RecordingJobConfigurationExtension + type: object + description: '' + xml: + name: RecordingJobConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSource: + title: tt_RecordingJobSource + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: >- + This field shall be a reference to the source of the data. The type of the source + is determined by the attribute Type in the SourceToken structure. If Type is + http://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case + the device shall receive the data over the network. If Type is + http://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, instructing the + device to obtain data from a profile that exists on the local device. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreateReceiver: + type: boolean + description: >- + If this field is TRUE, and if the SourceToken is omitted, the device + shall create a receiver object (through the receiver service) and assign the + ReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration + from the device, the AutoCreateReceiver field shall never be present. + xml: + name: AutoCreateReceiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobTrack' + description: List of tracks associated with the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSourceExtension: + title: tt_RecordingJobSourceExtension + type: object + description: '' + xml: + name: RecordingJobSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobTrack: + title: tt_RecordingJobTrack + required: + - SourceTag + - Destination + type: object + properties: + SourceTag: + type: string + description: >- + If the received RTSP stream contains multiple tracks of the same type, the + SourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: >- + The destination is the tracktoken of the track to which the device shall store the + received data. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformation: + title: tt_RecordingJobStateInformation + required: + - RecordingToken + - State + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identification of the recording that the recording job records to. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over the whole RecordingJobInformation structure. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sources: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateSource' + description: Identifies the data source of the recording job. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformationExtension: + title: tt_RecordingJobStateInformationExtension + type: object + description: '' + xml: + name: RecordingJobStateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateSource: + title: tt_RecordingJobStateSource + required: + - SourceToken + - State + - Tracks + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: Identifies the data source of the recording job. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateTracks' + - description: List of track items. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTracks: + title: tt_RecordingJobStateTracks + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateTrack' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTrack: + title: tt_RecordingJobStateTrack + required: + - SourceTag + - Destination + - State + type: object + properties: + SourceTag: + type: string + description: Identifies the track of the data source that provides the data. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: Indicates the destination track. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: >- + Optionally holds an implementation defined string value that describes the error. + The string should be in the English language. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: >- + Provides the job state of the track. The valid + values of state shall be “Idle”, “Active” and “Error”. If state equals “Error”, the Error field may be filled in with an implementation defined value. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingJobsResponseItem: + title: tt_GetRecordingJobsResponseItem + required: + - JobToken + - JobConfiguration + type: object + properties: + JobToken: + maxLength: 64 + type: string + xml: + name: JobToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JobConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfiguration' + - xml: + name: JobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingJobsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayConfiguration: + title: tt_ReplayConfiguration + required: + - SessionTimeout + type: object + properties: + SessionTimeout: + type: string + description: The RTSP session timeout. + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration parameters for the replay service. + xml: + name: ReplayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngine: + title: tt_AnalyticsEngine + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngine + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AnalyticsDeviceEngineConfiguration: + title: tt_AnalyticsDeviceEngineConfiguration + required: + - EngineConfiguration + type: object + properties: + EngineConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_EngineConfiguration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceEngineConfigurationExtension: + title: tt_AnalyticsDeviceEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsDeviceEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EngineConfiguration: + title: tt_EngineConfiguration + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + type: object + properties: + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineInputInfo: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfo' + - xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfo: + title: tt_AnalyticsEngineInputInfo + type: object + properties: + InputInfo: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: InputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfoExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfoExtension: + title: tt_AnalyticsEngineInputInfoExtension + type: object + description: '' + xml: + name: AnalyticsEngineInputInfoExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInput: + title: tt_AnalyticsEngineInput + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + properties: + SourceIdentification: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentification' + - xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoInput: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - xml: + name: VideoInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataInput: + allOf: + - $ref: '#/components/schemas/tt_MetadataInput' + - xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_SourceIdentification: + title: tt_SourceIdentification + required: + - Name + - Token + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + type: array + items: + maxLength: 64 + type: string + xml: + name: Token + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentificationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceIdentificationExtension: + title: tt_SourceIdentificationExtension + type: object + description: '' + xml: + name: SourceIdentificationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInput: + title: tt_MetadataInput + type: object + properties: + MetadataConfig: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataInputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInputExtension: + title: tt_MetadataInputExtension + type: object + description: '' + xml: + name: MetadataInputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineControl: + title: tt_AnalyticsEngineControl + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + properties: + EngineToken: + maxLength: 64 + type: string + description: Token of the analytics engine (AnalyticsEngine) being controlled. + xml: + name: EngineToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EngineConfigToken: + maxLength: 64 + type: string + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect. + xml: + name: EngineConfigToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InputToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputToken + attribute: false + wrapped: false + description: Tokens of the input (AnalyticsEngineInput) configuration applied. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: ReceiverToken + attribute: false + wrapped: false + description: Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subscription: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: Subscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ModeOfOperation' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_ModeOfOperation: + title: tt_ModeOfOperation + enum: + - Idle + - Active + - Unknown + type: string + description: '' + xml: + name: ModeOfOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsStateInformation: + title: tt_AnalyticsStateInformation + required: + - AnalyticsEngineControlToken + - State + type: object + properties: + AnalyticsEngineControlToken: + maxLength: 64 + type: string + description: Token of the control object whose status is requested. + xml: + name: AnalyticsEngineControlToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsState' + - xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsState: + title: tt_AnalyticsState + required: + - State + type: object + properties: + Error: + type: string + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayload: + title: tt_ActionEngineEventPayload + type: object + properties: + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + xml: + name: RequestInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + xml: + name: ResponseInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + xml: + name: Fault + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ActionEngineEventPayloadExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Action Engine Event Payload data structure contains the information about the ONVIF command invocations. Since this event could be generated by other or proprietary actions, the command invocation specific fields are defined as optional and additional extension mechanism is provided for future or additional action definitions. + xml: + name: ActionEngineEventPayload + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayloadExtension: + title: tt_ActionEngineEventPayloadExtension + type: object + description: '' + xml: + name: ActionEngineEventPayloadExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassType: + title: tt_AudioClassType + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + type: string + description: >- + AudioClassType acceptable values are; + gun_shot, scream, glass_breaking, tire_screech + xml: + name: AudioClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassCandidate: + title: tt_AudioClassCandidate + required: + - Type + - Likelihood + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_AudioClassType' + - description: Indicates audio class label + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + description: A likelihood/probability that the corresponding audio event belongs to this class. The sum of the likelihoods shall NOT exceed 1 + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptor: + title: tt_AudioClassDescriptor + type: object + properties: + ClassCandidate: + type: array + items: + $ref: '#/components/schemas/tt_AudioClassCandidate' + description: Array of audio class label and class probability + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioClassDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptorExtension: + title: tt_AudioClassDescriptorExtension + type: object + description: '' + xml: + name: AudioClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActiveConnection: + title: tt_ActiveConnection + required: + - CurrentBitrate + - CurrentFps + type: object + properties: + CurrentBitrate: + type: number + xml: + name: CurrentBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentFps: + type: number + xml: + name: CurrentFps + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ActiveConnection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatus: + title: tt_ProfileStatus + type: object + properties: + ActiveConnections: + type: array + items: + $ref: '#/components/schemas/tt_ActiveConnection' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatusExtension: + title: tt_ProfileStatusExtension + type: object + description: '' + xml: + name: ProfileStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDReference: + title: tt_OSDReference + type: object + description: '' + xml: + name: OSDReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDType: + title: tt_OSDType + enum: + - Text + - Image + - Extended + type: string + description: '' + xml: + name: OSDType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfiguration: + title: tt_OSDPosConfiguration + required: + - Type + type: object + properties: + Type: + type: string + description: 'For OSD position type, following are the pre-defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Pos: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Pos + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDPosConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfigurationExtension: + title: tt_OSDPosConfigurationExtension + type: object + description: '' + xml: + name: OSDPosConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColor: + title: tt_OSDColor + required: + - Color + type: object + properties: + Transparent: + type: integer + format: int32 + xml: + name: Transparent + prefix: tt + attribute: true + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: 'The value range of "Transparent" could be defined by vendors only should follow this rule: the minimum value means non-transparent and the maximum value maens fully transparent.' + xml: + name: OSDColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfiguration: + title: tt_OSDTextConfiguration + required: + - Type + type: object + properties: + IsPersistentText: + type: 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. + xml: + name: IsPersistentText + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: 'The following OSD Text Type are defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: string + 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:' + xml: + name: DateFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: string + 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:' + xml: + name: TimeFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSize: + type: integer + description: Font size of the text in pt. + format: int32 + xml: + name: FontSize + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Font color of the text. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Background color of the text. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PlainText: + type: string + description: The content of text to be displayed. + xml: + name: PlainText + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfigurationExtension: + title: tt_OSDTextConfigurationExtension + type: object + description: '' + xml: + name: OSDTextConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfiguration: + title: tt_OSDImgConfiguration + required: + - ImgPath + type: object + properties: + ImgPath: + type: string + description: The URI of the image which to be displayed. + xml: + name: ImgPath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfigurationExtension: + title: tt_OSDImgConfigurationExtension + type: object + description: '' + xml: + name: OSDImgConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorspaceRange: + title: tt_ColorspaceRange + required: + - X + - Y + - Z + - Colorspace + type: object + properties: + X: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Y: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Y + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Z: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Z + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorspaceRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptions: + title: tt_ColorOptions + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the colors supported. Either list each color or define the range of color values. + xml: + name: ColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptions: + title: tt_OSDColorOptions + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorOptions' + - description: Optional list of supported colors. + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transparent: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + xml: + name: Transparent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the option of the color and its transparency. + xml: + name: OSDColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptionsExtension: + title: tt_OSDColorOptionsExtension + type: object + description: '' + xml: + name: OSDColorOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptions: + title: tt_OSDTextOptions + required: + - Type + type: object + properties: + Type: + type: array + items: + type: string + xml: + name: Type + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSizeRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the font size value. + xml: + name: FontSizeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: array + items: + type: string + xml: + name: DateFormat + attribute: false + wrapped: false + description: List of supported date format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: array + items: + type: string + xml: + name: TimeFormat + attribute: false + wrapped: false + description: List of supported time format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported font color. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported background color. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptionsExtension: + title: tt_OSDTextOptionsExtension + type: object + description: '' + xml: + name: OSDTextOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptions: + title: tt_OSDImgOptions + required: + - ImagePath + type: object + properties: + FormatsSupported: + type: string + description: List of supported image MIME types, such as "image/png". + xml: + name: FormatsSupported + prefix: tt + attribute: true + wrapped: false + MaxSize: + type: integer + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + xml: + name: MaxSize + prefix: tt + attribute: true + wrapped: false + MaxWidth: + type: integer + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxWidth + prefix: tt + attribute: true + wrapped: false + MaxHeight: + type: integer + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxHeight + prefix: tt + attribute: true + wrapped: false + ImagePath: + type: array + items: + type: string + xml: + name: ImagePath + attribute: false + wrapped: false + description: List of available image URIs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptionsExtension: + title: tt_OSDImgOptionsExtension + type: object + description: '' + xml: + name: OSDImgOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfiguration: + title: tt_OSDConfiguration + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + properties: + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/tt_OSDReference' + - description: Reference to the video source configuration. + xml: + name: VideoSourceConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_OSDType' + - description: Type of OSD. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfiguration' + - description: Position configuration of OSD. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextString: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the value of Type field is Text. + xml: + name: TextString + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Image: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the value of Type field is Image + xml: + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: OSDConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_OSDConfigurationExtension: + title: tt_OSDConfigurationExtension + type: object + description: '' + xml: + name: OSDConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MaximumNumberOfOSDs: + title: tt_MaximumNumberOfOSDs + required: + - Total + type: object + properties: + Total: + type: integer + format: int32 + xml: + name: Total + prefix: tt + attribute: true + wrapped: false + Image: + type: integer + format: int32 + xml: + name: Image + prefix: tt + attribute: true + wrapped: false + PlainText: + type: integer + format: int32 + xml: + name: PlainText + prefix: tt + attribute: true + wrapped: false + Date: + type: integer + format: int32 + xml: + name: Date + prefix: tt + attribute: true + wrapped: false + Time: + type: integer + format: int32 + xml: + name: Time + prefix: tt + attribute: true + wrapped: false + DateAndTime: + type: integer + format: int32 + xml: + name: DateAndTime + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptions: + title: tt_OSDConfigurationOptions + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + type: object + properties: + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/tt_MaximumNumberOfOSDs' + - 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. + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + type: array + items: + $ref: '#/components/schemas/tt_OSDType' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PositionOption: + type: array + items: + type: string + xml: + name: PositionOption + attribute: false + wrapped: false + description: 'List available OSD position type. Following are the pre-defined:' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextOption: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text. + xml: + name: TextOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ImageOption: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image. + xml: + name: ImageOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptionsExtension: + title: tt_OSDConfigurationOptionsExtension + type: object + description: '' + xml: + name: OSDConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FileProgress: + title: tt_FileProgress + required: + - FileName + - Progress + type: object + properties: + FileName: + type: string + description: Exported file name + xml: + name: FileName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Progress: + type: number + description: Normalized percentage completion for uploading the exported file + xml: + name: Progress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgress: + title: tt_ArrayOfFileProgress + type: object + properties: + FileProgress: + type: array + items: + $ref: '#/components/schemas/tt_FileProgress' + description: Exported file name and export progress information + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ArrayOfFileProgressExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ArrayOfFileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgressExtension: + title: tt_ArrayOfFileProgressExtension + type: object + description: '' + xml: + name: ArrayOfFileProgressExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePath: + title: tt_StorageReferencePath + required: + - StorageToken + type: object + properties: + StorageToken: + maxLength: 64 + type: string + description: identifier of an existing Storage Configuration. + xml: + name: StorageToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePath: + type: string + description: gives the relative directory path on the storage + xml: + name: RelativePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_StorageReferencePathExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StorageReferencePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePathExtension: + title: tt_StorageReferencePathExtension + type: object + description: '' + xml: + name: StorageReferencePathExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolygonOptions: + title: tt_PolygonOptions + type: object + properties: + RectangleOnly: + type: boolean + description: >- + True if the device supports defining a region only using Rectangle. + + The rectangle points are still passed using a Polygon element if the device does not support polygon regions. In this case, the points provided in the Polygon element shall represent a rectangle. + xml: + name: RectangleOnly + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VertexLimits: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: >- + Provides the minimum and maximum number of points that can be defined in the Polygon. + + If RectangleOnly is not set to true, this parameter is required. + xml: + name: VertexLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolygonOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Appearance: + title: tt_Appearance + type: object + properties: + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Shape: + allOf: + - $ref: '#/components/schemas/tt_ShapeDescriptor' + - xml: + name: Shape + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Class: + allOf: + - $ref: '#/components/schemas/tt_ClassDescriptor' + - xml: + name: Class + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AppearanceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VehicleInfo: + type: array + items: + $ref: '#/components/schemas/tt_VehicleInfo' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LicensePlateInfo: + allOf: + - $ref: '#/components/schemas/tt_LicensePlateInfo' + - xml: + name: LicensePlateInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HumanFace: + allOf: + - $ref: '#/components/schemas/fc_HumanFace' + - xml: + name: HumanFace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HumanBody: + allOf: + - $ref: '#/components/schemas/bd_HumanBody' + - xml: + name: HumanBody + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ImageRef: + type: string + xml: + name: ImageRef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Image: + type: string + format: binary + xml: + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Appearance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AppearanceExtension: + title: tt_AppearanceExtension + type: object + description: '' + xml: + name: AppearanceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VehicleType: + title: tt_VehicleType + enum: + - Bus + - Car + - Truck + - Bicycle + - Motorcycle + type: string + description: '' + xml: + name: VehicleType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PlateType: + title: tt_PlateType + enum: + - Normal + - Police + - Diplomat + - Temporary + type: string + description: '' + xml: + name: PlateType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VehicleInfo: + title: tt_VehicleInfo + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brand: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - xml: + name: Brand + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Model: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - xml: + name: Model + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VehicleInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LicensePlateInfo: + title: tt_LicensePlateInfo + required: + - PlateNumber + type: object + properties: + PlateNumber: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - description: A string of vehicle license plate number. + xml: + name: PlateNumber + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PlateType: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - description: A description of the vehicle license plate, e.g., "Normal", "Police", "Diplomat" + xml: + name: PlateType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CountryCode: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - description: Describe the country of the license plate, in order to avoid the same license plate number. + xml: + name: CountryCode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IssuingEntity: + allOf: + - $ref: '#/components/schemas/tt_StringLikelihood' + - description: State province or authority that issue the license plate. + xml: + name: IssuingEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LicensePlateInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ShapeDescriptor: + title: tt_ShapeDescriptor + required: + - BoundingBox + - CenterOfGravity + type: object + properties: + BoundingBox: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - xml: + name: BoundingBox + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CenterOfGravity: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: CenterOfGravity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Polygon: + type: array + items: + $ref: '#/components/schemas/tt_Polygon' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ShapeDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ShapeDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ShapeDescriptorExtension: + title: tt_ShapeDescriptorExtension + type: object + description: '' + xml: + name: ShapeDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ObjectType: + title: tt_ObjectType + enum: + - Animal + - HumanFace + - Human + - Bicycle + - Vehicle + - LicensePlate + - Bike + type: string + description: '' + xml: + name: ObjectType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ClassType: + title: tt_ClassType + enum: + - Animal + - Face + - Human + - Vehical + - Other + type: string + description: '' + xml: + name: ClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StringLikelihood: + title: tt_StringLikelihood + type: object + properties: + Likelihood: + type: number + xml: + name: Likelihood + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: StringLikelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ClassDescriptor: + title: tt_ClassDescriptor + type: object + properties: + ClassCandidate: + type: array + items: + $ref: '#/components/schemas/tt_ClassCandidate' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ClassDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + type: array + items: + $ref: '#/components/schemas/tt_StringLikelihood' + description: ONVIF recommends to use this 'Type' element instead of 'ClassCandidate' and 'Extension' above for new design. Acceptable values are defined in tt:ObjectType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ClassDescriptorExtension: + title: tt_ClassDescriptorExtension + required: + - OtherTypes + type: object + properties: + OtherTypes: + type: array + items: + $ref: '#/components/schemas/tt_OtherType' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ClassDescriptorExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ClassDescriptorExtension2: + title: tt_ClassDescriptorExtension2 + type: object + description: '' + xml: + name: ClassDescriptorExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OtherType: + title: tt_OtherType + required: + - Type + - Likelihood + type: object + properties: + Type: + type: string + description: Object Class Type + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + description: A likelihood/probability that the corresponding object belongs to this class. The sum of the likelihoods shall NOT exceed 1 + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OtherType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Object: + title: tt_Object + allOf: + - $ref: '#/components/schemas/tt_ObjectId' + - type: object + properties: + Appearance: + allOf: + - $ref: '#/components/schemas/tt_Appearance' + - xml: + name: Appearance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Behaviour: + allOf: + - $ref: '#/components/schemas/tt_Behaviour' + - xml: + name: Behaviour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ObjectExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Parent: + type: integer + description: 'Object ID of the parent object. eg: License plate object has Vehicle object as parent.' + format: int32 + xml: + name: Parent + prefix: tt + attribute: true + wrapped: false + xml: + name: Object + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_ObjectExtension: + title: tt_ObjectExtension + type: object + description: '' + xml: + name: ObjectExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Frame: + title: tt_Frame + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: Default color space of Color definitions in frame. Valid values are "RGB" and "YCbCr". Defaults to "YCbCr". + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + Source: + type: string + description: Optional name of the analytics module that generated this frame. + xml: + name: Source + prefix: tt + attribute: true + wrapped: false + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZStatus' + - xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Object: + type: array + items: + $ref: '#/components/schemas/tt_Object' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ObjectTree: + allOf: + - $ref: '#/components/schemas/tt_ObjectTree' + - xml: + name: ObjectTree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FrameExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneImageRef: + type: string + xml: + name: SceneImageRef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneImage: + type: string + format: binary + xml: + name: SceneImage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Frame + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FrameExtension: + title: tt_FrameExtension + type: object + properties: + MotionInCells: + allOf: + - $ref: '#/components/schemas/tt_MotionInCells' + - xml: + name: MotionInCells + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FrameExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FrameExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FrameExtension2: + title: tt_FrameExtension2 + type: object + description: '' + xml: + name: FrameExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Merge: + title: tt_Merge + required: + - from + - to + type: object + properties: + from: + type: array + items: + $ref: '#/components/schemas/tt_ObjectId' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + to: + allOf: + - $ref: '#/components/schemas/tt_ObjectId' + - xml: + name: to + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Merge + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Split: + title: tt_Split + required: + - from + - to + type: object + properties: + from: + allOf: + - $ref: '#/components/schemas/tt_ObjectId' + - xml: + name: from + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + to: + type: array + items: + $ref: '#/components/schemas/tt_ObjectId' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Split + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rename: + title: tt_Rename + required: + - from + - to + type: object + properties: + from: + allOf: + - $ref: '#/components/schemas/tt_ObjectId' + - xml: + name: from + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + to: + allOf: + - $ref: '#/components/schemas/tt_ObjectId' + - xml: + name: to + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Rename + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ObjectId: + title: tt_ObjectId + type: object + properties: + ObjectId: + type: integer + format: int32 + xml: + name: ObjectId + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: ObjectId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Behaviour: + title: tt_Behaviour + type: object + properties: + Removed: + allOf: + - $ref: '#/components/schemas/tt_Removed' + - xml: + name: Removed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Idle: + allOf: + - $ref: '#/components/schemas/tt_Idle' + - xml: + name: Idle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_BehaviourExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Behaviour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BehaviourExtension: + title: tt_BehaviourExtension + type: object + description: '' + xml: + name: BehaviourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ObjectTree: + title: tt_ObjectTree + type: object + properties: + Rename: + type: array + items: + $ref: '#/components/schemas/tt_Rename' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Split: + type: array + items: + $ref: '#/components/schemas/tt_Split' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Merge: + type: array + items: + $ref: '#/components/schemas/tt_Merge' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Delete: + type: array + items: + $ref: '#/components/schemas/tt_ObjectId' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ObjectTreeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ObjectTree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ObjectTreeExtension: + title: tt_ObjectTreeExtension + type: object + description: '' + xml: + name: ObjectTreeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionInCells: + title: tt_MotionInCells + required: + - Columns + - Rows + - Cells + type: object + properties: + Columns: + type: integer + description: Number of columns of the cell grid (x dimension) + format: int32 + xml: + attribute: true + wrapped: false + Rows: + type: integer + description: Number of rows of the cell grid (y dimension) + format: int32 + xml: + attribute: true + wrapped: false + Cells: + type: string + description: A “1” denotes a cell where motion is detected and a “0” 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 Packbit coding in ISO 12369 (TIFF, Revision 6.0). + format: binary + description: '' + xml: + name: MotionInCells + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataStream: + title: tt_MetadataStream + type: object + properties: + VideoAnalytics: + type: array + items: + oneOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsStreamChoice0' + - $ref: '#/components/schemas/tt_VideoAnalyticsStreamChoice1' + - $ref: '#/components/schemas/tt_VideoAnalyticsStreamChoice2' + xml: + name: VideoAnalytics + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZ: + type: array + items: + oneOf: + - $ref: '#/components/schemas/tt_PTZStreamChoice0' + - $ref: '#/components/schemas/tt_PTZStreamChoice1' + - $ref: '#/components/schemas/tt_PTZStreamChoice2' + xml: + name: PTZ + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Event: + type: array + items: + oneOf: + - $ref: '#/components/schemas/tt_EventStreamChoice0' + - $ref: '#/components/schemas/tt_EventStreamChoice1' + - $ref: '#/components/schemas/tt_EventStreamChoice2' + xml: + name: Event + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + type: array + items: + $ref: '#/components/schemas/tt_MetadataStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataStream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataStreamExtension: + title: tt_MetadataStreamExtension + type: object + properties: + AudioAnalyticsStream: + allOf: + - $ref: '#/components/schemas/tt_AudioAnalyticsStream' + - xml: + name: AudioAnalyticsStream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataStreamExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataStreamExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataStreamExtension2: + title: tt_MetadataStreamExtension2 + type: object + description: '' + xml: + name: MetadataStreamExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAnalyticsStream: + title: tt_AudioAnalyticsStream + type: object + properties: + AudioDescriptor: + type: array + items: + $ref: '#/components/schemas/tt_AudioDescriptor' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioAnalyticsStreamExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioAnalyticsStream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDescriptor: + title: tt_AudioDescriptor + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: AudioDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAnalyticsStreamExtension: + title: tt_AudioAnalyticsStreamExtension + type: object + description: '' + xml: + name: AudioAnalyticsStreamExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAnalyticsStream: + title: tt_VideoAnalyticsStream + type: object + properties: + Frame: + type: array + items: + $ref: '#/components/schemas/tt_Frame' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + type: array + items: + $ref: '#/components/schemas/tt_VideoAnalyticsStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoAnalyticsStream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAnalyticsStreamExtension: + title: tt_VideoAnalyticsStreamExtension + type: object + description: '' + xml: + name: VideoAnalyticsStreamExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStream: + title: tt_PTZStream + type: object + properties: + PTZStatus: + type: array + items: + $ref: '#/components/schemas/tt_PTZStatus' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + type: array + items: + $ref: '#/components/schemas/tt_PTZStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStreamExtension: + title: tt_PTZStreamExtension + type: object + description: '' + xml: + name: PTZStreamExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventStream: + title: tt_EventStream + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Extension: + type: array + items: + $ref: '#/components/schemas/tt_EventStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EventStream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventStreamExtension: + title: tt_EventStreamExtension + type: object + description: '' + xml: + name: EventStreamExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xmime_base64Binary: + title: xmime_base64Binary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: base64Binary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + xmime_hexBinary: + title: xmime_hexBinary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: hexBinary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + soapenv_Envelope: + title: soapenv_Envelope + required: + - Body + type: object + properties: + Header: + allOf: + - $ref: '#/components/schemas/soapenv_Header' + - xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Body: + allOf: + - $ref: '#/components/schemas/soapenv_Body' + - xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: Envelope + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Header: + title: soapenv_Header + type: object + description: Elements replacing the wildcard MUST be namespace qualified, but can be in the targetNamespace + xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Body: + title: soapenv_Body + type: object + description: '' + xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Fault: + title: soapenv_Fault + required: + - Code + - Reason + type: object + properties: + Code: + allOf: + - $ref: '#/components/schemas/soapenv_faultcode' + - xml: + name: Code + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Reason: + allOf: + - $ref: '#/components/schemas/soapenv_faultreason' + - xml: + name: Reason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Node: + type: string + xml: + name: Node + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Role: + type: string + xml: + name: Role + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Detail: + allOf: + - $ref: '#/components/schemas/soapenv_detail' + - xml: + name: Detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: Fault reporting structure + xml: + name: Fault + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultreason: + title: soapenv_faultreason + required: + - Text + type: object + properties: + Text: + type: array + items: + $ref: '#/components/schemas/soapenv_reasontext' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultreason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_reasontext: + title: soapenv_reasontext + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: reasontext + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcode: + title: soapenv_faultcode + required: + - Value + type: object + properties: + Value: + allOf: + - $ref: '#/components/schemas/soapenv_faultcodeEnum' + - xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcodeEnum: + title: soapenv_faultcodeEnum + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + type: string + description: '' + xml: + name: faultcodeEnum + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_subcode: + title: soapenv_subcode + required: + - Value + type: object + properties: + Value: + type: string + xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_detail: + title: soapenv_detail + type: object + description: '' + xml: + name: detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_NotUnderstoodType: + title: soapenv_NotUnderstoodType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: NotUnderstoodType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_SupportedEnvType: + title: soapenv_SupportedEnvType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: SupportedEnvType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_UpgradeType: + title: soapenv_UpgradeType + required: + - SupportedEnvelope + type: object + properties: + SupportedEnvelope: + type: array + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: UpgradeType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + wsnt_QueryExpressionType: + title: wsnt_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_TopicExpressionType: + title: wsnt_TopicExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_FilterType: + title: wsnt_FilterType + type: object + description: '' + xml: + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicyType: + title: wsnt_SubscriptionPolicyType + type: object + description: '' + xml: + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationProducerRP: + title: wsnt_NotificationProducerRP + type: object + properties: + TopicExpression: + type: array + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + default: true + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsa_EndpointReferenceType: + title: wsa_EndpointReferenceType + required: + - Address + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsnt_SubscriptionManagerRP: + title: wsnt_SubscriptionManagerRP + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CreationTime: + type: string + format: date-time + xml: + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationMessageHolderType: + title: wsnt_NotificationMessageHolderType + required: + - Message + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Notify: + title: wsnt_Notify + required: + - NotificationMessage + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UseRaw: + title: wsnt_UseRaw + type: object + description: '' + xml: + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Subscribe: + title: wsnt_Subscribe + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeResponse: + title: wsnt_SubscribeResponse + required: + - SubscriptionReference + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessage: + title: wsnt_GetCurrentMessage + required: + - Topic + type: object + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessageResponse: + title: wsnt_GetCurrentMessageResponse + type: object + description: '' + xml: + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + title: wsnt_SubscribeCreationFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidFilterFaultType: + title: wsnt_InvalidFilterFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - UnknownFilter + type: object + properties: + UnknownFilter: + type: array + items: + type: string + xml: + name: UnknownFilter + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicExpressionDialectUnknownFaultType: + title: wsnt_TopicExpressionDialectUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidTopicExpressionFaultType: + title: wsnt_InvalidTopicExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicNotSupportedFaultType: + title: wsnt_TopicNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_MultipleTopicsSpecifiedFaultType: + title: wsnt_MultipleTopicsSpecifiedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidProducerPropertiesExpressionFaultType: + title: wsnt_InvalidProducerPropertiesExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidMessageContentExpressionFaultType: + title: wsnt_InvalidMessageContentExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnrecognizedPolicyRequestFaultType: + title: wsnt_UnrecognizedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnrecognizedPolicy: + type: array + items: + type: string + xml: + name: UnrecognizedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnsupportedPolicyRequestFaultType: + title: wsnt_UnsupportedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnsupportedPolicy: + type: array + items: + type: string + xml: + name: UnsupportedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NotifyMessageNotSupportedFaultType: + title: wsnt_NotifyMessageNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnacceptableInitialTerminationTimeFaultType: + title: wsnt_UnacceptableInitialTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NoCurrentMessageOnTopicFaultType: + title: wsnt_NoCurrentMessageOnTopicFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_GetMessages: + title: wsnt_GetMessages + type: object + properties: + MaximumNumber: + type: integer + format: int32 + xml: + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetMessagesResponse: + title: wsnt_GetMessagesResponse + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPoint: + title: wsnt_DestroyPullPoint + type: object + description: '' + xml: + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPointResponse: + title: wsnt_DestroyPullPointResponse + type: object + description: '' + xml: + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToGetMessagesFaultType: + title: wsnt_UnableToGetMessagesFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnableToDestroyPullPointFaultType: + title: wsnt_UnableToDestroyPullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_CreatePullPoint: + title: wsnt_CreatePullPoint + type: object + description: '' + xml: + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_CreatePullPointResponse: + title: wsnt_CreatePullPointResponse + required: + - PullPoint + type: object + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToCreatePullPointFaultType: + title: wsnt_UnableToCreatePullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Renew: + title: wsnt_Renew + required: + - TerminationTime + type: object + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_RenewResponse: + title: wsnt_RenewResponse + required: + - TerminationTime + type: object + properties: + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnacceptableTerminationTimeFaultType: + title: wsnt_UnacceptableTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Unsubscribe: + title: wsnt_Unsubscribe + type: object + description: '' + xml: + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnsubscribeResponse: + title: wsnt_UnsubscribeResponse + type: object + description: '' + xml: + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToDestroySubscriptionFaultType: + title: wsnt_UnableToDestroySubscriptionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_PauseSubscription: + title: wsnt_PauseSubscription + type: object + description: '' + xml: + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseSubscriptionResponse: + title: wsnt_PauseSubscriptionResponse + type: object + description: '' + xml: + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscription: + title: wsnt_ResumeSubscription + type: object + description: '' + xml: + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscriptionResponse: + title: wsnt_ResumeSubscriptionResponse + type: object + description: '' + xml: + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseFailedFaultType: + title: wsnt_PauseFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_ResumeFailedFaultType: + title: wsnt_ResumeFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xop_Include: + title: xop_Include + required: + - href + type: object + properties: + href: + type: string + xml: + name: href + prefix: xop + attribute: true + wrapped: false + description: '' + xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + fc_Gender: + title: fc_Gender + enum: + - Male + - Female + type: string + description: '' + xml: + name: Gender + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Complexion: + title: fc_Complexion + enum: + - White + - Black + - Asian + - Other + type: string + description: '' + xml: + name: Complexion + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_FacialShape: + title: fc_FacialShape + enum: + - Long + - Round + - Square + - Oval + - Other + type: string + description: '' + xml: + name: FacialShape + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Length: + title: fc_Length + enum: + - Long + - Medium + - Short + type: string + description: '' + xml: + name: Length + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_HairStyle: + title: fc_HairStyle + enum: + - Straight + - Wave + - Curly + - CrewCut + - Bald + - Ponytail + - Pigtail + - Other + type: string + description: '' + xml: + name: HairStyle + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Hair: + title: fc_Hair + type: object + properties: + Length: + type: string + 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. \r\n Medium 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." + xml: + name: Length + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Style: + type: string + description: Describe the style of the Hair, acceptable values are defined in fc:HairStyle. + xml: + name: Style + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the color of the Hair. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Bangs: + type: boolean + description: Describe the bangs of the Hair + xml: + name: Bangs + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: Hair + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_EyebrowWidth: + title: fc_EyebrowWidth + enum: + - Long + - Short + type: string + description: '' + xml: + name: EyebrowWidth + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_EyebrowSpace: + title: fc_EyebrowSpace + enum: + - Joint + - Separate + type: string + description: '' + xml: + name: EyebrowSpace + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Eyebrow: + title: fc_Eyebrow + type: object + properties: + Width: + type: string + description: >- + Describe the shape of the eyebrow, Short usually means that the width of eye brow is shorter than the length of eye. + + Long usually means that the width of eye brow is equal to or longer than the length of eye.acceptable values are defined in fc:EyebrowWidth. + xml: + name: Width + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the eyebrow. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Space: + type: string + description: Describe the space of two eyebrows, acceptable values are defined in fc:EyebrowSpace. + xml: + name: Space + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: Eyebrow + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_EyeShape: + title: fc_EyeShape + enum: + - Almond + - Slitty + - Round + - Other + type: string + description: '' + xml: + name: EyeShape + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Eyelid: + title: fc_Eyelid + enum: + - Single + - Double + - Other + type: string + description: '' + xml: + name: Eyelid + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Eyeball: + title: fc_Eyeball + enum: + - Black + - Blue + - Brown + - Gray + - Green + - Pink + - Other + type: string + description: '' + xml: + name: Eyeball + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Eye: + title: fc_Eye + type: object + properties: + Shape: + type: string + description: Describe the shape of the eye, acceptable values are defined in fc:EyeBrowShape. + xml: + name: Shape + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Eyelid: + type: string + description: Describe the eyelid of the eye, acceptable values are defined in fc:Eyelid. + xml: + name: Eyelid + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Eyeball: + type: string + description: Describe the eyeball of the eye, acceptable values are defined in fc:Eyeball. + xml: + name: Eyeball + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: Eye + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Ear: + title: fc_Ear + enum: + - Round + - Pointed + - Narrow + - BroadLobe + - Other + type: string + description: '' + xml: + name: Ear + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_NoseLength: + title: fc_NoseLength + enum: + - Short + - Long + type: string + description: '' + xml: + name: NoseLength + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_NoseBridge: + title: fc_NoseBridge + enum: + - Straight + - Arch + type: string + description: '' + xml: + name: NoseBridge + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_NoseWing: + title: fc_NoseWing + enum: + - Narrow + - Broad + type: string + description: '' + xml: + name: NoseWing + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_NoseEnd: + title: fc_NoseEnd + enum: + - Snub + - Turnedup + - Flat + - Hooked + - Other + type: string + description: '' + xml: + name: NoseEnd + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Nose: + title: fc_Nose + type: object + properties: + Length: + type: string + description: "Describe the length of the nose, acceptable values are defined in fc:NoseLength. \r\n Long usually means that the length of the nose is longer than 1/3 of the length of the face.\r\n short usually means that the length of the nose is shorter than 1/3 of the length of the face." + xml: + name: Length + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + NoseBridge: + type: string + description: Describe the bridge of the nose, acceptable values are defined in fc:NoseBridge. + xml: + name: NoseBridge + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + NoseWing: + type: string + description: Describe the wing of the nose, acceptable values are defined in fc:NoseWing. + xml: + name: NoseWing + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + NoseEnd: + type: string + description: Describe the end of the nose, acceptable values are defined in fc:NoseEnd. + xml: + name: NoseEnd + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: Nose + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_FacialHair: + title: fc_FacialHair + type: object + properties: + Mustache: + type: boolean + description: Describe if there is mustache on the face. + xml: + name: Mustache + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Beard: + type: boolean + description: Describe if there are Beard on the face. + xml: + name: Beard + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Sideburn: + type: boolean + description: Describe if there are sideburns on the face. + xml: + name: Sideburn + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: FacialHair + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Lip: + title: fc_Lip + enum: + - Full + - Medium + - Thin + type: string + description: '' + xml: + name: Lip + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Chin: + title: fc_Chin + enum: + - Double + - Pointed + - Round + type: string + description: '' + xml: + name: Chin + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Expression: + title: fc_Expression + enum: + - Natural + - Smile + - RaisedEyebrows + - Squint + - Frown + - Other + type: string + description: '' + xml: + name: Expression + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_PoseAngle: + title: fc_PoseAngle + type: object + properties: + PoseAngles: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Describe the pose angle of the face. + xml: + name: PoseAngles + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Uncertainty: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Describe the expected degree of uncertainty of the pose angle yaw, pitch, and roll. + xml: + name: Uncertainty + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: PoseAngle + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_AccessoryDescription: + title: fc_AccessoryDescription + type: object + properties: + Wear: + type: boolean + description: Describe if the object wear a accessory . + xml: + name: Wear + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the accessory. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: AccessoryDescription + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_Accessory: + title: fc_Accessory + type: object + properties: + Opticals: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear opticals. + xml: + name: Opticals + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Hat: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear hat. + xml: + name: Hat + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Mask: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear mask. + xml: + name: Mask + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Hijab: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear hijab. + xml: + name: Hijab + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Helmet: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear Helmet. + xml: + name: Helmet + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Kerchief: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear Kerchief. + xml: + name: Kerchief + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + RightEyePatch: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if there is a patch on the right eye. + xml: + name: RightEyePatch + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + LeftEyePatch: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if there is a patch on the left eye. + xml: + name: LeftEyePatch + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: Accessory + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_FrecklesType: + title: fc_FrecklesType + enum: + - AroundCheek + - Nose + - forehead + - Other + type: string + description: '' + xml: + name: FrecklesType + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_AdditionalFeatures: + title: fc_AdditionalFeatures + type: object + properties: + Scar: + type: boolean + description: Is there scar on the face. + xml: + name: Scar + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Mole: + type: boolean + description: Is there mole on the face. + xml: + name: Mole + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Tattoo: + type: boolean + description: Is there Tattoo on the face. + xml: + name: Tattoo + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Freckles: + type: string + description: Describe freckles on the face, acceptable values are defined in fc:FrecklesType. + xml: + name: Freckles + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: AdditionalFeatures + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + fc_HumanFace: + title: fc_HumanFace + type: object + properties: + Age: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Describe the age of the face. + xml: + name: Age + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Gender: + type: string + description: Describe the gender of the face, acceptable values are defined in fc:Gender. + xml: + name: Gender + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Temperature: + type: number + description: Describe the temperature of the face, in Kelvin. + xml: + name: Temperature + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Complexion: + type: string + description: Describe the complexion of the face, acceptable values are defined in fc:Complexion. + xml: + name: Complexion + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + FacialShape: + type: string + description: Describe the FacialShape, acceptable values are defined fc:FacialShape. + xml: + name: FacialShape + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Hair: + allOf: + - $ref: '#/components/schemas/fc_Hair' + - description: Describe the hair of the face. + xml: + name: Hair + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Eyebrow: + allOf: + - $ref: '#/components/schemas/fc_Eyebrow' + - description: Describe the eyebrow of the face. + xml: + name: Eyebrow + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Eye: + allOf: + - $ref: '#/components/schemas/fc_Eye' + - description: Describe the eye of the face. + xml: + name: Eye + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Ear: + allOf: + - $ref: '#/components/schemas/fc_Ear' + - description: Describe the Ear of the face. + xml: + name: Ear + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Nose: + allOf: + - $ref: '#/components/schemas/fc_Nose' + - description: Describe the nose of the face. + xml: + name: Nose + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + FacialHair: + allOf: + - $ref: '#/components/schemas/fc_FacialHair' + - description: Describe the facial hair of the face. + xml: + name: FacialHair + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Lip: + type: string + description: Describe the lip of the face, acceptable values are defined in fc:Lip. + xml: + name: Lip + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Chin: + type: string + description: Describe the Chin of the face, acceptable values are defined in fc:Chin. + xml: + name: Chin + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Expression: + type: string + description: Describe the expression on the face, acceptable values are defined in fc:Expression. + xml: + name: Expression + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + PoseAngle: + allOf: + - $ref: '#/components/schemas/fc_PoseAngle' + - description: Describe the pose angle of the face. + xml: + name: PoseAngle + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + Accessory: + allOf: + - $ref: '#/components/schemas/fc_Accessory' + - description: Describe the Accessory of the face. + xml: + name: Accessory + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + AdditionalFeatures: + allOf: + - $ref: '#/components/schemas/fc_AdditionalFeatures' + - description: Describe the other features, eg scar, mole etc of the face. + xml: + name: AdditionalFeatures + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + description: '' + xml: + name: HumanFace + namespace: http://www.onvif.org/ver20/analytics/humanface + prefix: fc + attribute: false + wrapped: false + bd_BodyShape: + title: bd_BodyShape + enum: + - Fat + - Thin + - Other + type: string + description: '' + xml: + name: BodyShape + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_BodyMetric: + title: bd_BodyMetric + type: object + properties: + Height: + type: integer + description: Describe the Stature of the body, the unit is centimeter. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + BodyShape: + type: string + description: Describle the Shape of the body, acceptable values are defined in bd:BodyShape. + xml: + name: BodyShape + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: BodyMetric + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Scarf: + title: bd_Scarf + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Scarf, acceptable values are defined in ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Wear: + type: boolean + description: Describe if the body wears the Scarf. + xml: + name: Wear + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Scarf + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Gloves: + title: bd_Gloves + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of Gloves, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Wear: + type: boolean + description: Describe if the body wears Gloves. + xml: + name: Wear + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Gloves + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_TopsCategory: + title: bd_TopsCategory + enum: + - LongSleeve + - ShortSleeve + - Other + type: string + description: '' + xml: + name: TopsCategory + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Grain: + title: bd_Grain + enum: + - Stria + - Plaid + - PureColour + - Decal + - Other + type: string + description: '' + xml: + name: Grain + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_TopsStyle: + title: bd_TopsStyle + enum: + - Tailor + - Jacket + - Sweater + - Overcoat + - Dress + - Other + type: string + description: '' + xml: + name: TopsStyle + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Tops: + title: bd_Tops + type: object + properties: + Category: + type: string + description: Describe the Category of the Tops, acceptable values are defined in bd:TopsCategory. + xml: + name: Category + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Tops, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Grain: + type: string + description: Describe the Grain of the Tops, acceptable values are defined in bd:Grain. + xml: + name: Grain + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Style: + type: string + description: Describe the Style of the Tops, acceptable values are defined in bd:TopsStyle. + xml: + name: Style + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Tops + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_BottomsCategory: + title: bd_BottomsCategory + enum: + - Trousers + - Shorts + - Skirt + - Other + type: string + description: '' + xml: + name: BottomsCategory + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_BottomsStyle: + title: bd_BottomsStyle + enum: + - FornalPants + - Jeans + - Other + type: string + description: '' + xml: + name: BottomsStyle + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Bottoms: + title: bd_Bottoms + type: object + properties: + Category: + type: string + description: Describe the Category of the Bottoms, acceptable values are defined in bd:BottomsCategory. + xml: + name: Category + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Bottoms, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Grain: + type: string + description: Describe the Grain of the Bottoms, acceptable values are defined in bd:Grain. + xml: + name: Grain + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Style: + type: string + description: Describe the Style of the Bottoms, acceptable values are defined in bd:BottomsStyle. + xml: + name: Style + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Bottoms + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_ShoesCategory: + title: bd_ShoesCategory + enum: + - LeatherShoes + - Sneakers + - Sandal + - Slipper + - Other + type: string + description: '' + xml: + name: ShoesCategory + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Shoes: + title: bd_Shoes + type: object + properties: + Category: + type: string + description: Describe the Category of the Shoes, acceptable values are defined in bd:ShoesCategory. + xml: + name: Category + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Shoes, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Shoes + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Clothing: + title: bd_Clothing + type: object + properties: + Scarf: + allOf: + - $ref: '#/components/schemas/bd_Scarf' + - description: Describe the Scarf of the body,acceptable values are defined in bd:Scarf. + xml: + name: Scarf + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Gloves: + allOf: + - $ref: '#/components/schemas/bd_Gloves' + - description: Describe Gloves of the body,acceptable values are defined in bd:Gloves. + xml: + name: Gloves + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Tops: + allOf: + - $ref: '#/components/schemas/bd_Tops' + - description: Describe the Tops of the body,acceptable values are defined in bd:Tops. + xml: + name: Tops + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Bottoms: + allOf: + - $ref: '#/components/schemas/bd_Bottoms' + - description: Describe the Bottoms of the body,acceptable values are defined in bd:Bottoms. + xml: + name: Bottoms + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Shoes: + allOf: + - $ref: '#/components/schemas/bd_Shoes' + - description: Describe the Shoes of the body,acceptable values are defined in bd:Shoes. + xml: + name: Shoes + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Clothing + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_KnapsackCategory: + title: bd_KnapsackCategory + enum: + - SingleShoulderBag + - Backpack + - Other + type: string + description: '' + xml: + name: KnapsackCategory + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Bag: + title: bd_Bag + type: object + properties: + Category: + type: string + description: Describe the Category of the Bag, acceptable values are defined in bd:KnapsackCategory. + xml: + name: Category + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Colour of the Bag, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Bag + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Umbrella: + title: bd_Umbrella + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Bag, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Open: + type: boolean + description: Describe if the body Opens the Umbrella. + xml: + name: Open + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Umbrella + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Box: + title: bd_Box + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Box, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Lug: + type: boolean + description: Describe if the body Lugs the Box. + xml: + name: Lug + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Box + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_CartCategory: + title: bd_CartCategory + enum: + - BabyCarriage + - TwoWheelVehicle + - Tricyle + - Other + type: string + description: '' + xml: + name: CartCategory + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Cart: + title: bd_Cart + type: object + properties: + Category: + type: string + description: Describe the Category of the Cart, acceptable values are defined in bd:CartCategory. + xml: + name: Category + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorDescriptor' + - description: Describe the Color of the Cart, acceptable values are defined in tt:ColorDescriptor. + xml: + name: Color + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Cart + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Belonging: + title: bd_Belonging + type: object + properties: + Bag: + allOf: + - $ref: '#/components/schemas/bd_Bag' + - description: Describe the Bag of the body,acceptable values are defined in bd:Bag + xml: + name: Bag + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Umbrella: + allOf: + - $ref: '#/components/schemas/bd_Umbrella' + - description: Describe the Umbrella carried by the body,acceptable values are defined in bd:Umbrella. + xml: + name: Umbrella + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + LiftSomething: + type: boolean + description: Describe if the body Lifts something. + xml: + name: LiftSomething + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Box: + allOf: + - $ref: '#/components/schemas/bd_Box' + - description: Describe the Box luffed by the body,acceptable values are defined in bd:Box. + xml: + name: Box + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Cart: + allOf: + - $ref: '#/components/schemas/bd_Cart' + - description: Describe the Cart pushed by the body,acceptable values are defined in bd:Cart. + xml: + name: Cart + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Weapon: + type: boolean + description: Describe if the body carries the Weapon. + xml: + name: Weapon + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Belonging + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Smoking: + title: bd_Smoking + enum: + - NoSmoking + - Cigar + - ElectronicCigarettes + - Other + type: string + description: '' + xml: + name: Smoking + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_UsingMobile: + title: bd_UsingMobile + enum: + - ByLeftHand + - ByRightHand + - Other + type: string + description: '' + xml: + name: UsingMobile + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_HumanActivity: + title: bd_HumanActivity + enum: + - Walking + - Running + - Fallen + - Squatting + - Sitting + - Standing + - Driving + - Other + type: string + description: '' + xml: + name: HumanActivity + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_Behaviour: + title: bd_Behaviour + type: object + properties: + Smoking: + type: string + description: Acceptable values are defined in bd:Smoking. + xml: + name: Smoking + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + UsingMobile: + type: string + description: Acceptable values are defined in bd:UsingMobile. + xml: + name: UsingMobile + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Activity: + type: string + description: Describe the activity of the body, Acceptable values are defined in bd:HumanActivity. + xml: + name: Activity + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: Behaviour + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + bd_HumanBody: + title: bd_HumanBody + type: object + properties: + BodyMetric: + allOf: + - $ref: '#/components/schemas/bd_BodyMetric' + - description: Describe the body metric of the body. + xml: + name: BodyMetric + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Clothing: + allOf: + - $ref: '#/components/schemas/bd_Clothing' + - description: Describe the Clothing of the body. + xml: + name: Clothing + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Belonging: + allOf: + - $ref: '#/components/schemas/bd_Belonging' + - description: Describe the Belonging of the body. + xml: + name: Belonging + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + Behaviour: + allOf: + - $ref: '#/components/schemas/bd_Behaviour' + - description: Describe the Behaviour of the body. + xml: + name: Behaviour + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + description: '' + xml: + name: HumanBody + namespace: http://www.onvif.org/ver20/analytics/humanbody + prefix: bd + attribute: false + wrapped: false + wsa_ReferenceParametersType: + title: wsa_ReferenceParametersType + type: object + description: '' + xml: + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_MetadataType: + title: wsa_MetadataType + type: object + description: '' + xml: + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedURIType: + title: wsa_AttributedURIType + type: object + description: '' + xml: + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelatesToType: + title: wsa_RelatesToType + type: object + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + name: RelationshipType + attribute: true + wrapped: false + description: '' + xml: + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelationshipTypeOpenEnum: + title: wsa_RelationshipTypeOpenEnum + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + description: '' + xml: + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_FaultCodesOpenEnumType: + title: wsa_FaultCodesOpenEnumType + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + description: '' + xml: + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedQNameType: + title: wsa_AttributedQNameType + type: object + description: '' + xml: + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedAnyType: + title: wsa_AttributedAnyType + type: object + description: '' + xml: + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ProblemActionType: + title: wsa_ProblemActionType + type: object + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + SoapAction: + type: string + xml: + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsrf-bf_BaseFaultType: + title: wsrf-bf_BaseFaultType + required: + - Timestamp + type: object + properties: + Timestamp: + type: string + format: date-time + xml: + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Description: + type: array + items: + $ref: '#/components/schemas/wsrf-bf_Description' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + description: '' + xml: + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Documentation: + title: wstop_Documentation + type: object + description: '' + xml: + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_ExtensibleDocumented: + title: wstop_ExtensibleDocumented + type: object + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_QueryExpressionType: + title: wstop_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_TopicNamespaceType: + title: wstop_TopicNamespaceType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - targetNamespace + type: object + properties: + Topic: + type: array + items: + $ref: '#/components/schemas/wstop_Topic' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + name: + type: string + xml: + name: name + attribute: true + wrapped: false + targetNamespace: + type: string + xml: + name: targetNamespace + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + name: final + attribute: true + wrapped: false + xml: + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicType: + title: wstop_TopicType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - name + type: object + properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - {} + name: + type: string + xml: + attribute: true + wrapped: false + messageTypes: + type: array + items: + type: string + description: '' + xml: + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + attribute: true + wrapped: false + xml: + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicSetType: + title: wstop_TopicSetType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + Choice0: + title: Choice0 + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice1: + title: Choice1 + type: object + properties: + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice01: + title: Choice01 + type: object + properties: + VideoAnalytics: + type: array + items: + oneOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsStreamChoice0' + - $ref: '#/components/schemas/tt_VideoAnalyticsStreamChoice1' + - $ref: '#/components/schemas/tt_VideoAnalyticsStreamChoice2' + xml: + name: VideoAnalytics + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice2: + title: Choice2 + type: object + properties: + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice3: + title: Choice3 + type: object + properties: + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice4: + title: Choice4 + type: object + Choice11: + title: Choice11 + type: object + properties: + PTZ: + type: array + items: + oneOf: + - $ref: '#/components/schemas/tt_PTZStreamChoice0' + - $ref: '#/components/schemas/tt_PTZStreamChoice1' + - $ref: '#/components/schemas/tt_PTZStreamChoice2' + xml: + name: PTZ + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice21: + title: Choice21 + type: object + properties: + Event: + type: array + items: + oneOf: + - $ref: '#/components/schemas/tt_EventStreamChoice0' + - $ref: '#/components/schemas/tt_EventStreamChoice1' + - $ref: '#/components/schemas/tt_EventStreamChoice2' + xml: + name: Event + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice31: + title: Choice31 + type: object + properties: + Extension: + type: array + items: + $ref: '#/components/schemas/tt_MetadataStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CreateAnalyticsModulesRequest: + title: CreateAnalyticsModulesRequest + required: + - CreateAnalyticsModules + type: object + properties: + CreateAnalyticsModules: + allOf: + - $ref: '#/components/schemas/tns_CreateAnalyticsModules' + - {} + CreateAnalyticsModulesResponse: + title: CreateAnalyticsModulesResponse + required: + - CreateAnalyticsModulesResponse + type: object + properties: + CreateAnalyticsModulesResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateAnalyticsModulesResponse' + - xml: + name: CreateAnalyticsModulesResponse + attribute: false + wrapped: false + xml: + name: CreateAnalyticsModulesResponse + attribute: false + wrapped: false + CreateRulesRequest: + title: CreateRulesRequest + required: + - CreateRules + type: object + properties: + CreateRules: + allOf: + - $ref: '#/components/schemas/tns_CreateRules' + - {} + CreateRulesResponse: + title: CreateRulesResponse + required: + - CreateRulesResponse + type: object + properties: + CreateRulesResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateRulesResponse' + - xml: + name: CreateRulesResponse + attribute: false + wrapped: false + xml: + name: CreateRulesResponse + attribute: false + wrapped: false + DeleteAnalyticsModulesRequest: + title: DeleteAnalyticsModulesRequest + required: + - DeleteAnalyticsModules + type: object + properties: + DeleteAnalyticsModules: + allOf: + - $ref: '#/components/schemas/tns_DeleteAnalyticsModules' + - {} + DeleteAnalyticsModulesResponse: + title: DeleteAnalyticsModulesResponse + required: + - DeleteAnalyticsModulesResponse + type: object + properties: + DeleteAnalyticsModulesResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteAnalyticsModulesResponse' + - xml: + name: DeleteAnalyticsModulesResponse + attribute: false + wrapped: false + xml: + name: DeleteAnalyticsModulesResponse + attribute: false + wrapped: false + DeleteRulesRequest: + title: DeleteRulesRequest + required: + - DeleteRules + type: object + properties: + DeleteRules: + allOf: + - $ref: '#/components/schemas/tns_DeleteRules' + - {} + DeleteRulesResponse: + title: DeleteRulesResponse + required: + - DeleteRulesResponse + type: object + properties: + DeleteRulesResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteRulesResponse' + - xml: + name: DeleteRulesResponse + attribute: false + wrapped: false + xml: + name: DeleteRulesResponse + attribute: false + wrapped: false + GetAnalyticsModuleOptionsRequest: + title: GetAnalyticsModuleOptionsRequest + required: + - GetAnalyticsModuleOptions + type: object + properties: + GetAnalyticsModuleOptions: + allOf: + - $ref: '#/components/schemas/tns_GetAnalyticsModuleOptions' + - {} + GetAnalyticsModuleOptionsResponse: + title: GetAnalyticsModuleOptionsResponse + required: + - GetAnalyticsModuleOptionsResponse + type: object + properties: + GetAnalyticsModuleOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAnalyticsModuleOptionsResponse' + - xml: + name: GetAnalyticsModuleOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAnalyticsModuleOptionsResponse + attribute: false + wrapped: false + GetAnalyticsModulesRequest: + title: GetAnalyticsModulesRequest + required: + - GetAnalyticsModules + type: object + properties: + GetAnalyticsModules: + allOf: + - $ref: '#/components/schemas/tns_GetAnalyticsModules' + - {} + GetAnalyticsModulesResponse: + title: GetAnalyticsModulesResponse + required: + - GetAnalyticsModulesResponse + type: object + properties: + GetAnalyticsModulesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAnalyticsModulesResponse' + - xml: + name: GetAnalyticsModulesResponse + attribute: false + wrapped: false + xml: + name: GetAnalyticsModulesResponse + attribute: false + wrapped: false + GetRuleOptionsRequest: + title: GetRuleOptionsRequest + required: + - GetRuleOptions + type: object + properties: + GetRuleOptions: + allOf: + - $ref: '#/components/schemas/tns_GetRuleOptions' + - {} + GetRuleOptionsResponse: + title: GetRuleOptionsResponse + required: + - GetRuleOptionsResponse + type: object + properties: + GetRuleOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetRuleOptionsResponse' + - xml: + name: GetRuleOptionsResponse + attribute: false + wrapped: false + xml: + name: GetRuleOptionsResponse + attribute: false + wrapped: false + GetRulesRequest: + title: GetRulesRequest + required: + - GetRules + type: object + properties: + GetRules: + allOf: + - $ref: '#/components/schemas/tns_GetRules' + - {} + GetRulesResponse: + title: GetRulesResponse + required: + - GetRulesResponse + type: object + properties: + GetRulesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetRulesResponse' + - xml: + name: GetRulesResponse + attribute: false + wrapped: false + xml: + name: GetRulesResponse + attribute: false + wrapped: false + GetServiceCapabilitiesRequest: + title: GetServiceCapabilitiesRequest + required: + - GetServiceCapabilities + type: object + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + GetServiceCapabilitiesResponse: + title: GetServiceCapabilitiesResponse + required: + - GetServiceCapabilitiesResponse + type: object + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + GetSupportedAnalyticsModulesRequest: + title: GetSupportedAnalyticsModulesRequest + required: + - GetSupportedAnalyticsModules + type: object + properties: + GetSupportedAnalyticsModules: + allOf: + - $ref: '#/components/schemas/tns_GetSupportedAnalyticsModules' + - {} + GetSupportedAnalyticsModulesResponse: + title: GetSupportedAnalyticsModulesResponse + required: + - GetSupportedAnalyticsModulesResponse + type: object + properties: + GetSupportedAnalyticsModulesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSupportedAnalyticsModulesResponse' + - xml: + name: GetSupportedAnalyticsModulesResponse + attribute: false + wrapped: false + xml: + name: GetSupportedAnalyticsModulesResponse + attribute: false + wrapped: false + GetSupportedMetadataRequest: + title: GetSupportedMetadataRequest + required: + - GetSupportedMetadata + type: object + properties: + GetSupportedMetadata: + allOf: + - $ref: '#/components/schemas/tns_GetSupportedMetadata' + - {} + GetSupportedMetadataResponse: + title: GetSupportedMetadataResponse + required: + - GetSupportedMetadataResponse + type: object + properties: + GetSupportedMetadataResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSupportedMetadataResponse' + - xml: + name: GetSupportedMetadataResponse + attribute: false + wrapped: false + xml: + name: GetSupportedMetadataResponse + attribute: false + wrapped: false + GetSupportedRulesRequest: + title: GetSupportedRulesRequest + required: + - GetSupportedRules + type: object + properties: + GetSupportedRules: + allOf: + - $ref: '#/components/schemas/tns_GetSupportedRules' + - {} + GetSupportedRulesResponse: + title: GetSupportedRulesResponse + required: + - GetSupportedRulesResponse + type: object + properties: + GetSupportedRulesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSupportedRulesResponse' + - xml: + name: GetSupportedRulesResponse + attribute: false + wrapped: false + xml: + name: GetSupportedRulesResponse + attribute: false + wrapped: false + ModifyAnalyticsModulesRequest: + title: ModifyAnalyticsModulesRequest + required: + - ModifyAnalyticsModules + type: object + properties: + ModifyAnalyticsModules: + allOf: + - $ref: '#/components/schemas/tns_ModifyAnalyticsModules' + - {} + ModifyAnalyticsModulesResponse: + title: ModifyAnalyticsModulesResponse + required: + - ModifyAnalyticsModulesResponse + type: object + properties: + ModifyAnalyticsModulesResponse: + allOf: + - $ref: '#/components/schemas/tns_ModifyAnalyticsModulesResponse' + - xml: + name: ModifyAnalyticsModulesResponse + attribute: false + wrapped: false + xml: + name: ModifyAnalyticsModulesResponse + attribute: false + wrapped: false + ModifyRulesRequest: + title: ModifyRulesRequest + required: + - ModifyRules + type: object + properties: + ModifyRules: + allOf: + - $ref: '#/components/schemas/tns_ModifyRules' + - {} + ModifyRulesResponse: + title: ModifyRulesResponse + required: + - ModifyRulesResponse + type: object + properties: + ModifyRulesResponse: + allOf: + - $ref: '#/components/schemas/tns_ModifyRulesResponse' + - xml: + name: ModifyRulesResponse + attribute: false + wrapped: false + xml: + name: ModifyRulesResponse + attribute: false + wrapped: false + tns1_space: + title: tns1_space + enum: + - default + - preserve + type: string + description: '' + xml: + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + attribute: false + wrapped: false + tt_ClassCandidate: + title: tt_ClassCandidate + required: + - Type + - Likelihood + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_ClassType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorCluster: + title: tt_ColorCluster + required: + - Color + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Weight: + type: number + xml: + name: Weight + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Covariance: + allOf: + - $ref: '#/components/schemas/tt_ColorCovariance' + - xml: + name: Covariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorCluster + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice0: + title: tt_ColorOptionsChoice0 + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice1: + title: tt_ColorOptionsChoice1 + type: object + properties: + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItem: + title: tt_ElementItem + required: + - Name + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + description: Complex value structure. + xml: + name: ElementItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItemDescription: + title: tt_ElementItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: The type of the item. The Type must reference a defined type. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a complex type. The Type must reference a defined type. + xml: + name: ElementItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventStreamChoice0: + title: tt_EventStreamChoice0 + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + tt_EventStreamChoice1: + title: tt_EventStreamChoice1 + type: object + properties: + Extension: + type: array + items: + $ref: '#/components/schemas/tt_EventStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventStreamChoice2: + title: tt_EventStreamChoice2 + type: object + tt_Idle: + title: tt_Idle + type: object + description: '' + xml: + name: Idle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Messages: + title: tt_Messages + allOf: + - $ref: '#/components/schemas/tt_MessageDescription' + - required: + - ParentTopic + type: object + properties: + ParentTopic: + type: string + description: The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected. + xml: + name: ParentTopic + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Messages + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + tt_PTZStreamChoice0: + title: tt_PTZStreamChoice0 + type: object + properties: + PTZStatus: + type: array + items: + $ref: '#/components/schemas/tt_PTZStatus' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStreamChoice1: + title: tt_PTZStreamChoice1 + type: object + properties: + Extension: + type: array + items: + $ref: '#/components/schemas/tt_PTZStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStreamChoice2: + title: tt_PTZStreamChoice2 + type: object + tt_Removed: + title: tt_Removed + type: object + description: '' + xml: + name: Removed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SimpleItem: + title: tt_SimpleItem + required: + - Name + - Value + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Value: + type: string + description: Item value. The type is defined in the corresponding description. + xml: + name: Value + prefix: tt + attribute: true + wrapped: false + description: Value name pair as defined by the corresponding description. + xml: + name: SimpleItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SimpleItemDescription: + title: tt_SimpleItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + name: SimpleItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SubscriptionPolicy: + title: tt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAnalyticsStreamChoice0: + title: tt_VideoAnalyticsStreamChoice0 + type: object + properties: + Frame: + type: array + items: + $ref: '#/components/schemas/tt_Frame' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAnalyticsStreamChoice1: + title: tt_VideoAnalyticsStreamChoice1 + type: object + properties: + Extension: + type: array + items: + $ref: '#/components/schemas/tt_VideoAnalyticsStreamExtension' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAnalyticsStreamChoice2: + title: tt_VideoAnalyticsStreamChoice2 + type: object + wsnt_Message: + title: wsnt_Message + type: object + description: '' + xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicy: + title: wsnt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsrf-bf_Description: + title: wsrf-bf_Description + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_ErrorCode: + title: wsrf-bf_ErrorCode + required: + - dialect + type: object + properties: + dialect: + type: string + xml: + name: dialect + attribute: true + wrapped: false + description: '' + xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_FaultCause: + title: wsrf-bf_FaultCause + type: object + description: '' + xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Topic: + title: wstop_Topic + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - type: object + properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + name: parent + attribute: true + wrapped: false + xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object +tags: +- name: RuleEngineBinding + description: '' +- name: AnalyticsEngineBinding + description: '' diff --git a/doc/openapi/ref/device.yaml b/doc/openapi/ref/device.yaml new file mode 100644 index 00000000..16dc68a9 --- /dev/null +++ b/doc/openapi/ref/device.yaml @@ -0,0 +1,31544 @@ +openapi: 3.0.0 +components: + schemas: + AddIPAddressFilterRequest: + properties: + AddIPAddressFilter: + allOf: + - $ref: '#/components/schemas/tns_AddIPAddressFilter' + - {} + required: + - AddIPAddressFilter + title: AddIPAddressFilterRequest + type: object + AddIPAddressFilterResponse: + properties: + AddIPAddressFilterResponse: + allOf: + - $ref: '#/components/schemas/tns_AddIPAddressFilterResponse' + - xml: + attribute: false + name: AddIPAddressFilterResponse + wrapped: false + required: + - AddIPAddressFilterResponse + title: AddIPAddressFilterResponse + type: object + xml: + attribute: false + name: AddIPAddressFilterResponse + wrapped: false + AddScopesRequest: + properties: + AddScopes: + allOf: + - $ref: '#/components/schemas/tns_AddScopes' + - {} + required: + - AddScopes + title: AddScopesRequest + type: object + AddScopesResponse: + properties: + AddScopesResponse: + allOf: + - $ref: '#/components/schemas/tns_AddScopesResponse' + - xml: + attribute: false + name: AddScopesResponse + wrapped: false + required: + - AddScopesResponse + title: AddScopesResponse + type: object + xml: + attribute: false + name: AddScopesResponse + wrapped: false + Choice0: + properties: + PresetToken: + description: Option to specify the preset position with Preset Token defined + in advance. + maxLength: 64 + type: string + xml: + attribute: false + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: Choice0 + type: object + Choice1: + properties: + Home: + 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. + type: boolean + xml: + attribute: false + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: Choice1 + type: object + Choice2: + properties: + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ + node directly. + xml: + attribute: false + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: Choice2 + type: object + Choice3: + properties: + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + attribute: false + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: Choice3 + type: object + CreateCertificateRequest: + properties: + CreateCertificate: + allOf: + - $ref: '#/components/schemas/tns_CreateCertificate' + - {} + required: + - CreateCertificate + title: CreateCertificateRequest + type: object + CreateCertificateResponse: + properties: + CreateCertificateResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateCertificateResponse' + - xml: + attribute: false + name: CreateCertificateResponse + wrapped: false + required: + - CreateCertificateResponse + title: CreateCertificateResponse + type: object + xml: + attribute: false + name: CreateCertificateResponse + wrapped: false + CreateDot1XConfigurationRequest: + properties: + CreateDot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tns_CreateDot1XConfiguration' + - {} + required: + - CreateDot1XConfiguration + title: CreateDot1XConfigurationRequest + type: object + CreateDot1XConfigurationResponse: + properties: + CreateDot1XConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateDot1XConfigurationResponse' + - xml: + attribute: false + name: CreateDot1XConfigurationResponse + wrapped: false + required: + - CreateDot1XConfigurationResponse + title: CreateDot1XConfigurationResponse + type: object + xml: + attribute: false + name: CreateDot1XConfigurationResponse + wrapped: false + CreateStorageConfigurationRequest: + properties: + CreateStorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_CreateStorageConfiguration' + - {} + required: + - CreateStorageConfiguration + title: CreateStorageConfigurationRequest + type: object + CreateStorageConfigurationResponse: + properties: + CreateStorageConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateStorageConfigurationResponse' + - xml: + attribute: false + name: CreateStorageConfigurationResponse + wrapped: false + required: + - CreateStorageConfigurationResponse + title: CreateStorageConfigurationResponse + type: object + xml: + attribute: false + name: CreateStorageConfigurationResponse + wrapped: false + CreateUsersRequest: + properties: + CreateUsers: + allOf: + - $ref: '#/components/schemas/tns_CreateUsers' + - {} + required: + - CreateUsers + title: CreateUsersRequest + type: object + CreateUsersResponse: + properties: + CreateUsersResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateUsersResponse' + - xml: + attribute: false + name: CreateUsersResponse + wrapped: false + required: + - CreateUsersResponse + title: CreateUsersResponse + type: object + xml: + attribute: false + name: CreateUsersResponse + wrapped: false + DeleteCertificatesRequest: + properties: + DeleteCertificates: + allOf: + - $ref: '#/components/schemas/tns_DeleteCertificates' + - {} + required: + - DeleteCertificates + title: DeleteCertificatesRequest + type: object + DeleteCertificatesResponse: + properties: + DeleteCertificatesResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteCertificatesResponse' + - xml: + attribute: false + name: DeleteCertificatesResponse + wrapped: false + required: + - DeleteCertificatesResponse + title: DeleteCertificatesResponse + type: object + xml: + attribute: false + name: DeleteCertificatesResponse + wrapped: false + DeleteDot1XConfigurationRequest: + properties: + DeleteDot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tns_DeleteDot1XConfiguration' + - {} + required: + - DeleteDot1XConfiguration + title: DeleteDot1XConfigurationRequest + type: object + DeleteDot1XConfigurationResponse: + properties: + DeleteDot1XConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteDot1XConfigurationResponse' + - xml: + attribute: false + name: DeleteDot1XConfigurationResponse + wrapped: false + required: + - DeleteDot1XConfigurationResponse + title: DeleteDot1XConfigurationResponse + type: object + xml: + attribute: false + name: DeleteDot1XConfigurationResponse + wrapped: false + DeleteGeoLocationRequest: + properties: + DeleteGeoLocation: + allOf: + - $ref: '#/components/schemas/tns_DeleteGeoLocation' + - {} + required: + - DeleteGeoLocation + title: DeleteGeoLocationRequest + type: object + DeleteGeoLocationResponse: + properties: + DeleteGeoLocationResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteGeoLocationResponse' + - xml: + attribute: false + name: DeleteGeoLocationResponse + wrapped: false + required: + - DeleteGeoLocationResponse + title: DeleteGeoLocationResponse + type: object + xml: + attribute: false + name: DeleteGeoLocationResponse + wrapped: false + DeleteStorageConfigurationRequest: + properties: + DeleteStorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_DeleteStorageConfiguration' + - {} + required: + - DeleteStorageConfiguration + title: DeleteStorageConfigurationRequest + type: object + DeleteStorageConfigurationResponse: + properties: + DeleteStorageConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteStorageConfigurationResponse' + - xml: + attribute: false + name: DeleteStorageConfigurationResponse + wrapped: false + required: + - DeleteStorageConfigurationResponse + title: DeleteStorageConfigurationResponse + type: object + xml: + attribute: false + name: DeleteStorageConfigurationResponse + wrapped: false + DeleteUsersRequest: + properties: + DeleteUsers: + allOf: + - $ref: '#/components/schemas/tns_DeleteUsers' + - {} + required: + - DeleteUsers + title: DeleteUsersRequest + type: object + DeleteUsersResponse: + properties: + DeleteUsersResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteUsersResponse' + - xml: + attribute: false + name: DeleteUsersResponse + wrapped: false + required: + - DeleteUsersResponse + title: DeleteUsersResponse + type: object + xml: + attribute: false + name: DeleteUsersResponse + wrapped: false + GetAccessPolicyRequest: + properties: + GetAccessPolicy: + allOf: + - $ref: '#/components/schemas/tns_GetAccessPolicy' + - {} + required: + - GetAccessPolicy + title: GetAccessPolicyRequest + type: object + GetAccessPolicyResponse: + properties: + GetAccessPolicyResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAccessPolicyResponse' + - xml: + attribute: false + name: GetAccessPolicyResponse + wrapped: false + required: + - GetAccessPolicyResponse + title: GetAccessPolicyResponse + type: object + xml: + attribute: false + name: GetAccessPolicyResponse + wrapped: false + GetAuthFailureWarningConfigurationRequest: + properties: + GetAuthFailureWarningConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetAuthFailureWarningConfiguration' + - {} + required: + - GetAuthFailureWarningConfiguration + title: GetAuthFailureWarningConfigurationRequest + type: object + GetAuthFailureWarningConfigurationResponse: + properties: + GetAuthFailureWarningConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAuthFailureWarningConfigurationResponse' + - xml: + attribute: false + name: GetAuthFailureWarningConfigurationResponse + wrapped: false + required: + - GetAuthFailureWarningConfigurationResponse + title: GetAuthFailureWarningConfigurationResponse + type: object + xml: + attribute: false + name: GetAuthFailureWarningConfigurationResponse + wrapped: false + GetAuthFailureWarningOptionsRequest: + properties: + GetAuthFailureWarningOptions: + allOf: + - $ref: '#/components/schemas/tns_GetAuthFailureWarningOptions' + - {} + required: + - GetAuthFailureWarningOptions + title: GetAuthFailureWarningOptionsRequest + type: object + GetAuthFailureWarningOptionsResponse: + properties: + GetAuthFailureWarningOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAuthFailureWarningOptionsResponse' + - xml: + attribute: false + name: GetAuthFailureWarningOptionsResponse + wrapped: false + required: + - GetAuthFailureWarningOptionsResponse + title: GetAuthFailureWarningOptionsResponse + type: object + xml: + attribute: false + name: GetAuthFailureWarningOptionsResponse + wrapped: false + GetCACertificatesRequest: + properties: + GetCACertificates: + allOf: + - $ref: '#/components/schemas/tns_GetCACertificates' + - {} + required: + - GetCACertificates + title: GetCACertificatesRequest + type: object + GetCACertificatesResponse: + properties: + GetCACertificatesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCACertificatesResponse' + - xml: + attribute: false + name: GetCACertificatesResponse + wrapped: false + required: + - GetCACertificatesResponse + title: GetCACertificatesResponse + type: object + xml: + attribute: false + name: GetCACertificatesResponse + wrapped: false + GetCapabilitiesRequest: + properties: + GetCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetCapabilities' + - {} + required: + - GetCapabilities + title: GetCapabilitiesRequest + type: object + GetCapabilitiesResponse: + properties: + GetCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCapabilitiesResponse' + - xml: + attribute: false + name: GetCapabilitiesResponse + wrapped: false + required: + - GetCapabilitiesResponse + title: GetCapabilitiesResponse + type: object + xml: + attribute: false + name: GetCapabilitiesResponse + wrapped: false + GetCertificateInformationRequest: + properties: + GetCertificateInformation: + allOf: + - $ref: '#/components/schemas/tns_GetCertificateInformation' + - {} + required: + - GetCertificateInformation + title: GetCertificateInformationRequest + type: object + GetCertificateInformationResponse: + properties: + GetCertificateInformationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCertificateInformationResponse' + - xml: + attribute: false + name: GetCertificateInformationResponse + wrapped: false + required: + - GetCertificateInformationResponse + title: GetCertificateInformationResponse + type: object + xml: + attribute: false + name: GetCertificateInformationResponse + wrapped: false + GetCertificatesRequest: + properties: + GetCertificates: + allOf: + - $ref: '#/components/schemas/tns_GetCertificates' + - {} + required: + - GetCertificates + title: GetCertificatesRequest + type: object + GetCertificatesResponse: + properties: + GetCertificatesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCertificatesResponse' + - xml: + attribute: false + name: GetCertificatesResponse + wrapped: false + required: + - GetCertificatesResponse + title: GetCertificatesResponse + type: object + xml: + attribute: false + name: GetCertificatesResponse + wrapped: false + GetCertificatesStatusRequest: + properties: + GetCertificatesStatus: + allOf: + - $ref: '#/components/schemas/tns_GetCertificatesStatus' + - {} + required: + - GetCertificatesStatus + title: GetCertificatesStatusRequest + type: object + GetCertificatesStatusResponse: + properties: + GetCertificatesStatusResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCertificatesStatusResponse' + - xml: + attribute: false + name: GetCertificatesStatusResponse + wrapped: false + required: + - GetCertificatesStatusResponse + title: GetCertificatesStatusResponse + type: object + xml: + attribute: false + name: GetCertificatesStatusResponse + wrapped: false + GetClientCertificateModeRequest: + properties: + GetClientCertificateMode: + allOf: + - $ref: '#/components/schemas/tns_GetClientCertificateMode' + - {} + required: + - GetClientCertificateMode + title: GetClientCertificateModeRequest + type: object + GetClientCertificateModeResponse: + properties: + GetClientCertificateModeResponse: + allOf: + - $ref: '#/components/schemas/tns_GetClientCertificateModeResponse' + - xml: + attribute: false + name: GetClientCertificateModeResponse + wrapped: false + required: + - GetClientCertificateModeResponse + title: GetClientCertificateModeResponse + type: object + xml: + attribute: false + name: GetClientCertificateModeResponse + wrapped: false + GetDNSRequest: + properties: + GetDNS: + allOf: + - $ref: '#/components/schemas/tns_GetDNS' + - {} + required: + - GetDNS + title: GetDNSRequest + type: object + GetDNSResponse: + properties: + GetDNSResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDNSResponse' + - xml: + attribute: false + name: GetDNSResponse + wrapped: false + required: + - GetDNSResponse + title: GetDNSResponse + type: object + xml: + attribute: false + name: GetDNSResponse + wrapped: false + GetDPAddressesRequest: + properties: + GetDPAddresses: + allOf: + - $ref: '#/components/schemas/tns_GetDPAddresses' + - {} + required: + - GetDPAddresses + title: GetDPAddressesRequest + type: object + GetDPAddressesResponse: + properties: + GetDPAddressesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDPAddressesResponse' + - xml: + attribute: false + name: GetDPAddressesResponse + wrapped: false + required: + - GetDPAddressesResponse + title: GetDPAddressesResponse + type: object + xml: + attribute: false + name: GetDPAddressesResponse + wrapped: false + GetDeviceInformationRequest: + properties: + GetDeviceInformation: + allOf: + - $ref: '#/components/schemas/tns_GetDeviceInformation' + - {} + required: + - GetDeviceInformation + title: GetDeviceInformationRequest + type: object + GetDeviceInformationResponse: + properties: + GetDeviceInformationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDeviceInformationResponse' + - xml: + attribute: false + name: GetDeviceInformationResponse + wrapped: false + required: + - GetDeviceInformationResponse + title: GetDeviceInformationResponse + type: object + xml: + attribute: false + name: GetDeviceInformationResponse + wrapped: false + GetDiscoveryModeRequest: + properties: + GetDiscoveryMode: + allOf: + - $ref: '#/components/schemas/tns_GetDiscoveryMode' + - {} + required: + - GetDiscoveryMode + title: GetDiscoveryModeRequest + type: object + GetDiscoveryModeResponse: + properties: + GetDiscoveryModeResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDiscoveryModeResponse' + - xml: + attribute: false + name: GetDiscoveryModeResponse + wrapped: false + required: + - GetDiscoveryModeResponse + title: GetDiscoveryModeResponse + type: object + xml: + attribute: false + name: GetDiscoveryModeResponse + wrapped: false + GetDot11CapabilitiesRequest: + properties: + GetDot11Capabilities: + allOf: + - $ref: '#/components/schemas/tns_GetDot11Capabilities' + - {} + required: + - GetDot11Capabilities + title: GetDot11CapabilitiesRequest + type: object + GetDot11CapabilitiesResponse: + properties: + GetDot11CapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDot11CapabilitiesResponse' + - xml: + attribute: false + name: GetDot11CapabilitiesResponse + wrapped: false + required: + - GetDot11CapabilitiesResponse + title: GetDot11CapabilitiesResponse + type: object + xml: + attribute: false + name: GetDot11CapabilitiesResponse + wrapped: false + GetDot11StatusRequest: + properties: + GetDot11Status: + allOf: + - $ref: '#/components/schemas/tns_GetDot11Status' + - {} + required: + - GetDot11Status + title: GetDot11StatusRequest + type: object + GetDot11StatusResponse: + properties: + GetDot11StatusResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDot11StatusResponse' + - xml: + attribute: false + name: GetDot11StatusResponse + wrapped: false + required: + - GetDot11StatusResponse + title: GetDot11StatusResponse + type: object + xml: + attribute: false + name: GetDot11StatusResponse + wrapped: false + GetDot1XConfigurationRequest: + properties: + GetDot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetDot1XConfiguration' + - {} + required: + - GetDot1XConfiguration + title: GetDot1XConfigurationRequest + type: object + GetDot1XConfigurationResponse: + properties: + GetDot1XConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDot1XConfigurationResponse' + - xml: + attribute: false + name: GetDot1XConfigurationResponse + wrapped: false + required: + - GetDot1XConfigurationResponse + title: GetDot1XConfigurationResponse + type: object + xml: + attribute: false + name: GetDot1XConfigurationResponse + wrapped: false + GetDot1XConfigurationsRequest: + properties: + GetDot1XConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetDot1XConfigurations' + - {} + required: + - GetDot1XConfigurations + title: GetDot1XConfigurationsRequest + type: object + GetDot1XConfigurationsResponse: + properties: + GetDot1XConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDot1XConfigurationsResponse' + - xml: + attribute: false + name: GetDot1XConfigurationsResponse + wrapped: false + required: + - GetDot1XConfigurationsResponse + title: GetDot1XConfigurationsResponse + type: object + xml: + attribute: false + name: GetDot1XConfigurationsResponse + wrapped: false + GetDynamicDNSRequest: + properties: + GetDynamicDNS: + allOf: + - $ref: '#/components/schemas/tns_GetDynamicDNS' + - {} + required: + - GetDynamicDNS + title: GetDynamicDNSRequest + type: object + GetDynamicDNSResponse: + properties: + GetDynamicDNSResponse: + allOf: + - $ref: '#/components/schemas/tns_GetDynamicDNSResponse' + - xml: + attribute: false + name: GetDynamicDNSResponse + wrapped: false + required: + - GetDynamicDNSResponse + title: GetDynamicDNSResponse + type: object + xml: + attribute: false + name: GetDynamicDNSResponse + wrapped: false + GetEndpointReferenceRequest: + properties: + GetEndpointReference: + allOf: + - $ref: '#/components/schemas/tns_GetEndpointReference' + - {} + required: + - GetEndpointReference + title: GetEndpointReferenceRequest + type: object + GetEndpointReferenceResponse: + properties: + GetEndpointReferenceResponse: + allOf: + - $ref: '#/components/schemas/tns_GetEndpointReferenceResponse' + - xml: + attribute: false + name: GetEndpointReferenceResponse + wrapped: false + required: + - GetEndpointReferenceResponse + title: GetEndpointReferenceResponse + type: object + xml: + attribute: false + name: GetEndpointReferenceResponse + wrapped: false + GetGeoLocationRequest: + properties: + GetGeoLocation: + allOf: + - $ref: '#/components/schemas/tns_GetGeoLocation' + - {} + required: + - GetGeoLocation + title: GetGeoLocationRequest + type: object + GetGeoLocationResponse: + properties: + GetGeoLocationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetGeoLocationResponse' + - xml: + attribute: false + name: GetGeoLocationResponse + wrapped: false + required: + - GetGeoLocationResponse + title: GetGeoLocationResponse + type: object + xml: + attribute: false + name: GetGeoLocationResponse + wrapped: false + GetHostnameRequest: + properties: + GetHostname: + allOf: + - $ref: '#/components/schemas/tns_GetHostname' + - {} + required: + - GetHostname + title: GetHostnameRequest + type: object + GetHostnameResponse: + properties: + GetHostnameResponse: + allOf: + - $ref: '#/components/schemas/tns_GetHostnameResponse' + - xml: + attribute: false + name: GetHostnameResponse + wrapped: false + required: + - GetHostnameResponse + title: GetHostnameResponse + type: object + xml: + attribute: false + name: GetHostnameResponse + wrapped: false + GetIPAddressFilterRequest: + properties: + GetIPAddressFilter: + allOf: + - $ref: '#/components/schemas/tns_GetIPAddressFilter' + - {} + required: + - GetIPAddressFilter + title: GetIPAddressFilterRequest + type: object + GetIPAddressFilterResponse: + properties: + GetIPAddressFilterResponse: + allOf: + - $ref: '#/components/schemas/tns_GetIPAddressFilterResponse' + - xml: + attribute: false + name: GetIPAddressFilterResponse + wrapped: false + required: + - GetIPAddressFilterResponse + title: GetIPAddressFilterResponse + type: object + xml: + attribute: false + name: GetIPAddressFilterResponse + wrapped: false + GetNTPRequest: + properties: + GetNTP: + allOf: + - $ref: '#/components/schemas/tns_GetNTP' + - {} + required: + - GetNTP + title: GetNTPRequest + type: object + GetNTPResponse: + properties: + GetNTPResponse: + allOf: + - $ref: '#/components/schemas/tns_GetNTPResponse' + - xml: + attribute: false + name: GetNTPResponse + wrapped: false + required: + - GetNTPResponse + title: GetNTPResponse + type: object + xml: + attribute: false + name: GetNTPResponse + wrapped: false + GetNetworkDefaultGatewayRequest: + properties: + GetNetworkDefaultGateway: + allOf: + - $ref: '#/components/schemas/tns_GetNetworkDefaultGateway' + - {} + required: + - GetNetworkDefaultGateway + title: GetNetworkDefaultGatewayRequest + type: object + GetNetworkDefaultGatewayResponse: + properties: + GetNetworkDefaultGatewayResponse: + allOf: + - $ref: '#/components/schemas/tns_GetNetworkDefaultGatewayResponse' + - xml: + attribute: false + name: GetNetworkDefaultGatewayResponse + wrapped: false + required: + - GetNetworkDefaultGatewayResponse + title: GetNetworkDefaultGatewayResponse + type: object + xml: + attribute: false + name: GetNetworkDefaultGatewayResponse + wrapped: false + GetNetworkInterfacesRequest: + properties: + GetNetworkInterfaces: + allOf: + - $ref: '#/components/schemas/tns_GetNetworkInterfaces' + - {} + required: + - GetNetworkInterfaces + title: GetNetworkInterfacesRequest + type: object + GetNetworkInterfacesResponse: + properties: + GetNetworkInterfacesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetNetworkInterfacesResponse' + - xml: + attribute: false + name: GetNetworkInterfacesResponse + wrapped: false + required: + - GetNetworkInterfacesResponse + title: GetNetworkInterfacesResponse + type: object + xml: + attribute: false + name: GetNetworkInterfacesResponse + wrapped: false + GetNetworkProtocolsRequest: + properties: + GetNetworkProtocols: + allOf: + - $ref: '#/components/schemas/tns_GetNetworkProtocols' + - {} + required: + - GetNetworkProtocols + title: GetNetworkProtocolsRequest + type: object + GetNetworkProtocolsResponse: + properties: + GetNetworkProtocolsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetNetworkProtocolsResponse' + - xml: + attribute: false + name: GetNetworkProtocolsResponse + wrapped: false + required: + - GetNetworkProtocolsResponse + title: GetNetworkProtocolsResponse + type: object + xml: + attribute: false + name: GetNetworkProtocolsResponse + wrapped: false + GetPasswordComplexityConfigurationRequest: + properties: + GetPasswordComplexityConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetPasswordComplexityConfiguration' + - {} + required: + - GetPasswordComplexityConfiguration + title: GetPasswordComplexityConfigurationRequest + type: object + GetPasswordComplexityConfigurationResponse: + properties: + GetPasswordComplexityConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPasswordComplexityConfigurationResponse' + - xml: + attribute: false + name: GetPasswordComplexityConfigurationResponse + wrapped: false + required: + - GetPasswordComplexityConfigurationResponse + title: GetPasswordComplexityConfigurationResponse + type: object + xml: + attribute: false + name: GetPasswordComplexityConfigurationResponse + wrapped: false + GetPasswordComplexityOptionsRequest: + properties: + GetPasswordComplexityOptions: + allOf: + - $ref: '#/components/schemas/tns_GetPasswordComplexityOptions' + - {} + required: + - GetPasswordComplexityOptions + title: GetPasswordComplexityOptionsRequest + type: object + GetPasswordComplexityOptionsResponse: + properties: + GetPasswordComplexityOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPasswordComplexityOptionsResponse' + - xml: + attribute: false + name: GetPasswordComplexityOptionsResponse + wrapped: false + required: + - GetPasswordComplexityOptionsResponse + title: GetPasswordComplexityOptionsResponse + type: object + xml: + attribute: false + name: GetPasswordComplexityOptionsResponse + wrapped: false + GetPasswordHistoryConfigurationRequest: + properties: + GetPasswordHistoryConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetPasswordHistoryConfiguration' + - {} + required: + - GetPasswordHistoryConfiguration + title: GetPasswordHistoryConfigurationRequest + type: object + GetPasswordHistoryConfigurationResponse: + properties: + GetPasswordHistoryConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPasswordHistoryConfigurationResponse' + - xml: + attribute: false + name: GetPasswordHistoryConfigurationResponse + wrapped: false + required: + - GetPasswordHistoryConfigurationResponse + title: GetPasswordHistoryConfigurationResponse + type: object + xml: + attribute: false + name: GetPasswordHistoryConfigurationResponse + wrapped: false + GetPkcs10RequestRequest: + properties: + GetPkcs10Request: + allOf: + - $ref: '#/components/schemas/tns_GetPkcs10Request' + - {} + required: + - GetPkcs10Request + title: GetPkcs10RequestRequest + type: object + GetPkcs10RequestResponse: + properties: + GetPkcs10RequestResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPkcs10RequestResponse' + - xml: + attribute: false + name: GetPkcs10RequestResponse + wrapped: false + required: + - GetPkcs10RequestResponse + title: GetPkcs10RequestResponse + type: object + xml: + attribute: false + name: GetPkcs10RequestResponse + wrapped: false + GetRelayOutputsRequest: + properties: + GetRelayOutputs: + allOf: + - $ref: '#/components/schemas/tns_GetRelayOutputs' + - {} + required: + - GetRelayOutputs + title: GetRelayOutputsRequest + type: object + GetRelayOutputsResponse: + properties: + GetRelayOutputsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetRelayOutputsResponse' + - xml: + attribute: false + name: GetRelayOutputsResponse + wrapped: false + required: + - GetRelayOutputsResponse + title: GetRelayOutputsResponse + type: object + xml: + attribute: false + name: GetRelayOutputsResponse + wrapped: false + GetRemoteDiscoveryModeRequest: + properties: + GetRemoteDiscoveryMode: + allOf: + - $ref: '#/components/schemas/tns_GetRemoteDiscoveryMode' + - {} + required: + - GetRemoteDiscoveryMode + title: GetRemoteDiscoveryModeRequest + type: object + GetRemoteDiscoveryModeResponse: + properties: + GetRemoteDiscoveryModeResponse: + allOf: + - $ref: '#/components/schemas/tns_GetRemoteDiscoveryModeResponse' + - xml: + attribute: false + name: GetRemoteDiscoveryModeResponse + wrapped: false + required: + - GetRemoteDiscoveryModeResponse + title: GetRemoteDiscoveryModeResponse + type: object + xml: + attribute: false + name: GetRemoteDiscoveryModeResponse + wrapped: false + GetRemoteUserRequest: + properties: + GetRemoteUser: + allOf: + - $ref: '#/components/schemas/tns_GetRemoteUser' + - {} + required: + - GetRemoteUser + title: GetRemoteUserRequest + type: object + GetRemoteUserResponse: + properties: + GetRemoteUserResponse: + allOf: + - $ref: '#/components/schemas/tns_GetRemoteUserResponse' + - xml: + attribute: false + name: GetRemoteUserResponse + wrapped: false + required: + - GetRemoteUserResponse + title: GetRemoteUserResponse + type: object + xml: + attribute: false + name: GetRemoteUserResponse + wrapped: false + GetScopesRequest: + properties: + GetScopes: + allOf: + - $ref: '#/components/schemas/tns_GetScopes' + - {} + required: + - GetScopes + title: GetScopesRequest + type: object + GetScopesResponse: + properties: + GetScopesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetScopesResponse' + - xml: + attribute: false + name: GetScopesResponse + wrapped: false + required: + - GetScopesResponse + title: GetScopesResponse + type: object + xml: + attribute: false + name: GetScopesResponse + wrapped: false + GetServiceCapabilitiesRequest: + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + required: + - GetServiceCapabilities + title: GetServiceCapabilitiesRequest + type: object + GetServiceCapabilitiesResponse: + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + attribute: false + name: GetServiceCapabilitiesResponse + wrapped: false + required: + - GetServiceCapabilitiesResponse + title: GetServiceCapabilitiesResponse + type: object + xml: + attribute: false + name: GetServiceCapabilitiesResponse + wrapped: false + GetServicesRequest: + properties: + GetServices: + allOf: + - $ref: '#/components/schemas/tns_GetServices' + - {} + required: + - GetServices + title: GetServicesRequest + type: object + GetServicesResponse: + properties: + GetServicesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServicesResponse' + - xml: + attribute: false + name: GetServicesResponse + wrapped: false + required: + - GetServicesResponse + title: GetServicesResponse + type: object + xml: + attribute: false + name: GetServicesResponse + wrapped: false + GetStorageConfigurationRequest: + properties: + GetStorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetStorageConfiguration' + - {} + required: + - GetStorageConfiguration + title: GetStorageConfigurationRequest + type: object + GetStorageConfigurationResponse: + properties: + GetStorageConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetStorageConfigurationResponse' + - xml: + attribute: false + name: GetStorageConfigurationResponse + wrapped: false + required: + - GetStorageConfigurationResponse + title: GetStorageConfigurationResponse + type: object + xml: + attribute: false + name: GetStorageConfigurationResponse + wrapped: false + GetStorageConfigurationsRequest: + properties: + GetStorageConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetStorageConfigurations' + - {} + required: + - GetStorageConfigurations + title: GetStorageConfigurationsRequest + type: object + GetStorageConfigurationsResponse: + properties: + GetStorageConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetStorageConfigurationsResponse' + - xml: + attribute: false + name: GetStorageConfigurationsResponse + wrapped: false + required: + - GetStorageConfigurationsResponse + title: GetStorageConfigurationsResponse + type: object + xml: + attribute: false + name: GetStorageConfigurationsResponse + wrapped: false + GetSystemBackupRequest: + properties: + GetSystemBackup: + allOf: + - $ref: '#/components/schemas/tns_GetSystemBackup' + - {} + required: + - GetSystemBackup + title: GetSystemBackupRequest + type: object + GetSystemBackupResponse: + properties: + GetSystemBackupResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSystemBackupResponse' + - xml: + attribute: false + name: GetSystemBackupResponse + wrapped: false + required: + - GetSystemBackupResponse + title: GetSystemBackupResponse + type: object + xml: + attribute: false + name: GetSystemBackupResponse + wrapped: false + GetSystemDateAndTimeRequest: + properties: + GetSystemDateAndTime: + allOf: + - $ref: '#/components/schemas/tns_GetSystemDateAndTime' + - {} + required: + - GetSystemDateAndTime + title: GetSystemDateAndTimeRequest + type: object + GetSystemDateAndTimeResponse: + properties: + GetSystemDateAndTimeResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSystemDateAndTimeResponse' + - xml: + attribute: false + name: GetSystemDateAndTimeResponse + wrapped: false + required: + - GetSystemDateAndTimeResponse + title: GetSystemDateAndTimeResponse + type: object + xml: + attribute: false + name: GetSystemDateAndTimeResponse + wrapped: false + GetSystemLogRequest: + properties: + GetSystemLog: + allOf: + - $ref: '#/components/schemas/tns_GetSystemLog' + - {} + required: + - GetSystemLog + title: GetSystemLogRequest + type: object + GetSystemLogResponse: + properties: + GetSystemLogResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSystemLogResponse' + - xml: + attribute: false + name: GetSystemLogResponse + wrapped: false + required: + - GetSystemLogResponse + title: GetSystemLogResponse + type: object + xml: + attribute: false + name: GetSystemLogResponse + wrapped: false + GetSystemSupportInformationRequest: + properties: + GetSystemSupportInformation: + allOf: + - $ref: '#/components/schemas/tns_GetSystemSupportInformation' + - {} + required: + - GetSystemSupportInformation + title: GetSystemSupportInformationRequest + type: object + GetSystemSupportInformationResponse: + properties: + GetSystemSupportInformationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSystemSupportInformationResponse' + - xml: + attribute: false + name: GetSystemSupportInformationResponse + wrapped: false + required: + - GetSystemSupportInformationResponse + title: GetSystemSupportInformationResponse + type: object + xml: + attribute: false + name: GetSystemSupportInformationResponse + wrapped: false + GetSystemUrisRequest: + properties: + GetSystemUris: + allOf: + - $ref: '#/components/schemas/tns_GetSystemUris' + - {} + required: + - GetSystemUris + title: GetSystemUrisRequest + type: object + GetSystemUrisResponse: + properties: + GetSystemUrisResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSystemUrisResponse' + - xml: + attribute: false + name: GetSystemUrisResponse + wrapped: false + required: + - GetSystemUrisResponse + title: GetSystemUrisResponse + type: object + xml: + attribute: false + name: GetSystemUrisResponse + wrapped: false + GetUsersRequest: + properties: + GetUsers: + allOf: + - $ref: '#/components/schemas/tns_GetUsers' + - {} + required: + - GetUsers + title: GetUsersRequest + type: object + GetUsersResponse: + properties: + GetUsersResponse: + allOf: + - $ref: '#/components/schemas/tns_GetUsersResponse' + - xml: + attribute: false + name: GetUsersResponse + wrapped: false + required: + - GetUsersResponse + title: GetUsersResponse + type: object + xml: + attribute: false + name: GetUsersResponse + wrapped: false + GetWsdlUrlRequest: + properties: + GetWsdlUrl: + allOf: + - $ref: '#/components/schemas/tns_GetWsdlUrl' + - {} + required: + - GetWsdlUrl + title: GetWsdlUrlRequest + type: object + GetWsdlUrlResponse: + properties: + GetWsdlUrlResponse: + allOf: + - $ref: '#/components/schemas/tns_GetWsdlUrlResponse' + - xml: + attribute: false + name: GetWsdlUrlResponse + wrapped: false + required: + - GetWsdlUrlResponse + title: GetWsdlUrlResponse + type: object + xml: + attribute: false + name: GetWsdlUrlResponse + wrapped: false + GetZeroConfigurationRequest: + properties: + GetZeroConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetZeroConfiguration' + - {} + required: + - GetZeroConfiguration + title: GetZeroConfigurationRequest + type: object + GetZeroConfigurationResponse: + properties: + GetZeroConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetZeroConfigurationResponse' + - xml: + attribute: false + name: GetZeroConfigurationResponse + wrapped: false + required: + - GetZeroConfigurationResponse + title: GetZeroConfigurationResponse + type: object + xml: + attribute: false + name: GetZeroConfigurationResponse + wrapped: false + LoadCACertificatesRequest: + properties: + LoadCACertificates: + allOf: + - $ref: '#/components/schemas/tns_LoadCACertificates' + - {} + required: + - LoadCACertificates + title: LoadCACertificatesRequest + type: object + LoadCACertificatesResponse: + properties: + LoadCACertificatesResponse: + allOf: + - $ref: '#/components/schemas/tns_LoadCACertificatesResponse' + - xml: + attribute: false + name: LoadCACertificatesResponse + wrapped: false + required: + - LoadCACertificatesResponse + title: LoadCACertificatesResponse + type: object + xml: + attribute: false + name: LoadCACertificatesResponse + wrapped: false + LoadCertificateWithPrivateKeyRequest: + properties: + LoadCertificateWithPrivateKey: + allOf: + - $ref: '#/components/schemas/tns_LoadCertificateWithPrivateKey' + - {} + required: + - LoadCertificateWithPrivateKey + title: LoadCertificateWithPrivateKeyRequest + type: object + LoadCertificateWithPrivateKeyResponse: + properties: + LoadCertificateWithPrivateKeyResponse: + allOf: + - $ref: '#/components/schemas/tns_LoadCertificateWithPrivateKeyResponse' + - xml: + attribute: false + name: LoadCertificateWithPrivateKeyResponse + wrapped: false + required: + - LoadCertificateWithPrivateKeyResponse + title: LoadCertificateWithPrivateKeyResponse + type: object + xml: + attribute: false + name: LoadCertificateWithPrivateKeyResponse + wrapped: false + LoadCertificatesRequest: + properties: + LoadCertificates: + allOf: + - $ref: '#/components/schemas/tns_LoadCertificates' + - {} + required: + - LoadCertificates + title: LoadCertificatesRequest + type: object + LoadCertificatesResponse: + properties: + LoadCertificatesResponse: + allOf: + - $ref: '#/components/schemas/tns_LoadCertificatesResponse' + - xml: + attribute: false + name: LoadCertificatesResponse + wrapped: false + required: + - LoadCertificatesResponse + title: LoadCertificatesResponse + type: object + xml: + attribute: false + name: LoadCertificatesResponse + wrapped: false + RemoveIPAddressFilterRequest: + properties: + RemoveIPAddressFilter: + allOf: + - $ref: '#/components/schemas/tns_RemoveIPAddressFilter' + - {} + required: + - RemoveIPAddressFilter + title: RemoveIPAddressFilterRequest + type: object + RemoveIPAddressFilterResponse: + properties: + RemoveIPAddressFilterResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveIPAddressFilterResponse' + - xml: + attribute: false + name: RemoveIPAddressFilterResponse + wrapped: false + required: + - RemoveIPAddressFilterResponse + title: RemoveIPAddressFilterResponse + type: object + xml: + attribute: false + name: RemoveIPAddressFilterResponse + wrapped: false + RemoveScopesRequest: + properties: + RemoveScopes: + allOf: + - $ref: '#/components/schemas/tns_RemoveScopes' + - {} + required: + - RemoveScopes + title: RemoveScopesRequest + type: object + RemoveScopesResponse: + properties: + RemoveScopesResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveScopesResponse' + - xml: + attribute: false + name: RemoveScopesResponse + wrapped: false + required: + - RemoveScopesResponse + title: RemoveScopesResponse + type: object + xml: + attribute: false + name: RemoveScopesResponse + wrapped: false + RestoreSystemRequest: + properties: + RestoreSystem: + allOf: + - $ref: '#/components/schemas/tns_RestoreSystem' + - {} + required: + - RestoreSystem + title: RestoreSystemRequest + type: object + RestoreSystemResponse: + properties: + RestoreSystemResponse: + allOf: + - $ref: '#/components/schemas/tns_RestoreSystemResponse' + - xml: + attribute: false + name: RestoreSystemResponse + wrapped: false + required: + - RestoreSystemResponse + title: RestoreSystemResponse + type: object + xml: + attribute: false + name: RestoreSystemResponse + wrapped: false + ScanAvailableDot11NetworksRequest: + properties: + ScanAvailableDot11Networks: + allOf: + - $ref: '#/components/schemas/tns_ScanAvailableDot11Networks' + - {} + required: + - ScanAvailableDot11Networks + title: ScanAvailableDot11NetworksRequest + type: object + ScanAvailableDot11NetworksResponse: + properties: + ScanAvailableDot11NetworksResponse: + allOf: + - $ref: '#/components/schemas/tns_ScanAvailableDot11NetworksResponse' + - xml: + attribute: false + name: ScanAvailableDot11NetworksResponse + wrapped: false + required: + - ScanAvailableDot11NetworksResponse + title: ScanAvailableDot11NetworksResponse + type: object + xml: + attribute: false + name: ScanAvailableDot11NetworksResponse + wrapped: false + SendAuxiliaryCommandRequest: + properties: + SendAuxiliaryCommand: + allOf: + - $ref: '#/components/schemas/tns_SendAuxiliaryCommand' + - {} + required: + - SendAuxiliaryCommand + title: SendAuxiliaryCommandRequest + type: object + SendAuxiliaryCommandResponse: + properties: + SendAuxiliaryCommandResponse: + allOf: + - $ref: '#/components/schemas/tns_SendAuxiliaryCommandResponse' + - xml: + attribute: false + name: SendAuxiliaryCommandResponse + wrapped: false + required: + - SendAuxiliaryCommandResponse + title: SendAuxiliaryCommandResponse + type: object + xml: + attribute: false + name: SendAuxiliaryCommandResponse + wrapped: false + SetAccessPolicyRequest: + properties: + SetAccessPolicy: + allOf: + - $ref: '#/components/schemas/tns_SetAccessPolicy' + - {} + required: + - SetAccessPolicy + title: SetAccessPolicyRequest + type: object + SetAccessPolicyResponse: + properties: + SetAccessPolicyResponse: + allOf: + - $ref: '#/components/schemas/tns_SetAccessPolicyResponse' + - xml: + attribute: false + name: SetAccessPolicyResponse + wrapped: false + required: + - SetAccessPolicyResponse + title: SetAccessPolicyResponse + type: object + xml: + attribute: false + name: SetAccessPolicyResponse + wrapped: false + SetAuthFailureWarningConfigurationRequest: + properties: + SetAuthFailureWarningConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAuthFailureWarningConfiguration' + - {} + required: + - SetAuthFailureWarningConfiguration + title: SetAuthFailureWarningConfigurationRequest + type: object + SetAuthFailureWarningConfigurationResponse: + properties: + SetAuthFailureWarningConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetAuthFailureWarningConfigurationResponse' + - xml: + attribute: false + name: SetAuthFailureWarningConfigurationResponse + wrapped: false + required: + - SetAuthFailureWarningConfigurationResponse + title: SetAuthFailureWarningConfigurationResponse + type: object + xml: + attribute: false + name: SetAuthFailureWarningConfigurationResponse + wrapped: false + SetCertificatesStatusRequest: + properties: + SetCertificatesStatus: + allOf: + - $ref: '#/components/schemas/tns_SetCertificatesStatus' + - {} + required: + - SetCertificatesStatus + title: SetCertificatesStatusRequest + type: object + SetCertificatesStatusResponse: + properties: + SetCertificatesStatusResponse: + allOf: + - $ref: '#/components/schemas/tns_SetCertificatesStatusResponse' + - xml: + attribute: false + name: SetCertificatesStatusResponse + wrapped: false + required: + - SetCertificatesStatusResponse + title: SetCertificatesStatusResponse + type: object + xml: + attribute: false + name: SetCertificatesStatusResponse + wrapped: false + SetClientCertificateModeRequest: + properties: + SetClientCertificateMode: + allOf: + - $ref: '#/components/schemas/tns_SetClientCertificateMode' + - {} + required: + - SetClientCertificateMode + title: SetClientCertificateModeRequest + type: object + SetClientCertificateModeResponse: + properties: + SetClientCertificateModeResponse: + allOf: + - $ref: '#/components/schemas/tns_SetClientCertificateModeResponse' + - xml: + attribute: false + name: SetClientCertificateModeResponse + wrapped: false + required: + - SetClientCertificateModeResponse + title: SetClientCertificateModeResponse + type: object + xml: + attribute: false + name: SetClientCertificateModeResponse + wrapped: false + SetDNSRequest: + properties: + SetDNS: + allOf: + - $ref: '#/components/schemas/tns_SetDNS' + - {} + required: + - SetDNS + title: SetDNSRequest + type: object + SetDNSResponse: + properties: + SetDNSResponse: + allOf: + - $ref: '#/components/schemas/tns_SetDNSResponse' + - xml: + attribute: false + name: SetDNSResponse + wrapped: false + required: + - SetDNSResponse + title: SetDNSResponse + type: object + xml: + attribute: false + name: SetDNSResponse + wrapped: false + SetDPAddressesRequest: + properties: + SetDPAddresses: + allOf: + - $ref: '#/components/schemas/tns_SetDPAddresses' + - {} + required: + - SetDPAddresses + title: SetDPAddressesRequest + type: object + SetDPAddressesResponse: + properties: + SetDPAddressesResponse: + allOf: + - $ref: '#/components/schemas/tns_SetDPAddressesResponse' + - xml: + attribute: false + name: SetDPAddressesResponse + wrapped: false + required: + - SetDPAddressesResponse + title: SetDPAddressesResponse + type: object + xml: + attribute: false + name: SetDPAddressesResponse + wrapped: false + SetDiscoveryModeRequest: + properties: + SetDiscoveryMode: + allOf: + - $ref: '#/components/schemas/tns_SetDiscoveryMode' + - {} + required: + - SetDiscoveryMode + title: SetDiscoveryModeRequest + type: object + SetDiscoveryModeResponse: + properties: + SetDiscoveryModeResponse: + allOf: + - $ref: '#/components/schemas/tns_SetDiscoveryModeResponse' + - xml: + attribute: false + name: SetDiscoveryModeResponse + wrapped: false + required: + - SetDiscoveryModeResponse + title: SetDiscoveryModeResponse + type: object + xml: + attribute: false + name: SetDiscoveryModeResponse + wrapped: false + SetDot1XConfigurationRequest: + properties: + SetDot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetDot1XConfiguration' + - {} + required: + - SetDot1XConfiguration + title: SetDot1XConfigurationRequest + type: object + SetDot1XConfigurationResponse: + properties: + SetDot1XConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetDot1XConfigurationResponse' + - xml: + attribute: false + name: SetDot1XConfigurationResponse + wrapped: false + required: + - SetDot1XConfigurationResponse + title: SetDot1XConfigurationResponse + type: object + xml: + attribute: false + name: SetDot1XConfigurationResponse + wrapped: false + SetDynamicDNSRequest: + properties: + SetDynamicDNS: + allOf: + - $ref: '#/components/schemas/tns_SetDynamicDNS' + - {} + required: + - SetDynamicDNS + title: SetDynamicDNSRequest + type: object + SetDynamicDNSResponse: + properties: + SetDynamicDNSResponse: + allOf: + - $ref: '#/components/schemas/tns_SetDynamicDNSResponse' + - xml: + attribute: false + name: SetDynamicDNSResponse + wrapped: false + required: + - SetDynamicDNSResponse + title: SetDynamicDNSResponse + type: object + xml: + attribute: false + name: SetDynamicDNSResponse + wrapped: false + SetGeoLocationRequest: + properties: + SetGeoLocation: + allOf: + - $ref: '#/components/schemas/tns_SetGeoLocation' + - {} + required: + - SetGeoLocation + title: SetGeoLocationRequest + type: object + SetGeoLocationResponse: + properties: + SetGeoLocationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetGeoLocationResponse' + - xml: + attribute: false + name: SetGeoLocationResponse + wrapped: false + required: + - SetGeoLocationResponse + title: SetGeoLocationResponse + type: object + xml: + attribute: false + name: SetGeoLocationResponse + wrapped: false + SetHostnameFromDHCPRequest: + properties: + SetHostnameFromDHCP: + allOf: + - $ref: '#/components/schemas/tns_SetHostnameFromDHCP' + - {} + required: + - SetHostnameFromDHCP + title: SetHostnameFromDHCPRequest + type: object + SetHostnameFromDHCPResponse: + properties: + SetHostnameFromDHCPResponse: + allOf: + - $ref: '#/components/schemas/tns_SetHostnameFromDHCPResponse' + - xml: + attribute: false + name: SetHostnameFromDHCPResponse + wrapped: false + required: + - SetHostnameFromDHCPResponse + title: SetHostnameFromDHCPResponse + type: object + xml: + attribute: false + name: SetHostnameFromDHCPResponse + wrapped: false + SetHostnameRequest: + properties: + SetHostname: + allOf: + - $ref: '#/components/schemas/tns_SetHostname' + - {} + required: + - SetHostname + title: SetHostnameRequest + type: object + SetHostnameResponse: + properties: + SetHostnameResponse: + allOf: + - $ref: '#/components/schemas/tns_SetHostnameResponse' + - xml: + attribute: false + name: SetHostnameResponse + wrapped: false + required: + - SetHostnameResponse + title: SetHostnameResponse + type: object + xml: + attribute: false + name: SetHostnameResponse + wrapped: false + SetIPAddressFilterRequest: + properties: + SetIPAddressFilter: + allOf: + - $ref: '#/components/schemas/tns_SetIPAddressFilter' + - {} + required: + - SetIPAddressFilter + title: SetIPAddressFilterRequest + type: object + SetIPAddressFilterResponse: + properties: + SetIPAddressFilterResponse: + allOf: + - $ref: '#/components/schemas/tns_SetIPAddressFilterResponse' + - xml: + attribute: false + name: SetIPAddressFilterResponse + wrapped: false + required: + - SetIPAddressFilterResponse + title: SetIPAddressFilterResponse + type: object + xml: + attribute: false + name: SetIPAddressFilterResponse + wrapped: false + SetNTPRequest: + properties: + SetNTP: + allOf: + - $ref: '#/components/schemas/tns_SetNTP' + - {} + required: + - SetNTP + title: SetNTPRequest + type: object + SetNTPResponse: + properties: + SetNTPResponse: + allOf: + - $ref: '#/components/schemas/tns_SetNTPResponse' + - xml: + attribute: false + name: SetNTPResponse + wrapped: false + required: + - SetNTPResponse + title: SetNTPResponse + type: object + xml: + attribute: false + name: SetNTPResponse + wrapped: false + SetNetworkDefaultGatewayRequest: + properties: + SetNetworkDefaultGateway: + allOf: + - $ref: '#/components/schemas/tns_SetNetworkDefaultGateway' + - {} + required: + - SetNetworkDefaultGateway + title: SetNetworkDefaultGatewayRequest + type: object + SetNetworkDefaultGatewayResponse: + properties: + SetNetworkDefaultGatewayResponse: + allOf: + - $ref: '#/components/schemas/tns_SetNetworkDefaultGatewayResponse' + - xml: + attribute: false + name: SetNetworkDefaultGatewayResponse + wrapped: false + required: + - SetNetworkDefaultGatewayResponse + title: SetNetworkDefaultGatewayResponse + type: object + xml: + attribute: false + name: SetNetworkDefaultGatewayResponse + wrapped: false + SetNetworkInterfacesRequest: + properties: + SetNetworkInterfaces: + allOf: + - $ref: '#/components/schemas/tns_SetNetworkInterfaces' + - {} + required: + - SetNetworkInterfaces + title: SetNetworkInterfacesRequest + type: object + SetNetworkInterfacesResponse: + properties: + SetNetworkInterfacesResponse: + allOf: + - $ref: '#/components/schemas/tns_SetNetworkInterfacesResponse' + - xml: + attribute: false + name: SetNetworkInterfacesResponse + wrapped: false + required: + - SetNetworkInterfacesResponse + title: SetNetworkInterfacesResponse + type: object + xml: + attribute: false + name: SetNetworkInterfacesResponse + wrapped: false + SetNetworkProtocolsRequest: + properties: + SetNetworkProtocols: + allOf: + - $ref: '#/components/schemas/tns_SetNetworkProtocols' + - {} + required: + - SetNetworkProtocols + title: SetNetworkProtocolsRequest + type: object + SetNetworkProtocolsResponse: + properties: + SetNetworkProtocolsResponse: + allOf: + - $ref: '#/components/schemas/tns_SetNetworkProtocolsResponse' + - xml: + attribute: false + name: SetNetworkProtocolsResponse + wrapped: false + required: + - SetNetworkProtocolsResponse + title: SetNetworkProtocolsResponse + type: object + xml: + attribute: false + name: SetNetworkProtocolsResponse + wrapped: false + SetPasswordComplexityConfigurationRequest: + properties: + SetPasswordComplexityConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetPasswordComplexityConfiguration' + - {} + required: + - SetPasswordComplexityConfiguration + title: SetPasswordComplexityConfigurationRequest + type: object + SetPasswordComplexityConfigurationResponse: + properties: + SetPasswordComplexityConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetPasswordComplexityConfigurationResponse' + - xml: + attribute: false + name: SetPasswordComplexityConfigurationResponse + wrapped: false + required: + - SetPasswordComplexityConfigurationResponse + title: SetPasswordComplexityConfigurationResponse + type: object + xml: + attribute: false + name: SetPasswordComplexityConfigurationResponse + wrapped: false + SetPasswordHistoryConfigurationRequest: + properties: + SetPasswordHistoryConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetPasswordHistoryConfiguration' + - {} + required: + - SetPasswordHistoryConfiguration + title: SetPasswordHistoryConfigurationRequest + type: object + SetPasswordHistoryConfigurationResponse: + properties: + SetPasswordHistoryConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetPasswordHistoryConfigurationResponse' + - xml: + attribute: false + name: SetPasswordHistoryConfigurationResponse + wrapped: false + required: + - SetPasswordHistoryConfigurationResponse + title: SetPasswordHistoryConfigurationResponse + type: object + xml: + attribute: false + name: SetPasswordHistoryConfigurationResponse + wrapped: false + SetRelayOutputSettingsRequest: + properties: + SetRelayOutputSettings: + allOf: + - $ref: '#/components/schemas/tns_SetRelayOutputSettings' + - {} + required: + - SetRelayOutputSettings + title: SetRelayOutputSettingsRequest + type: object + SetRelayOutputSettingsResponse: + properties: + SetRelayOutputSettingsResponse: + allOf: + - $ref: '#/components/schemas/tns_SetRelayOutputSettingsResponse' + - xml: + attribute: false + name: SetRelayOutputSettingsResponse + wrapped: false + required: + - SetRelayOutputSettingsResponse + title: SetRelayOutputSettingsResponse + type: object + xml: + attribute: false + name: SetRelayOutputSettingsResponse + wrapped: false + SetRelayOutputStateRequest: + properties: + SetRelayOutputState: + allOf: + - $ref: '#/components/schemas/tns_SetRelayOutputState' + - {} + required: + - SetRelayOutputState + title: SetRelayOutputStateRequest + type: object + SetRelayOutputStateResponse: + properties: + SetRelayOutputStateResponse: + allOf: + - $ref: '#/components/schemas/tns_SetRelayOutputStateResponse' + - xml: + attribute: false + name: SetRelayOutputStateResponse + wrapped: false + required: + - SetRelayOutputStateResponse + title: SetRelayOutputStateResponse + type: object + xml: + attribute: false + name: SetRelayOutputStateResponse + wrapped: false + SetRemoteDiscoveryModeRequest: + properties: + SetRemoteDiscoveryMode: + allOf: + - $ref: '#/components/schemas/tns_SetRemoteDiscoveryMode' + - {} + required: + - SetRemoteDiscoveryMode + title: SetRemoteDiscoveryModeRequest + type: object + SetRemoteDiscoveryModeResponse: + properties: + SetRemoteDiscoveryModeResponse: + allOf: + - $ref: '#/components/schemas/tns_SetRemoteDiscoveryModeResponse' + - xml: + attribute: false + name: SetRemoteDiscoveryModeResponse + wrapped: false + required: + - SetRemoteDiscoveryModeResponse + title: SetRemoteDiscoveryModeResponse + type: object + xml: + attribute: false + name: SetRemoteDiscoveryModeResponse + wrapped: false + SetRemoteUserRequest: + properties: + SetRemoteUser: + allOf: + - $ref: '#/components/schemas/tns_SetRemoteUser' + - {} + required: + - SetRemoteUser + title: SetRemoteUserRequest + type: object + SetRemoteUserResponse: + properties: + SetRemoteUserResponse: + allOf: + - $ref: '#/components/schemas/tns_SetRemoteUserResponse' + - xml: + attribute: false + name: SetRemoteUserResponse + wrapped: false + required: + - SetRemoteUserResponse + title: SetRemoteUserResponse + type: object + xml: + attribute: false + name: SetRemoteUserResponse + wrapped: false + SetScopesRequest: + properties: + SetScopes: + allOf: + - $ref: '#/components/schemas/tns_SetScopes' + - {} + required: + - SetScopes + title: SetScopesRequest + type: object + SetScopesResponse: + properties: + SetScopesResponse: + allOf: + - $ref: '#/components/schemas/tns_SetScopesResponse' + - xml: + attribute: false + name: SetScopesResponse + wrapped: false + required: + - SetScopesResponse + title: SetScopesResponse + type: object + xml: + attribute: false + name: SetScopesResponse + wrapped: false + SetStorageConfigurationRequest: + properties: + SetStorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetStorageConfiguration' + - {} + required: + - SetStorageConfiguration + title: SetStorageConfigurationRequest + type: object + SetStorageConfigurationResponse: + properties: + SetStorageConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetStorageConfigurationResponse' + - xml: + attribute: false + name: SetStorageConfigurationResponse + wrapped: false + required: + - SetStorageConfigurationResponse + title: SetStorageConfigurationResponse + type: object + xml: + attribute: false + name: SetStorageConfigurationResponse + wrapped: false + SetSystemDateAndTimeRequest: + properties: + SetSystemDateAndTime: + allOf: + - $ref: '#/components/schemas/tns_SetSystemDateAndTime' + - {} + required: + - SetSystemDateAndTime + title: SetSystemDateAndTimeRequest + type: object + SetSystemDateAndTimeResponse: + properties: + SetSystemDateAndTimeResponse: + allOf: + - $ref: '#/components/schemas/tns_SetSystemDateAndTimeResponse' + - xml: + attribute: false + name: SetSystemDateAndTimeResponse + wrapped: false + required: + - SetSystemDateAndTimeResponse + title: SetSystemDateAndTimeResponse + type: object + xml: + attribute: false + name: SetSystemDateAndTimeResponse + wrapped: false + SetSystemFactoryDefaultRequest: + properties: + SetSystemFactoryDefault: + allOf: + - $ref: '#/components/schemas/tns_SetSystemFactoryDefault' + - {} + required: + - SetSystemFactoryDefault + title: SetSystemFactoryDefaultRequest + type: object + SetSystemFactoryDefaultResponse: + properties: + SetSystemFactoryDefaultResponse: + allOf: + - $ref: '#/components/schemas/tns_SetSystemFactoryDefaultResponse' + - xml: + attribute: false + name: SetSystemFactoryDefaultResponse + wrapped: false + required: + - SetSystemFactoryDefaultResponse + title: SetSystemFactoryDefaultResponse + type: object + xml: + attribute: false + name: SetSystemFactoryDefaultResponse + wrapped: false + SetUserRequest: + properties: + SetUser: + allOf: + - $ref: '#/components/schemas/tns_SetUser' + - {} + required: + - SetUser + title: SetUserRequest + type: object + SetUserResponse: + properties: + SetUserResponse: + allOf: + - $ref: '#/components/schemas/tns_SetUserResponse' + - xml: + attribute: false + name: SetUserResponse + wrapped: false + required: + - SetUserResponse + title: SetUserResponse + type: object + xml: + attribute: false + name: SetUserResponse + wrapped: false + SetZeroConfigurationRequest: + properties: + SetZeroConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetZeroConfiguration' + - {} + required: + - SetZeroConfiguration + title: SetZeroConfigurationRequest + type: object + SetZeroConfigurationResponse: + properties: + SetZeroConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetZeroConfigurationResponse' + - xml: + attribute: false + name: SetZeroConfigurationResponse + wrapped: false + required: + - SetZeroConfigurationResponse + title: SetZeroConfigurationResponse + type: object + xml: + attribute: false + name: SetZeroConfigurationResponse + wrapped: false + StartFirmwareUpgradeRequest: + properties: + StartFirmwareUpgrade: + allOf: + - $ref: '#/components/schemas/tns_StartFirmwareUpgrade' + - {} + required: + - StartFirmwareUpgrade + title: StartFirmwareUpgradeRequest + type: object + StartFirmwareUpgradeResponse: + properties: + StartFirmwareUpgradeResponse: + allOf: + - $ref: '#/components/schemas/tns_StartFirmwareUpgradeResponse' + - xml: + attribute: false + name: StartFirmwareUpgradeResponse + wrapped: false + required: + - StartFirmwareUpgradeResponse + title: StartFirmwareUpgradeResponse + type: object + xml: + attribute: false + name: StartFirmwareUpgradeResponse + wrapped: false + StartSystemRestoreRequest: + properties: + StartSystemRestore: + allOf: + - $ref: '#/components/schemas/tns_StartSystemRestore' + - {} + required: + - StartSystemRestore + title: StartSystemRestoreRequest + type: object + StartSystemRestoreResponse: + properties: + StartSystemRestoreResponse: + allOf: + - $ref: '#/components/schemas/tns_StartSystemRestoreResponse' + - xml: + attribute: false + name: StartSystemRestoreResponse + wrapped: false + required: + - StartSystemRestoreResponse + title: StartSystemRestoreResponse + type: object + xml: + attribute: false + name: StartSystemRestoreResponse + wrapped: false + SystemRebootRequest: + properties: + SystemReboot: + allOf: + - $ref: '#/components/schemas/tns_SystemReboot' + - {} + required: + - SystemReboot + title: SystemRebootRequest + type: object + SystemRebootResponse: + properties: + SystemRebootResponse: + allOf: + - $ref: '#/components/schemas/tns_SystemRebootResponse' + - xml: + attribute: false + name: SystemRebootResponse + wrapped: false + required: + - SystemRebootResponse + title: SystemRebootResponse + type: object + xml: + attribute: false + name: SystemRebootResponse + wrapped: false + UpgradeSystemFirmwareRequest: + properties: + UpgradeSystemFirmware: + allOf: + - $ref: '#/components/schemas/tns_UpgradeSystemFirmware' + - {} + required: + - UpgradeSystemFirmware + title: UpgradeSystemFirmwareRequest + type: object + UpgradeSystemFirmwareResponse: + properties: + UpgradeSystemFirmwareResponse: + allOf: + - $ref: '#/components/schemas/tns_UpgradeSystemFirmwareResponse' + - xml: + attribute: false + name: UpgradeSystemFirmwareResponse + wrapped: false + required: + - UpgradeSystemFirmwareResponse + title: UpgradeSystemFirmwareResponse + type: object + xml: + attribute: false + name: UpgradeSystemFirmwareResponse + wrapped: false + soapenv_Body: + description: '' + title: soapenv_Body + type: object + xml: + attribute: false + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_Envelope: + description: '' + properties: + Body: + allOf: + - $ref: '#/components/schemas/soapenv_Body' + - xml: + attribute: false + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Header: + allOf: + - $ref: '#/components/schemas/soapenv_Header' + - xml: + attribute: false + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + required: + - Body + title: soapenv_Envelope + type: object + xml: + attribute: false + name: Envelope + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_Fault: + description: Fault reporting structure + properties: + Code: + allOf: + - $ref: '#/components/schemas/soapenv_faultcode' + - xml: + attribute: false + name: Code + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Detail: + allOf: + - $ref: '#/components/schemas/soapenv_detail' + - xml: + attribute: false + name: Detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Node: + type: string + xml: + attribute: false + name: Node + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Reason: + allOf: + - $ref: '#/components/schemas/soapenv_faultreason' + - xml: + attribute: false + name: Reason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Role: + type: string + xml: + attribute: false + name: Role + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + required: + - Code + - Reason + title: soapenv_Fault + type: object + xml: + attribute: false + name: Fault + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_Header: + description: Elements replacing the wildcard MUST be namespace qualified, but + can be in the targetNamespace + title: soapenv_Header + type: object + xml: + attribute: false + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_NotUnderstoodType: + description: '' + properties: + qname: + type: string + xml: + attribute: true + name: qname + prefix: soapenv + wrapped: false + required: + - qname + title: soapenv_NotUnderstoodType + type: object + xml: + attribute: false + name: NotUnderstoodType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_SupportedEnvType: + description: '' + properties: + qname: + type: string + xml: + attribute: true + name: qname + prefix: soapenv + wrapped: false + required: + - qname + title: soapenv_SupportedEnvType + type: object + xml: + attribute: false + name: SupportedEnvType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_UpgradeType: + description: '' + properties: + SupportedEnvelope: + description: '' + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + type: array + xml: + attribute: false + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + required: + - SupportedEnvelope + title: soapenv_UpgradeType + type: object + xml: + attribute: false + name: UpgradeType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_detail: + description: '' + title: soapenv_detail + type: object + xml: + attribute: false + name: detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_faultcode: + description: '' + properties: + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + attribute: false + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Value: + allOf: + - $ref: '#/components/schemas/soapenv_faultcodeEnum' + - xml: + attribute: false + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + required: + - Value + title: soapenv_faultcode + type: object + xml: + attribute: false + name: faultcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_faultcodeEnum: + description: '' + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + title: soapenv_faultcodeEnum + type: string + xml: + attribute: false + name: faultcodeEnum + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_faultreason: + description: '' + properties: + Text: + description: '' + items: + $ref: '#/components/schemas/soapenv_reasontext' + type: array + xml: + attribute: false + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + required: + - Text + title: soapenv_faultreason + type: object + xml: + attribute: false + name: faultreason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_reasontext: + description: '' + properties: + lang: + description: "lang (as an attribute name)\n denotes an attribute whose\ + \ value\n is a language code for the natural language of the content\ + \ of\n any element; its value is inherited. This name is reserved\n\ + \ by virtue of its definition in the XML specification." + oneOf: + - type: string + - type: string + xml: + attribute: true + name: lang + prefix: tns1 + wrapped: false + title: soapenv_reasontext + type: object + xml: + attribute: false + name: reasontext + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + soapenv_subcode: + description: '' + properties: + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + attribute: false + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + Value: + type: string + xml: + attribute: false + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + required: + - Value + title: soapenv_subcode + type: object + xml: + attribute: false + name: subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + wrapped: false + tns1_space: + description: '' + enum: + - default + - preserve + title: tns1_space + type: string + xml: + attribute: false + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + wrapped: false + tns_AddIPAddressFilter: + description: '' + properties: + IPAddressFilter: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilter' + - xml: + attribute: false + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - IPAddressFilter + title: tns_AddIPAddressFilter + type: object + xml: + attribute: false + name: AddIPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_AddIPAddressFilterResponse: + description: '' + title: tns_AddIPAddressFilterResponse + type: object + xml: + attribute: false + name: AddIPAddressFilterResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_AddScopes: + description: '' + properties: + ScopeItem: + description: Contains a list of new configurable scope parameters that will + be added to the existing configurable scope. + items: + type: string + xml: + attribute: false + name: ScopeItem + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - ScopeItem + title: tns_AddScopes + type: object + xml: + attribute: false + name: AddScopes + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_AddScopesResponse: + description: '' + title: tns_AddScopesResponse + type: object + xml: + attribute: false + name: AddScopesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_AutoGeoModes: + description: '' + enum: + - Location + - Heading + - Leveling + title: tns_AutoGeoModes + type: string + xml: + attribute: false + name: AutoGeoModes + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_Capabilities: + description: '' + title: tns_Capabilities + type: object + xml: + attribute: false + name: Capabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateCertificate: + description: '' + properties: + CertificateID: + description: Certificate id. + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Subject: + description: Identification of the entity associated with the public-key. + type: string + xml: + attribute: false + name: Subject + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + ValidNotAfter: + description: Certificate expiry start date. + format: date-time + type: string + xml: + attribute: false + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + ValidNotBefore: + description: Certificate validity start date. + format: date-time + type: string + xml: + attribute: false + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_CreateCertificate + type: object + xml: + attribute: false + name: CreateCertificate + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateCertificateResponse: + description: '' + properties: + NvtCertificate: + allOf: + - $ref: '#/components/schemas/tt_Certificate' + - description: base64 encoded DER representation of certificate. + xml: + attribute: false + name: NvtCertificate + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - NvtCertificate + title: tns_CreateCertificateResponse + type: object + xml: + attribute: false + name: CreateCertificateResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateDot1XConfiguration: + description: '' + properties: + Dot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfiguration' + - xml: + attribute: false + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Dot1XConfiguration + title: tns_CreateDot1XConfiguration + type: object + xml: + attribute: false + name: CreateDot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateDot1XConfigurationResponse: + description: '' + title: tns_CreateDot1XConfigurationResponse + type: object + xml: + attribute: false + name: CreateDot1XConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateStorageConfiguration: + description: '' + properties: + StorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_StorageConfigurationData' + - xml: + attribute: false + name: StorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - StorageConfiguration + title: tns_CreateStorageConfiguration + type: object + xml: + attribute: false + name: CreateStorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateStorageConfigurationResponse: + description: '' + properties: + Token: + maxLength: 64 + type: string + xml: + attribute: false + name: Token + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Token + title: tns_CreateStorageConfigurationResponse + type: object + xml: + attribute: false + name: CreateStorageConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateUsers: + description: '' + properties: + User: + 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.' + items: + $ref: '#/components/schemas/tt_User' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - User + title: tns_CreateUsers + type: object + xml: + attribute: false + name: CreateUsers + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_CreateUsersResponse: + description: '' + title: tns_CreateUsersResponse + type: object + xml: + attribute: false + name: CreateUsersResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteCertificates: + description: '' + properties: + CertificateID: + description: List of ids of certificates to delete. + items: + type: string + xml: + attribute: false + name: CertificateID + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - CertificateID + title: tns_DeleteCertificates + type: object + xml: + attribute: false + name: DeleteCertificates + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteCertificatesResponse: + description: '' + title: tns_DeleteCertificatesResponse + type: object + xml: + attribute: false + name: DeleteCertificatesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteDot1XConfiguration: + description: '' + properties: + Dot1XConfigurationToken: + description: '' + items: + maxLength: 64 + type: string + xml: + attribute: false + name: Dot1XConfigurationToken + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_DeleteDot1XConfiguration + type: object + xml: + attribute: false + name: DeleteDot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteDot1XConfigurationResponse: + description: '' + title: tns_DeleteDot1XConfigurationResponse + type: object + xml: + attribute: false + name: DeleteDot1XConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteGeoLocation: + description: '' + properties: + Location: + description: '' + items: + $ref: '#/components/schemas/tt_LocationEntity' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Location + title: tns_DeleteGeoLocation + type: object + xml: + attribute: false + name: DeleteGeoLocation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteGeoLocationResponse: + description: '' + title: tns_DeleteGeoLocationResponse + type: object + xml: + attribute: false + name: DeleteGeoLocationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteStorageConfiguration: + description: '' + properties: + Token: + maxLength: 64 + type: string + xml: + attribute: false + name: Token + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Token + title: tns_DeleteStorageConfiguration + type: object + xml: + attribute: false + name: DeleteStorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteStorageConfigurationResponse: + description: '' + title: tns_DeleteStorageConfigurationResponse + type: object + xml: + attribute: false + name: DeleteStorageConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteUsers: + description: '' + properties: + Username: + 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. + items: + type: string + xml: + attribute: false + name: Username + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Username + title: tns_DeleteUsers + type: object + xml: + attribute: false + name: DeleteUsers + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeleteUsersResponse: + description: '' + title: tns_DeleteUsersResponse + type: object + xml: + attribute: false + name: DeleteUsersResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_DeviceServiceCapabilities: + description: '' + properties: + Misc: + allOf: + - $ref: '#/components/schemas/tns_MiscCapabilities' + - description: Capabilities that do not fit in any of the other categories. + xml: + attribute: false + name: Misc + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tns_NetworkCapabilities' + - description: Network capabilities. + xml: + attribute: false + name: Network + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tns_SecurityCapabilities' + - description: Security capabilities. + xml: + attribute: false + name: Security + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tns_SystemCapabilities' + - description: System capabilities. + xml: + attribute: false + name: System + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Network + - Security + - System + title: tns_DeviceServiceCapabilities + type: object + xml: + attribute: false + name: DeviceServiceCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_Extension: + description: '' + title: tns_Extension + type: object + xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetAccessPolicy: + description: '' + title: tns_GetAccessPolicy + type: object + xml: + attribute: false + name: GetAccessPolicy + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetAccessPolicyResponse: + description: '' + properties: + PolicyFile: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + attribute: false + name: PolicyFile + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - PolicyFile + title: tns_GetAccessPolicyResponse + type: object + xml: + attribute: false + name: GetAccessPolicyResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetAuthFailureWarningConfiguration: + description: '' + title: tns_GetAuthFailureWarningConfiguration + type: object + xml: + attribute: false + name: GetAuthFailureWarningConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetAuthFailureWarningConfigurationResponse: + description: '' + properties: + Enabled: + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MaxAuthFailures: + format: int32 + type: integer + xml: + attribute: false + name: MaxAuthFailures + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MonitorPeriod: + format: int32 + type: integer + xml: + attribute: false + name: MonitorPeriod + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Enabled + - MonitorPeriod + - MaxAuthFailures + title: tns_GetAuthFailureWarningConfigurationResponse + type: object + xml: + attribute: false + name: GetAuthFailureWarningConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetAuthFailureWarningOptions: + description: '' + title: tns_GetAuthFailureWarningOptions + type: object + xml: + attribute: false + name: GetAuthFailureWarningOptions + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetAuthFailureWarningOptionsResponse: + description: '' + properties: + AuthFailureRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - xml: + attribute: false + name: AuthFailureRange + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MonitorPeriodRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - xml: + attribute: false + name: MonitorPeriodRange + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - MonitorPeriodRange + - AuthFailureRange + title: tns_GetAuthFailureWarningOptionsResponse + type: object + xml: + attribute: false + name: GetAuthFailureWarningOptionsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCACertificates: + description: '' + title: tns_GetCACertificates + type: object + xml: + attribute: false + name: GetCACertificates + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCACertificatesResponse: + description: '' + properties: + CACertificate: + description: '' + items: + $ref: '#/components/schemas/tt_Certificate' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetCACertificatesResponse + type: object + xml: + attribute: false + name: GetCACertificatesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCapabilities: + description: '' + properties: + Category: + description: List of categories to retrieve capability information on. + items: + $ref: '#/components/schemas/tt_CapabilityCategory' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetCapabilities + type: object + xml: + attribute: false + name: GetCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCapabilitiesResponse: + description: '' + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tt_Capabilities' + - description: Capability information. + xml: + attribute: false + name: Capabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Capabilities + title: tns_GetCapabilitiesResponse + type: object + xml: + attribute: false + name: GetCapabilitiesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCertificateInformation: + description: '' + properties: + CertificateID: + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - CertificateID + title: tns_GetCertificateInformation + type: object + xml: + attribute: false + name: GetCertificateInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCertificateInformationResponse: + description: '' + properties: + CertificateInformation: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformation' + - xml: + attribute: false + name: CertificateInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - CertificateInformation + title: tns_GetCertificateInformationResponse + type: object + xml: + attribute: false + name: GetCertificateInformationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCertificates: + description: '' + title: tns_GetCertificates + type: object + xml: + attribute: false + name: GetCertificates + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCertificatesResponse: + description: '' + properties: + NvtCertificate: + description: Id and base64 encoded DER representation of all available certificates. + items: + $ref: '#/components/schemas/tt_Certificate' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetCertificatesResponse + type: object + xml: + attribute: false + name: GetCertificatesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCertificatesStatus: + description: '' + title: tns_GetCertificatesStatus + type: object + xml: + attribute: false + name: GetCertificatesStatus + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetCertificatesStatusResponse: + description: '' + properties: + CertificateStatus: + description: Indicates if a certificate is used in an optional HTTPS configuration + of the device. + items: + $ref: '#/components/schemas/tt_CertificateStatus' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetCertificatesStatusResponse + type: object + xml: + attribute: false + name: GetCertificatesStatusResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetClientCertificateMode: + description: '' + title: tns_GetClientCertificateMode + type: object + xml: + attribute: false + name: GetClientCertificateMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetClientCertificateModeResponse: + description: '' + properties: + Enabled: + description: Indicates whether or not client certificates are required by + device. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Enabled + title: tns_GetClientCertificateModeResponse + type: object + xml: + attribute: false + name: GetClientCertificateModeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDNS: + description: '' + title: tns_GetDNS + type: object + xml: + attribute: false + name: GetDNS + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDNSResponse: + description: '' + properties: + DNSInformation: + allOf: + - $ref: '#/components/schemas/tt_DNSInformation' + - description: DNS information. + xml: + attribute: false + name: DNSInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - DNSInformation + title: tns_GetDNSResponse + type: object + xml: + attribute: false + name: GetDNSResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDPAddresses: + description: '' + title: tns_GetDPAddresses + type: object + xml: + attribute: false + name: GetDPAddresses + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDPAddressesResponse: + description: '' + properties: + DPAddress: + description: '' + items: + $ref: '#/components/schemas/tt_NetworkHost' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetDPAddressesResponse + type: object + xml: + attribute: false + name: GetDPAddressesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDeviceInformation: + description: '' + title: tns_GetDeviceInformation + type: object + xml: + attribute: false + name: GetDeviceInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDeviceInformationResponse: + description: '' + properties: + FirmwareVersion: + description: The firmware version in the device. + type: string + xml: + attribute: false + name: FirmwareVersion + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + HardwareId: + description: The hardware ID of the device. + type: string + xml: + attribute: false + name: HardwareId + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Manufacturer: + description: The manufactor of the device. + type: string + xml: + attribute: false + name: Manufacturer + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Model: + description: The device model. + type: string + xml: + attribute: false + name: Model + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SerialNumber: + description: The serial number of the device. + type: string + xml: + attribute: false + name: SerialNumber + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Manufacturer + - Model + - FirmwareVersion + - SerialNumber + - HardwareId + title: tns_GetDeviceInformationResponse + type: object + xml: + attribute: false + name: GetDeviceInformationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDiscoveryMode: + description: '' + title: tns_GetDiscoveryMode + type: object + xml: + attribute: false + name: GetDiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDiscoveryModeResponse: + description: '' + properties: + DiscoveryMode: + allOf: + - $ref: '#/components/schemas/tt_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + xml: + attribute: false + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - DiscoveryMode + title: tns_GetDiscoveryModeResponse + type: object + xml: + attribute: false + name: GetDiscoveryModeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot11Capabilities: + description: '' + title: tns_GetDot11Capabilities + type: object + xml: + attribute: false + name: GetDot11Capabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot11CapabilitiesResponse: + description: '' + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tt_Dot11Capabilities' + - xml: + attribute: false + name: Capabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Capabilities + title: tns_GetDot11CapabilitiesResponse + type: object + xml: + attribute: false + name: GetDot11CapabilitiesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot11Status: + description: '' + properties: + InterfaceToken: + maxLength: 64 + type: string + xml: + attribute: false + name: InterfaceToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - InterfaceToken + title: tns_GetDot11Status + type: object + xml: + attribute: false + name: GetDot11Status + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot11StatusResponse: + description: '' + properties: + Status: + allOf: + - $ref: '#/components/schemas/tt_Dot11Status' + - xml: + attribute: false + name: Status + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Status + title: tns_GetDot11StatusResponse + type: object + xml: + attribute: false + name: GetDot11StatusResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot1XConfiguration: + description: '' + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + attribute: false + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Dot1XConfigurationToken + title: tns_GetDot1XConfiguration + type: object + xml: + attribute: false + name: GetDot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot1XConfigurationResponse: + description: '' + properties: + Dot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfiguration' + - xml: + attribute: false + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Dot1XConfiguration + title: tns_GetDot1XConfigurationResponse + type: object + xml: + attribute: false + name: GetDot1XConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot1XConfigurations: + description: '' + title: tns_GetDot1XConfigurations + type: object + xml: + attribute: false + name: GetDot1XConfigurations + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDot1XConfigurationsResponse: + description: '' + properties: + Dot1XConfiguration: + description: '' + items: + $ref: '#/components/schemas/tt_Dot1XConfiguration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetDot1XConfigurationsResponse + type: object + xml: + attribute: false + name: GetDot1XConfigurationsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDynamicDNS: + description: '' + title: tns_GetDynamicDNS + type: object + xml: + attribute: false + name: GetDynamicDNS + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetDynamicDNSResponse: + description: '' + properties: + DynamicDNSInformation: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformation' + - description: Dynamic DNS information. + xml: + attribute: false + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - DynamicDNSInformation + title: tns_GetDynamicDNSResponse + type: object + xml: + attribute: false + name: GetDynamicDNSResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetEndpointReference: + description: '' + title: tns_GetEndpointReference + type: object + xml: + attribute: false + name: GetEndpointReference + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetEndpointReferenceResponse: + description: '' + properties: + GUID: + type: string + xml: + attribute: false + name: GUID + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - GUID + title: tns_GetEndpointReferenceResponse + type: object + xml: + attribute: false + name: GetEndpointReferenceResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetGeoLocation: + description: '' + title: tns_GetGeoLocation + type: object + xml: + attribute: false + name: GetGeoLocation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetGeoLocationResponse: + description: '' + properties: + Location: + description: '' + items: + $ref: '#/components/schemas/tt_LocationEntity' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetGeoLocationResponse + type: object + xml: + attribute: false + name: GetGeoLocationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetHostname: + description: '' + title: tns_GetHostname + type: object + xml: + attribute: false + name: GetHostname + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetHostnameResponse: + description: '' + properties: + HostnameInformation: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformation' + - description: Contains the hostname information. + xml: + attribute: false + name: HostnameInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - HostnameInformation + title: tns_GetHostnameResponse + type: object + xml: + attribute: false + name: GetHostnameResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetIPAddressFilter: + description: '' + title: tns_GetIPAddressFilter + type: object + xml: + attribute: false + name: GetIPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetIPAddressFilterResponse: + description: '' + properties: + IPAddressFilter: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilter' + - xml: + attribute: false + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - IPAddressFilter + title: tns_GetIPAddressFilterResponse + type: object + xml: + attribute: false + name: GetIPAddressFilterResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNTP: + description: '' + title: tns_GetNTP + type: object + xml: + attribute: false + name: GetNTP + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNTPResponse: + description: '' + properties: + NTPInformation: + allOf: + - $ref: '#/components/schemas/tt_NTPInformation' + - description: NTP information. + xml: + attribute: false + name: NTPInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - NTPInformation + title: tns_GetNTPResponse + type: object + xml: + attribute: false + name: GetNTPResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNetworkDefaultGateway: + description: '' + title: tns_GetNetworkDefaultGateway + type: object + xml: + attribute: false + name: GetNetworkDefaultGateway + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNetworkDefaultGatewayResponse: + description: '' + properties: + NetworkGateway: + allOf: + - $ref: '#/components/schemas/tt_NetworkGateway' + - description: Gets the default IPv4 and IPv6 gateway settings from the + device. + xml: + attribute: false + name: NetworkGateway + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - NetworkGateway + title: tns_GetNetworkDefaultGatewayResponse + type: object + xml: + attribute: false + name: GetNetworkDefaultGatewayResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNetworkInterfaces: + description: '' + title: tns_GetNetworkInterfaces + type: object + xml: + attribute: false + name: GetNetworkInterfaces + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNetworkInterfacesResponse: + description: '' + properties: + NetworkInterfaces: + description: List of network interfaces. + items: + $ref: '#/components/schemas/tt_NetworkInterface' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - NetworkInterfaces + title: tns_GetNetworkInterfacesResponse + type: object + xml: + attribute: false + name: GetNetworkInterfacesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNetworkProtocols: + description: '' + title: tns_GetNetworkProtocols + type: object + xml: + attribute: false + name: GetNetworkProtocols + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetNetworkProtocolsResponse: + description: '' + properties: + NetworkProtocols: + 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.' + items: + $ref: '#/components/schemas/tt_NetworkProtocol' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetNetworkProtocolsResponse + type: object + xml: + attribute: false + name: GetNetworkProtocolsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPasswordComplexityConfiguration: + description: '' + title: tns_GetPasswordComplexityConfiguration + type: object + xml: + attribute: false + name: GetPasswordComplexityConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPasswordComplexityConfigurationResponse: + description: '' + properties: + BlockUsernameOccurrence: + type: boolean + xml: + attribute: false + name: BlockUsernameOccurrence + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MinLen: + format: int32 + type: integer + xml: + attribute: false + name: MinLen + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Number: + format: int32 + type: integer + xml: + attribute: false + name: Number + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + PolicyConfigurationLocked: + type: boolean + xml: + attribute: false + name: PolicyConfigurationLocked + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SpecialChars: + format: int32 + type: integer + xml: + attribute: false + name: SpecialChars + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Uppercase: + format: int32 + type: integer + xml: + attribute: false + name: Uppercase + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetPasswordComplexityConfigurationResponse + type: object + xml: + attribute: false + name: GetPasswordComplexityConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPasswordComplexityOptions: + description: '' + title: tns_GetPasswordComplexityOptions + type: object + xml: + attribute: false + name: GetPasswordComplexityOptions + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPasswordComplexityOptionsResponse: + description: '' + properties: + BlockUsernameOccurrenceSupported: + type: boolean + xml: + attribute: false + name: BlockUsernameOccurrenceSupported + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MinLenRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - xml: + attribute: false + name: MinLenRange + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + NumberRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - xml: + attribute: false + name: NumberRange + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + PolicyConfigurationLockSupported: + type: boolean + xml: + attribute: false + name: PolicyConfigurationLockSupported + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SpecialCharsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - xml: + attribute: false + name: SpecialCharsRange + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + UppercaseRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - xml: + attribute: false + name: UppercaseRange + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetPasswordComplexityOptionsResponse + type: object + xml: + attribute: false + name: GetPasswordComplexityOptionsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPasswordHistoryConfiguration: + description: '' + title: tns_GetPasswordHistoryConfiguration + type: object + xml: + attribute: false + name: GetPasswordHistoryConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPasswordHistoryConfigurationResponse: + description: '' + properties: + Enabled: + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Length: + format: int32 + type: integer + xml: + attribute: false + name: Length + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Enabled + - Length + title: tns_GetPasswordHistoryConfigurationResponse + type: object + xml: + attribute: false + name: GetPasswordHistoryConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPkcs10Request: + description: '' + properties: + Attributes: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: Optional base64 encoded DER attributes. + xml: + attribute: false + name: Attributes + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + CertificateID: + description: List of ids of certificates to delete. + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Subject: + description: Relative Dinstinguished Name(RDN) CommonName(CN). + type: string + xml: + attribute: false + name: Subject + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - CertificateID + title: tns_GetPkcs10Request + type: object + xml: + attribute: false + name: GetPkcs10Request + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetPkcs10RequestResponse: + description: '' + properties: + Pkcs10Request: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + attribute: false + name: Pkcs10Request + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Pkcs10Request + title: tns_GetPkcs10RequestResponse + type: object + xml: + attribute: false + name: GetPkcs10RequestResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetRelayOutputs: + description: '' + title: tns_GetRelayOutputs + type: object + xml: + attribute: false + name: GetRelayOutputs + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetRelayOutputsResponse: + description: '' + properties: + RelayOutputs: + description: '' + items: + $ref: '#/components/schemas/tt_RelayOutput' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetRelayOutputsResponse + type: object + xml: + attribute: false + name: GetRelayOutputsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetRemoteDiscoveryMode: + description: '' + title: tns_GetRemoteDiscoveryMode + type: object + xml: + attribute: false + name: GetRemoteDiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetRemoteDiscoveryModeResponse: + description: '' + properties: + RemoteDiscoveryMode: + allOf: + - $ref: '#/components/schemas/tt_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + xml: + attribute: false + name: RemoteDiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - RemoteDiscoveryMode + title: tns_GetRemoteDiscoveryModeResponse + type: object + xml: + attribute: false + name: GetRemoteDiscoveryModeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetRemoteUser: + description: '' + title: tns_GetRemoteUser + type: object + xml: + attribute: false + name: GetRemoteUser + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetRemoteUserResponse: + description: '' + properties: + RemoteUser: + allOf: + - $ref: '#/components/schemas/tt_RemoteUser' + - xml: + attribute: false + name: RemoteUser + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetRemoteUserResponse + type: object + xml: + attribute: false + name: GetRemoteUserResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetScopes: + description: '' + title: tns_GetScopes + type: object + xml: + attribute: false + name: GetScopes + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetScopesResponse: + description: '' + properties: + Scopes: + 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.' + items: + $ref: '#/components/schemas/tt_Scope' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Scopes + title: tns_GetScopesResponse + type: object + xml: + attribute: false + name: GetScopesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetServiceCapabilities: + description: '' + title: tns_GetServiceCapabilities + type: object + xml: + attribute: false + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetServiceCapabilitiesResponse: + description: '' + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_DeviceServiceCapabilities' + - description: The capabilities for the device service is returned in the + Capabilities element. + xml: + attribute: false + name: Capabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Capabilities + title: tns_GetServiceCapabilitiesResponse + type: object + xml: + attribute: false + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetServices: + description: '' + properties: + IncludeCapability: + description: Indicates if the service capabilities (untyped) should be included + in the response. + type: boolean + xml: + attribute: false + name: IncludeCapability + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - IncludeCapability + title: tns_GetServices + type: object + xml: + attribute: false + name: GetServices + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetServicesResponse: + description: '' + properties: + Service: + description: Each Service element contains information about one service. + items: + $ref: '#/components/schemas/tns_Service' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Service + title: tns_GetServicesResponse + type: object + xml: + attribute: false + name: GetServicesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetStorageConfiguration: + description: '' + properties: + Token: + maxLength: 64 + type: string + xml: + attribute: false + name: Token + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Token + title: tns_GetStorageConfiguration + type: object + xml: + attribute: false + name: GetStorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetStorageConfigurationResponse: + description: '' + properties: + StorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_StorageConfiguration' + - xml: + attribute: false + name: StorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - StorageConfiguration + title: tns_GetStorageConfigurationResponse + type: object + xml: + attribute: false + name: GetStorageConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetStorageConfigurations: + description: '' + title: tns_GetStorageConfigurations + type: object + xml: + attribute: false + name: GetStorageConfigurations + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetStorageConfigurationsResponse: + description: '' + properties: + StorageConfigurations: + description: '' + items: + $ref: '#/components/schemas/tns_StorageConfiguration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetStorageConfigurationsResponse + type: object + xml: + attribute: false + name: GetStorageConfigurationsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemBackup: + description: '' + title: tns_GetSystemBackup + type: object + xml: + attribute: false + name: GetSystemBackup + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemBackupResponse: + description: '' + properties: + BackupFiles: + description: '' + items: + $ref: '#/components/schemas/tt_BackupFile' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - BackupFiles + title: tns_GetSystemBackupResponse + type: object + xml: + attribute: false + name: GetSystemBackupResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemDateAndTime: + description: '' + title: tns_GetSystemDateAndTime + type: object + xml: + attribute: false + name: GetSystemDateAndTime + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemDateAndTimeResponse: + description: '' + properties: + SystemDateAndTime: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTime' + - 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. + xml: + attribute: false + name: SystemDateAndTime + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - SystemDateAndTime + title: tns_GetSystemDateAndTimeResponse + type: object + xml: + attribute: false + name: GetSystemDateAndTimeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemLog: + description: '' + properties: + LogType: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - description: Specifies the type of system log to get. + xml: + attribute: false + name: LogType + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - LogType + title: tns_GetSystemLog + type: object + xml: + attribute: false + name: GetSystemLog + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemLogResponse: + description: '' + properties: + SystemLog: + allOf: + - $ref: '#/components/schemas/tt_SystemLog' + - description: Contains the system log information. + xml: + attribute: false + name: SystemLog + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - SystemLog + title: tns_GetSystemLogResponse + type: object + xml: + attribute: false + name: GetSystemLogResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemSupportInformation: + description: '' + title: tns_GetSystemSupportInformation + type: object + xml: + attribute: false + name: GetSystemSupportInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemSupportInformationResponse: + description: '' + properties: + SupportInformation: + allOf: + - $ref: '#/components/schemas/tt_SupportInformation' + - description: Contains the arbitary device diagnostics information. + xml: + attribute: false + name: SupportInformation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - SupportInformation + title: tns_GetSystemSupportInformationResponse + type: object + xml: + attribute: false + name: GetSystemSupportInformationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemUris: + description: '' + title: tns_GetSystemUris + type: object + xml: + attribute: false + name: GetSystemUris + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetSystemUrisResponse: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tns_Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SupportInfoUri: + type: string + xml: + attribute: false + name: SupportInfoUri + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SystemBackupUri: + type: string + xml: + attribute: false + name: SystemBackupUri + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SystemLogUris: + allOf: + - $ref: '#/components/schemas/tt_SystemLogUriList' + - xml: + attribute: false + name: SystemLogUris + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetSystemUrisResponse + type: object + xml: + attribute: false + name: GetSystemUrisResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetUsers: + description: '' + title: tns_GetUsers + type: object + xml: + attribute: false + name: GetUsers + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetUsersResponse: + description: '' + properties: + User: + description: 'Contains a list of the onvif users and following information + is included in each entry: username and user level.' + items: + $ref: '#/components/schemas/tt_User' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_GetUsersResponse + type: object + xml: + attribute: false + name: GetUsersResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetWsdlUrl: + description: '' + title: tns_GetWsdlUrl + type: object + xml: + attribute: false + name: GetWsdlUrl + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetWsdlUrlResponse: + description: '' + properties: + WsdlUrl: + type: string + xml: + attribute: false + name: WsdlUrl + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - WsdlUrl + title: tns_GetWsdlUrlResponse + type: object + xml: + attribute: false + name: GetWsdlUrlResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetZeroConfiguration: + description: '' + title: tns_GetZeroConfiguration + type: object + xml: + attribute: false + name: GetZeroConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_GetZeroConfigurationResponse: + description: '' + properties: + ZeroConfiguration: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + - description: Contains the zero-configuration. + xml: + attribute: false + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - ZeroConfiguration + title: tns_GetZeroConfigurationResponse + type: object + xml: + attribute: false + name: GetZeroConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_LoadCACertificates: + description: '' + properties: + CACertificate: + description: '' + items: + $ref: '#/components/schemas/tt_Certificate' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - CACertificate + title: tns_LoadCACertificates + type: object + xml: + attribute: false + name: LoadCACertificates + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_LoadCACertificatesResponse: + description: '' + title: tns_LoadCACertificatesResponse + type: object + xml: + attribute: false + name: LoadCACertificatesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_LoadCertificateWithPrivateKey: + description: '' + properties: + CertificateWithPrivateKey: + description: '' + items: + $ref: '#/components/schemas/tt_CertificateWithPrivateKey' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - CertificateWithPrivateKey + title: tns_LoadCertificateWithPrivateKey + type: object + xml: + attribute: false + name: LoadCertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_LoadCertificateWithPrivateKeyResponse: + description: '' + title: tns_LoadCertificateWithPrivateKeyResponse + type: object + xml: + attribute: false + name: LoadCertificateWithPrivateKeyResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_LoadCertificates: + description: '' + properties: + NVTCertificate: + description: Optional id and base64 encoded DER representation of certificate. + items: + $ref: '#/components/schemas/tt_Certificate' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - NVTCertificate + title: tns_LoadCertificates + type: object + xml: + attribute: false + name: LoadCertificates + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_LoadCertificatesResponse: + description: '' + title: tns_LoadCertificatesResponse + type: object + xml: + attribute: false + name: LoadCertificatesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_MiscCapabilities: + description: '' + properties: + AuxiliaryCommands: + description: Lists of commands supported by SendAuxiliaryCommand. + type: string + xml: + attribute: true + name: AuxiliaryCommands + prefix: tns + wrapped: false + title: tns_MiscCapabilities + type: object + xml: + attribute: false + name: MiscCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_NetworkCapabilities: + description: '' + properties: + DHCPv6: + description: Indicates support for Stateful IPv6 DHCP. + type: boolean + xml: + attribute: true + name: DHCPv6 + prefix: tns + wrapped: false + Dot11Configuration: + description: Indicates support for IEEE 802.11 configuration. + type: boolean + xml: + attribute: true + name: Dot11Configuration + prefix: tns + wrapped: false + Dot1XConfigurations: + description: Indicates the maximum number of Dot1X configurations supported + by the device + format: int32 + type: integer + xml: + attribute: true + name: Dot1XConfigurations + prefix: tns + wrapped: false + DynDNS: + description: Indicates support for dynamic DNS configuration. + type: boolean + xml: + attribute: true + name: DynDNS + prefix: tns + wrapped: false + HostnameFromDHCP: + description: Indicates support for retrieval of hostname from DHCP. + type: boolean + xml: + attribute: true + name: HostnameFromDHCP + prefix: tns + wrapped: false + IPFilter: + description: Indicates support for IP filtering. + type: boolean + xml: + attribute: true + name: IPFilter + prefix: tns + wrapped: false + IPVersion6: + description: Indicates support for IPv6. + type: boolean + xml: + attribute: true + name: IPVersion6 + prefix: tns + wrapped: false + NTP: + description: Maximum number of NTP servers supported by the devices SetNTP + command. + format: int32 + type: integer + xml: + attribute: true + name: NTP + prefix: tns + wrapped: false + ZeroConfiguration: + description: Indicates support for zeroconf. + type: boolean + xml: + attribute: true + name: ZeroConfiguration + prefix: tns + wrapped: false + title: tns_NetworkCapabilities + type: object + xml: + attribute: false + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_RemoveIPAddressFilter: + description: '' + properties: + IPAddressFilter: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilter' + - xml: + attribute: false + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - IPAddressFilter + title: tns_RemoveIPAddressFilter + type: object + xml: + attribute: false + name: RemoveIPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_RemoveIPAddressFilterResponse: + description: '' + title: tns_RemoveIPAddressFilterResponse + type: object + xml: + attribute: false + name: RemoveIPAddressFilterResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_RemoveScopes: + description: '' + properties: + ScopeItem: + description: Contains a list of URIs that should be removed from the device + scope. + items: + type: string + xml: + attribute: false + name: ScopeItem + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - ScopeItem + title: tns_RemoveScopes + type: object + xml: + attribute: false + name: RemoveScopes + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_RemoveScopesResponse: + description: '' + properties: + ScopeItem: + description: Contains a list of URIs that has been removed from the device + scope + items: + type: string + xml: + attribute: false + name: ScopeItem + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_RemoveScopesResponse + type: object + xml: + attribute: false + name: RemoveScopesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_RestoreSystem: + description: '' + properties: + BackupFiles: + description: '' + items: + $ref: '#/components/schemas/tt_BackupFile' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - BackupFiles + title: tns_RestoreSystem + type: object + xml: + attribute: false + name: RestoreSystem + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_RestoreSystemResponse: + description: '' + title: tns_RestoreSystemResponse + type: object + xml: + attribute: false + name: RestoreSystemResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_ScanAvailableDot11Networks: + description: '' + properties: + InterfaceToken: + maxLength: 64 + type: string + xml: + attribute: false + name: InterfaceToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - InterfaceToken + title: tns_ScanAvailableDot11Networks + type: object + xml: + attribute: false + name: ScanAvailableDot11Networks + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_ScanAvailableDot11NetworksResponse: + description: '' + properties: + Networks: + description: '' + items: + $ref: '#/components/schemas/tt_Dot11AvailableNetworks' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_ScanAvailableDot11NetworksResponse + type: object + xml: + attribute: false + name: ScanAvailableDot11NetworksResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SecurityCapabilities: + description: '' + properties: + AccessPolicyConfig: + description: Indicates support for access policy configuration. + type: boolean + xml: + attribute: true + name: AccessPolicyConfig + prefix: tns + wrapped: false + DefaultAccessPolicy: + description: Indicates support for the ONVIF default access policy. + type: boolean + xml: + attribute: true + name: DefaultAccessPolicy + prefix: tns + wrapped: false + Dot1X: + description: Indicates support for IEEE 802.1X configuration. + type: boolean + xml: + attribute: true + name: Dot1X + prefix: tns + wrapped: false + HttpDigest: + description: Indicates support for WS over HTTP digest authenticated communication + layer. + type: boolean + xml: + attribute: true + name: HttpDigest + prefix: tns + wrapped: false + KerberosToken: + description: Indicates support for WS-Security Kerberos token. + type: boolean + xml: + attribute: true + name: KerberosToken + prefix: tns + wrapped: false + MaxPasswordHistory: + description: Maximum number of passwords that the device can remember for + each user + format: int32 + type: integer + xml: + attribute: true + name: MaxPasswordHistory + prefix: tns + wrapped: false + MaxPasswordLength: + description: Maximum number of characters supported for the password by + CreateUsers and SetUser. + format: int32 + type: integer + xml: + attribute: true + name: MaxPasswordLength + prefix: tns + wrapped: false + MaxUserNameLength: + description: Maximum number of characters supported for the username by + CreateUsers. + format: int32 + type: integer + xml: + attribute: true + name: MaxUserNameLength + prefix: tns + wrapped: false + MaxUsers: + description: The maximum number of users that the device supports. + format: int32 + type: integer + xml: + attribute: true + name: MaxUsers + prefix: tns + wrapped: false + OnboardKeyGeneration: + description: Indicates support for onboard key generation. + type: boolean + xml: + attribute: true + name: OnboardKeyGeneration + prefix: tns + wrapped: false + RELToken: + description: Indicates support for WS-Security REL token. + type: boolean + xml: + attribute: true + name: RELToken + prefix: tns + wrapped: false + RemoteUserHandling: + description: Indicates support for remote user configuration. Used when + accessing another device. + type: boolean + xml: + attribute: true + name: RemoteUserHandling + prefix: tns + wrapped: false + SAMLToken: + description: Indicates support for WS-Security SAML token. + type: boolean + xml: + attribute: true + name: SAMLToken + prefix: tns + wrapped: false + SecurityPolicies: + description: 'Indicates which security policies are supported. Options are: + ModifyPassword, PasswordComplexity, AuthFailureWarnings' + type: string + xml: + attribute: true + name: SecurityPolicies + prefix: tns + wrapped: false + SupportedEAPMethods: + description: EAP Methods supported by the device. The int values refer to + the + format: int32 + type: integer + xml: + attribute: true + name: SupportedEAPMethods + prefix: tns + wrapped: false + TLS1.0: + description: Indicates support for TLS 1.0. + type: boolean + xml: + attribute: true + name: TLS1.0 + prefix: tns + wrapped: false + TLS1.1: + description: Indicates support for TLS 1.1. + type: boolean + xml: + attribute: true + name: TLS1.1 + prefix: tns + wrapped: false + TLS1.2: + description: Indicates support for TLS 1.2. + type: boolean + xml: + attribute: true + name: TLS1.2 + prefix: tns + wrapped: false + UsernameToken: + description: Indicates support for WS-Security Username token. + type: boolean + xml: + attribute: true + name: UsernameToken + prefix: tns + wrapped: false + X.509Token: + description: Indicates support for WS-Security X.509 token. + type: boolean + xml: + attribute: true + name: X.509Token + prefix: tns + wrapped: false + title: tns_SecurityCapabilities + type: object + xml: + attribute: false + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SendAuxiliaryCommand: + description: '' + properties: + AuxiliaryCommand: + maxLength: 128 + type: string + xml: + attribute: false + name: AuxiliaryCommand + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - AuxiliaryCommand + title: tns_SendAuxiliaryCommand + type: object + xml: + attribute: false + name: SendAuxiliaryCommand + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SendAuxiliaryCommandResponse: + description: '' + properties: + AuxiliaryCommandResponse: + maxLength: 128 + type: string + xml: + attribute: false + name: AuxiliaryCommandResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_SendAuxiliaryCommandResponse + type: object + xml: + attribute: false + name: SendAuxiliaryCommandResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_Service: + description: '' + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities' + - xml: + attribute: false + name: Capabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Namespace: + 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. + type: string + xml: + attribute: false + name: Namespace + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Version: + allOf: + - $ref: '#/components/schemas/tt_OnvifVersion' + - description: The version of the service (not the ONVIF core spec version). + xml: + attribute: false + name: Version + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + XAddr: + 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). + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Namespace + - XAddr + - Version + title: tns_Service + type: object + xml: + attribute: false + name: Service + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetAccessPolicy: + description: '' + properties: + PolicyFile: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + attribute: false + name: PolicyFile + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - PolicyFile + title: tns_SetAccessPolicy + type: object + xml: + attribute: false + name: SetAccessPolicy + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetAccessPolicyResponse: + description: '' + title: tns_SetAccessPolicyResponse + type: object + xml: + attribute: false + name: SetAccessPolicyResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetAuthFailureWarningConfiguration: + description: '' + properties: + Enabled: + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MaxAuthFailures: + format: int32 + type: integer + xml: + attribute: false + name: MaxAuthFailures + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MonitorPeriod: + format: int32 + type: integer + xml: + attribute: false + name: MonitorPeriod + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Enabled + - MonitorPeriod + - MaxAuthFailures + title: tns_SetAuthFailureWarningConfiguration + type: object + xml: + attribute: false + name: SetAuthFailureWarningConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetAuthFailureWarningConfigurationResponse: + description: '' + title: tns_SetAuthFailureWarningConfigurationResponse + type: object + xml: + attribute: false + name: SetAuthFailureWarningConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetCertificatesStatus: + description: '' + properties: + CertificateStatus: + description: Indicates if a certificate is to be used in an optional HTTPS + configuration of the device. + items: + $ref: '#/components/schemas/tt_CertificateStatus' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_SetCertificatesStatus + type: object + xml: + attribute: false + name: SetCertificatesStatus + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetCertificatesStatusResponse: + description: '' + title: tns_SetCertificatesStatusResponse + type: object + xml: + attribute: false + name: SetCertificatesStatusResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetClientCertificateMode: + description: '' + properties: + Enabled: + description: Indicates whether or not client certificates are required by + device. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Enabled + title: tns_SetClientCertificateMode + type: object + xml: + attribute: false + name: SetClientCertificateMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetClientCertificateModeResponse: + description: '' + title: tns_SetClientCertificateModeResponse + type: object + xml: + attribute: false + name: SetClientCertificateModeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDNS: + description: '' + properties: + DNSManual: + description: DNS address(es) set manually. + items: + $ref: '#/components/schemas/tt_IPAddress' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + FromDHCP: + description: Indicate if the DNS address is to be retrieved using DHCP. + type: boolean + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SearchDomain: + description: DNS search domain. + items: + type: string + xml: + attribute: false + name: SearchDomain + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - FromDHCP + title: tns_SetDNS + type: object + xml: + attribute: false + name: SetDNS + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDNSResponse: + description: '' + title: tns_SetDNSResponse + type: object + xml: + attribute: false + name: SetDNSResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDPAddresses: + description: '' + properties: + DPAddress: + description: '' + items: + $ref: '#/components/schemas/tt_NetworkHost' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_SetDPAddresses + type: object + xml: + attribute: false + name: SetDPAddresses + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDPAddressesResponse: + description: '' + title: tns_SetDPAddressesResponse + type: object + xml: + attribute: false + name: SetDPAddressesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDiscoveryMode: + description: '' + properties: + DiscoveryMode: + allOf: + - $ref: '#/components/schemas/tt_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + xml: + attribute: false + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - DiscoveryMode + title: tns_SetDiscoveryMode + type: object + xml: + attribute: false + name: SetDiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDiscoveryModeResponse: + description: '' + title: tns_SetDiscoveryModeResponse + type: object + xml: + attribute: false + name: SetDiscoveryModeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDot1XConfiguration: + description: '' + properties: + Dot1XConfiguration: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfiguration' + - xml: + attribute: false + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Dot1XConfiguration + title: tns_SetDot1XConfiguration + type: object + xml: + attribute: false + name: SetDot1XConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDot1XConfigurationResponse: + description: '' + title: tns_SetDot1XConfigurationResponse + type: object + xml: + attribute: false + name: SetDot1XConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDynamicDNS: + description: '' + properties: + Name: + description: DNS name. + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + TTL: + description: DNS record time to live. + format: date-time + type: string + xml: + attribute: false + name: TTL + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Type + title: tns_SetDynamicDNS + type: object + xml: + attribute: false + name: SetDynamicDNS + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetDynamicDNSResponse: + description: '' + title: tns_SetDynamicDNSResponse + type: object + xml: + attribute: false + name: SetDynamicDNSResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetGeoLocation: + description: '' + properties: + Location: + description: '' + items: + $ref: '#/components/schemas/tt_LocationEntity' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Location + title: tns_SetGeoLocation + type: object + xml: + attribute: false + name: SetGeoLocation + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetGeoLocationResponse: + description: '' + title: tns_SetGeoLocationResponse + type: object + xml: + attribute: false + name: SetGeoLocationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetHostname: + description: '' + properties: + Name: + description: The hostname to set. + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Name + title: tns_SetHostname + type: object + xml: + attribute: false + name: SetHostname + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetHostnameFromDHCP: + description: '' + properties: + FromDHCP: + description: True if the hostname shall be obtained via DHCP. + type: boolean + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - FromDHCP + title: tns_SetHostnameFromDHCP + type: object + xml: + attribute: false + name: SetHostnameFromDHCP + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetHostnameFromDHCPResponse: + description: '' + properties: + RebootNeeded: + description: Indicates whether or not a reboot is required after configuration + updates. + type: boolean + xml: + attribute: false + name: RebootNeeded + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - RebootNeeded + title: tns_SetHostnameFromDHCPResponse + type: object + xml: + attribute: false + name: SetHostnameFromDHCPResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetHostnameResponse: + description: '' + title: tns_SetHostnameResponse + type: object + xml: + attribute: false + name: SetHostnameResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetIPAddressFilter: + description: '' + properties: + IPAddressFilter: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilter' + - xml: + attribute: false + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - IPAddressFilter + title: tns_SetIPAddressFilter + type: object + xml: + attribute: false + name: SetIPAddressFilter + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetIPAddressFilterResponse: + description: '' + title: tns_SetIPAddressFilterResponse + type: object + xml: + attribute: false + name: SetIPAddressFilterResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNTP: + description: '' + properties: + FromDHCP: + description: Indicate if NTP address information is to be retrieved using + DHCP. + type: boolean + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + NTPManual: + description: Manual NTP settings. + items: + $ref: '#/components/schemas/tt_NetworkHost' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - FromDHCP + title: tns_SetNTP + type: object + xml: + attribute: false + name: SetNTP + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNTPResponse: + description: '' + title: tns_SetNTPResponse + type: object + xml: + attribute: false + name: SetNTPResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNetworkDefaultGateway: + description: '' + properties: + IPv4Address: + description: Sets IPv4 gateway address used as default setting. + items: + type: string + xml: + attribute: false + name: IPv4Address + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + IPv6Address: + description: Sets IPv6 gateway address used as default setting. + items: + type: string + xml: + attribute: false + name: IPv6Address + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_SetNetworkDefaultGateway + type: object + xml: + attribute: false + name: SetNetworkDefaultGateway + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNetworkDefaultGatewayResponse: + description: '' + title: tns_SetNetworkDefaultGatewayResponse + type: object + xml: + attribute: false + name: SetNetworkDefaultGatewayResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNetworkInterfaces: + description: '' + properties: + InterfaceToken: + description: Symbolic network interface name. + maxLength: 64 + type: string + xml: + attribute: false + name: InterfaceToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + NetworkInterface: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfiguration' + - description: Network interface name. + xml: + attribute: false + name: NetworkInterface + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - InterfaceToken + - NetworkInterface + title: tns_SetNetworkInterfaces + type: object + xml: + attribute: false + name: SetNetworkInterfaces + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNetworkInterfacesResponse: + description: '' + properties: + RebootNeeded: + 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." + type: boolean + xml: + attribute: false + name: RebootNeeded + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - RebootNeeded + title: tns_SetNetworkInterfacesResponse + type: object + xml: + attribute: false + name: SetNetworkInterfacesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNetworkProtocols: + description: '' + properties: + NetworkProtocols: + 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.' + items: + $ref: '#/components/schemas/tt_NetworkProtocol' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - NetworkProtocols + title: tns_SetNetworkProtocols + type: object + xml: + attribute: false + name: SetNetworkProtocols + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetNetworkProtocolsResponse: + description: '' + title: tns_SetNetworkProtocolsResponse + type: object + xml: + attribute: false + name: SetNetworkProtocolsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetPasswordComplexityConfiguration: + description: '' + properties: + BlockUsernameOccurrence: + type: boolean + xml: + attribute: false + name: BlockUsernameOccurrence + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + MinLen: + format: int32 + type: integer + xml: + attribute: false + name: MinLen + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Number: + format: int32 + type: integer + xml: + attribute: false + name: Number + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + PolicyConfigurationLocked: + type: boolean + xml: + attribute: false + name: PolicyConfigurationLocked + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + SpecialChars: + format: int32 + type: integer + xml: + attribute: false + name: SpecialChars + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Uppercase: + format: int32 + type: integer + xml: + attribute: false + name: Uppercase + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_SetPasswordComplexityConfiguration + type: object + xml: + attribute: false + name: SetPasswordComplexityConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetPasswordComplexityConfigurationResponse: + description: '' + title: tns_SetPasswordComplexityConfigurationResponse + type: object + xml: + attribute: false + name: SetPasswordComplexityConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetPasswordHistoryConfiguration: + description: '' + properties: + Enabled: + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Length: + format: int32 + type: integer + xml: + attribute: false + name: Length + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Enabled + - Length + title: tns_SetPasswordHistoryConfiguration + type: object + xml: + attribute: false + name: SetPasswordHistoryConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetPasswordHistoryConfigurationResponse: + description: '' + title: tns_SetPasswordHistoryConfigurationResponse + type: object + xml: + attribute: false + name: SetPasswordHistoryConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRelayOutputSettings: + description: '' + properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + attribute: false + name: Properties + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + RelayOutputToken: + maxLength: 64 + type: string + xml: + attribute: false + name: RelayOutputToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - RelayOutputToken + - Properties + title: tns_SetRelayOutputSettings + type: object + xml: + attribute: false + name: SetRelayOutputSettings + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRelayOutputSettingsResponse: + description: '' + title: tns_SetRelayOutputSettingsResponse + type: object + xml: + attribute: false + name: SetRelayOutputSettingsResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRelayOutputState: + description: '' + properties: + LogicalState: + allOf: + - $ref: '#/components/schemas/tt_RelayLogicalState' + - xml: + attribute: false + name: LogicalState + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + RelayOutputToken: + maxLength: 64 + type: string + xml: + attribute: false + name: RelayOutputToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - RelayOutputToken + - LogicalState + title: tns_SetRelayOutputState + type: object + xml: + attribute: false + name: SetRelayOutputState + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRelayOutputStateResponse: + description: '' + title: tns_SetRelayOutputStateResponse + type: object + xml: + attribute: false + name: SetRelayOutputStateResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRemoteDiscoveryMode: + description: '' + properties: + RemoteDiscoveryMode: + allOf: + - $ref: '#/components/schemas/tt_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + xml: + attribute: false + name: RemoteDiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - RemoteDiscoveryMode + title: tns_SetRemoteDiscoveryMode + type: object + xml: + attribute: false + name: SetRemoteDiscoveryMode + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRemoteDiscoveryModeResponse: + description: '' + title: tns_SetRemoteDiscoveryModeResponse + type: object + xml: + attribute: false + name: SetRemoteDiscoveryModeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRemoteUser: + description: '' + properties: + RemoteUser: + allOf: + - $ref: '#/components/schemas/tt_RemoteUser' + - xml: + attribute: false + name: RemoteUser + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_SetRemoteUser + type: object + xml: + attribute: false + name: SetRemoteUser + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetRemoteUserResponse: + description: '' + title: tns_SetRemoteUserResponse + type: object + xml: + attribute: false + name: SetRemoteUserResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetScopes: + description: '' + properties: + Scopes: + description: Contains a list of scope parameters that will replace all existing + configurable scope parameters. + items: + type: string + xml: + attribute: false + name: Scopes + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Scopes + title: tns_SetScopes + type: object + xml: + attribute: false + name: SetScopes + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetScopesResponse: + description: '' + title: tns_SetScopesResponse + type: object + xml: + attribute: false + name: SetScopesResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetStorageConfiguration: + description: '' + properties: + StorageConfiguration: + allOf: + - $ref: '#/components/schemas/tns_StorageConfiguration' + - xml: + attribute: false + name: StorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - StorageConfiguration + title: tns_SetStorageConfiguration + type: object + xml: + attribute: false + name: SetStorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetStorageConfigurationResponse: + description: '' + title: tns_SetStorageConfigurationResponse + type: object + xml: + attribute: false + name: SetStorageConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetSystemDateAndTime: + description: '' + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Defines if the date and time is set via NTP or manually. + xml: + attribute: false + name: DateTimeType + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + DaylightSavings: + description: Automatically adjust Daylight savings if defined in TimeZone. + type: boolean + xml: + attribute: false + name: DaylightSavings + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: The time zone in POSIX 1003.1 format + xml: + attribute: false + name: TimeZone + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in UTC. If time is obtained via NTP, UTCDateTime + has no meaning + xml: + attribute: false + name: UTCDateTime + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - DateTimeType + - DaylightSavings + title: tns_SetSystemDateAndTime + type: object + xml: + attribute: false + name: SetSystemDateAndTime + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetSystemDateAndTimeResponse: + description: '' + title: tns_SetSystemDateAndTimeResponse + type: object + xml: + attribute: false + name: SetSystemDateAndTimeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetSystemFactoryDefault: + description: '' + properties: + FactoryDefault: + allOf: + - $ref: '#/components/schemas/tt_FactoryDefaultType' + - description: Specifies the factory default action type. + xml: + attribute: false + name: FactoryDefault + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - FactoryDefault + title: tns_SetSystemFactoryDefault + type: object + xml: + attribute: false + name: SetSystemFactoryDefault + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetSystemFactoryDefaultResponse: + description: '' + title: tns_SetSystemFactoryDefaultResponse + type: object + xml: + attribute: false + name: SetSystemFactoryDefaultResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetUser: + description: '' + properties: + User: + 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. + items: + $ref: '#/components/schemas/tt_User' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - User + title: tns_SetUser + type: object + xml: + attribute: false + name: SetUser + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetUserResponse: + description: '' + title: tns_SetUserResponse + type: object + xml: + attribute: false + name: SetUserResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetZeroConfiguration: + description: '' + properties: + Enabled: + description: Specifies if the zero-configuration should be enabled or not. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + InterfaceToken: + description: Unique identifier referencing the physical interface. + maxLength: 64 + type: string + xml: + attribute: false + name: InterfaceToken + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - InterfaceToken + - Enabled + title: tns_SetZeroConfiguration + type: object + xml: + attribute: false + name: SetZeroConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SetZeroConfigurationResponse: + description: '' + title: tns_SetZeroConfigurationResponse + type: object + xml: + attribute: false + name: SetZeroConfigurationResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_StartFirmwareUpgrade: + description: '' + title: tns_StartFirmwareUpgrade + type: object + xml: + attribute: false + name: StartFirmwareUpgrade + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_StartFirmwareUpgradeResponse: + description: '' + properties: + ExpectedDownTime: + format: date-time + type: string + xml: + attribute: false + name: ExpectedDownTime + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + UploadDelay: + format: date-time + type: string + xml: + attribute: false + name: UploadDelay + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + UploadUri: + type: string + xml: + attribute: false + name: UploadUri + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - UploadUri + - UploadDelay + - ExpectedDownTime + title: tns_StartFirmwareUpgradeResponse + type: object + xml: + attribute: false + name: StartFirmwareUpgradeResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_StartSystemRestore: + description: '' + title: tns_StartSystemRestore + type: object + xml: + attribute: false + name: StartSystemRestore + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_StartSystemRestoreResponse: + description: '' + properties: + ExpectedDownTime: + format: date-time + type: string + xml: + attribute: false + name: ExpectedDownTime + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + UploadUri: + type: string + xml: + attribute: false + name: UploadUri + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - UploadUri + - ExpectedDownTime + title: tns_StartSystemRestoreResponse + type: object + xml: + attribute: false + name: StartSystemRestoreResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_StorageConfiguration: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + Data: + allOf: + - $ref: '#/components/schemas/tns_StorageConfigurationData' + - xml: + attribute: false + name: Data + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Data + type: object + xml: + attribute: false + name: StorageConfiguration + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + description: '' + title: tns_StorageConfiguration + tns_StorageConfigurationData: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tns_Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + LocalPath: + description: local path + type: string + xml: + attribute: false + name: LocalPath + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + StorageUri: + description: Storage server address + type: string + xml: + attribute: false + name: StorageUri + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + User: + allOf: + - $ref: '#/components/schemas/tns_UserCredential' + - description: User credential for the storage server + xml: + attribute: false + name: User + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + type: + description: StorageType lists the acceptable values for type attribute + type: string + xml: + attribute: true + name: type + prefix: tns + wrapped: false + required: + - type + title: tns_StorageConfigurationData + type: object + xml: + attribute: false + name: StorageConfigurationData + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_StorageType: + description: '' + enum: + - NFS + - CIFS + - CDMI + - FTP + title: tns_StorageType + type: string + xml: + attribute: false + name: StorageType + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SystemCapabilities: + description: '' + properties: + Addons: + description: List of supported Addons by the device. + type: string + xml: + attribute: true + name: Addons + prefix: tns + wrapped: false + AutoGeo: + description: List of supported automatic GeoLocation adjustment supported + by the device. Valid items are defined by tds:AutoGeoMode. + type: string + xml: + attribute: true + name: AutoGeo + prefix: tns + wrapped: false + DiscoveryBye: + description: Indicates support for WS-Discovery Bye. + type: boolean + xml: + attribute: true + name: DiscoveryBye + prefix: tns + wrapped: false + DiscoveryNotSupported: + description: Indicates no support for network discovery. + type: boolean + xml: + attribute: true + name: DiscoveryNotSupported + prefix: tns + wrapped: false + DiscoveryResolve: + description: Indicates support for WS Discovery resolve requests. + type: boolean + xml: + attribute: true + name: DiscoveryResolve + prefix: tns + wrapped: false + FirmwareUpgrade: + description: Indicates support for firmware upgrade through MTOM. + type: boolean + xml: + attribute: true + name: FirmwareUpgrade + prefix: tns + wrapped: false + GeoLocationEntries: + description: If present signals support for geo location. The value signals + the supported number of entries. + format: int32 + type: integer + xml: + attribute: true + name: GeoLocationEntries + prefix: tns + wrapped: false + HttpFirmwareUpgrade: + description: Indicates support for firmware upgrade through HTTP. + type: boolean + xml: + attribute: true + name: HttpFirmwareUpgrade + prefix: tns + wrapped: false + HttpSupportInformation: + description: Indicates support for retrieving support information through + HTTP. + type: boolean + xml: + attribute: true + name: HttpSupportInformation + prefix: tns + wrapped: false + HttpSystemBackup: + description: Indicates support for system backup through HTTP. + type: boolean + xml: + attribute: true + name: HttpSystemBackup + prefix: tns + wrapped: false + HttpSystemLogging: + description: Indicates support for retrieval of system logging through HTTP. + type: boolean + xml: + attribute: true + name: HttpSystemLogging + prefix: tns + wrapped: false + MaxStorageConfigurations: + description: Indicates maximum number of storage configurations supported. + format: int32 + type: integer + xml: + attribute: true + name: MaxStorageConfigurations + prefix: tns + wrapped: false + NetworkConfigNotSupported: + description: Indicates no support for network configuration. + type: boolean + xml: + attribute: true + name: NetworkConfigNotSupported + prefix: tns + wrapped: false + RemoteDiscovery: + description: Indicates support for remote discovery. + type: boolean + xml: + attribute: true + name: RemoteDiscovery + prefix: tns + wrapped: false + StorageConfiguration: + description: Indicates support for storage configuration interfaces. + type: boolean + xml: + attribute: true + name: StorageConfiguration + prefix: tns + wrapped: false + StorageTypesSupported: + description: Enumerates the supported StorageTypes, see tds:StorageType. + type: string + xml: + attribute: true + name: StorageTypesSupported + prefix: tns + wrapped: false + SystemBackup: + description: Indicates support for system backup through MTOM. + type: boolean + xml: + attribute: true + name: SystemBackup + prefix: tns + wrapped: false + SystemLogging: + description: Indicates support for retrieval of system logging through MTOM. + type: boolean + xml: + attribute: true + name: SystemLogging + prefix: tns + wrapped: false + UserConfigNotSupported: + description: Indicates no support for user configuration. + type: boolean + xml: + attribute: true + name: UserConfigNotSupported + prefix: tns + wrapped: false + title: tns_SystemCapabilities + type: object + xml: + attribute: false + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SystemReboot: + description: '' + title: tns_SystemReboot + type: object + xml: + attribute: false + name: SystemReboot + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_SystemRebootResponse: + description: '' + properties: + Message: + description: Contains the reboot message sent by the device. + type: string + xml: + attribute: false + name: Message + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Message + title: tns_SystemRebootResponse + type: object + xml: + attribute: false + name: SystemRebootResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_UpgradeSystemFirmware: + description: '' + properties: + Firmware: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + attribute: false + name: Firmware + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - Firmware + title: tns_UpgradeSystemFirmware + type: object + xml: + attribute: false + name: UpgradeSystemFirmware + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_UpgradeSystemFirmwareResponse: + description: '' + properties: + Message: + type: string + xml: + attribute: false + name: Message + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + title: tns_UpgradeSystemFirmwareResponse + type: object + xml: + attribute: false + name: UpgradeSystemFirmwareResponse + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tns_UserCredential: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tns_Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + Password: + description: optional password + type: string + xml: + attribute: false + name: Password + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + UserName: + description: User name + type: string + xml: + attribute: false + name: UserName + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + required: + - UserName + title: tns_UserCredential + type: object + xml: + attribute: false + name: UserCredential + namespace: http://www.onvif.org/ver10/device/wsdl + prefix: tns + wrapped: false + tt_AACDecOptions: + description: '' + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + attribute: false + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Bitrate + - SampleRateRange + title: tt_AACDecOptions + type: object + xml: + attribute: false + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AFModes: + description: '' + enum: + - OnceAfterMove + title: tt_AFModes + type: string + xml: + attribute: false + name: AFModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AbsoluteFocus: + description: '' + properties: + Position: + description: Position parameter for the absolute focus control. + type: number + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + description: Speed parameter for the absolute focus control. + type: number + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Position + title: tt_AbsoluteFocus + type: object + xml: + attribute: false + name: AbsoluteFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AbsoluteFocusOptions: + description: '' + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the position. + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Position + title: tt_AbsoluteFocusOptions + type: object + xml: + attribute: false + name: AbsoluteFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ActionEngineEventPayload: + description: Action Engine Event Payload data structure contains the information + about the ONVIF command invocations. Since this event could be generated by + other or proprietary actions, the command invocation specific fields are defined + as optional and additional extension mechanism is provided for future or additional + action definitions. + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ActionEngineEventPayloadExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + xml: + attribute: false + name: Fault + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + xml: + attribute: false + name: RequestInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + xml: + attribute: false + name: ResponseInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ActionEngineEventPayload + type: object + xml: + attribute: false + name: ActionEngineEventPayload + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ActionEngineEventPayloadExtension: + description: '' + title: tt_ActionEngineEventPayloadExtension + type: object + xml: + attribute: false + name: ActionEngineEventPayloadExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ActiveConnection: + description: '' + properties: + CurrentBitrate: + type: number + xml: + attribute: false + name: CurrentBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CurrentFps: + type: number + xml: + attribute: false + name: CurrentFps + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - CurrentBitrate + - CurrentFps + title: tt_ActiveConnection + type: object + xml: + attribute: false + name: ActiveConnection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsCapabilities: + description: '' + properties: + AnalyticsModuleSupport: + description: Indicates whether or not modules are supported. + type: boolean + xml: + attribute: false + name: AnalyticsModuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RuleSupport: + description: Indicates whether or not rules are supported. + type: boolean + xml: + attribute: false + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + description: Analytics service URI. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + title: tt_AnalyticsCapabilities + type: object + xml: + attribute: false + name: AnalyticsCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsDeviceCapabilities: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RuleSupport: + description: Obsolete property. + type: boolean + xml: + attribute: false + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + title: tt_AnalyticsDeviceCapabilities + type: object + xml: + attribute: false + name: AnalyticsDeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsDeviceEngineConfiguration: + description: '' + properties: + EngineConfiguration: + description: '' + items: + $ref: '#/components/schemas/tt_EngineConfiguration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - EngineConfiguration + title: tt_AnalyticsDeviceEngineConfiguration + type: object + xml: + attribute: false + name: AnalyticsDeviceEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsDeviceEngineConfigurationExtension: + description: '' + title: tt_AnalyticsDeviceEngineConfigurationExtension + type: object + xml: + attribute: false + name: AnalyticsDeviceEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsDeviceExtension: + description: '' + title: tt_AnalyticsDeviceExtension + type: object + xml: + attribute: false + name: AnalyticsDeviceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsEngine: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfiguration' + - xml: + attribute: false + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AnalyticsEngineConfiguration + type: object + xml: + attribute: false + name: AnalyticsEngine + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AnalyticsEngine + tt_AnalyticsEngineConfiguration: + description: '' + properties: + AnalyticsModule: + description: '' + items: + $ref: '#/components/schemas/tt_Config' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_AnalyticsEngineConfiguration + type: object + xml: + attribute: false + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsEngineConfigurationExtension: + description: '' + title: tt_AnalyticsEngineConfigurationExtension + type: object + xml: + attribute: false + name: AnalyticsEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsEngineControl: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + EngineConfigToken: + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) + in effect. + maxLength: 64 + type: string + xml: + attribute: false + name: EngineConfigToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + EngineToken: + description: Token of the analytics engine (AnalyticsEngine) being controlled. + maxLength: 64 + type: string + xml: + attribute: false + name: EngineToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InputToken: + description: Tokens of the input (AnalyticsEngineInput) configuration + applied. + items: + maxLength: 64 + type: string + xml: + attribute: false + name: InputToken + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ModeOfOperation' + - xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - xml: + attribute: false + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ReceiverToken: + description: Tokens of the receiver providing media input data. The order + of ReceiverToken shall exactly match the order of InputToken. + items: + maxLength: 64 + type: string + xml: + attribute: false + name: ReceiverToken + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Subscription: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + attribute: false + name: Subscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + xml: + attribute: false + name: AnalyticsEngineControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AnalyticsEngineControl + tt_AnalyticsEngineInput: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + MetadataInput: + allOf: + - $ref: '#/components/schemas/tt_MetadataInput' + - xml: + attribute: false + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SourceIdentification: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentification' + - xml: + attribute: false + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoInput: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - xml: + attribute: false + name: VideoInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + xml: + attribute: false + name: AnalyticsEngineInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AnalyticsEngineInput + tt_AnalyticsEngineInputInfo: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfoExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InputInfo: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + attribute: false + name: InputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_AnalyticsEngineInputInfo + type: object + xml: + attribute: false + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsEngineInputInfoExtension: + description: '' + title: tt_AnalyticsEngineInputInfoExtension + type: object + xml: + attribute: false + name: AnalyticsEngineInputInfoExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsState: + description: '' + properties: + Error: + type: string + xml: + attribute: false + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + type: string + xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - State + title: tt_AnalyticsState + type: object + xml: + attribute: false + name: AnalyticsState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnalyticsStateInformation: + description: '' + properties: + AnalyticsEngineControlToken: + description: Token of the control object whose status is requested. + maxLength: 64 + type: string + xml: + attribute: false + name: AnalyticsEngineControlToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsState' + - xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AnalyticsEngineControlToken + - State + title: tt_AnalyticsStateInformation + type: object + xml: + attribute: false + name: AnalyticsStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AnyHolder: + description: '' + title: tt_AnyHolder + type: object + xml: + attribute: false + name: AnyHolder + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ArrayOfFileProgress: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ArrayOfFileProgressExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FileProgress: + description: Exported file name and export progress information + items: + $ref: '#/components/schemas/tt_FileProgress' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ArrayOfFileProgress + type: object + xml: + attribute: false + name: ArrayOfFileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ArrayOfFileProgressExtension: + description: '' + title: tt_ArrayOfFileProgressExtension + type: object + xml: + attribute: false + name: ArrayOfFileProgressExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AttachmentData: + description: '' + properties: + Include: + allOf: + - $ref: '#/components/schemas/xop_Include' + - xml: + attribute: false + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + wrapped: false + contentType: + minLength: 3 + type: string + xml: + attribute: true + name: contentType + prefix: xmime + wrapped: false + required: + - Include + title: tt_AttachmentData + type: object + xml: + attribute: false + name: AttachmentData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioAttributes: + description: '' + properties: + Bitrate: + description: The bitrate in kbps. + format: int32 + type: integer + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Encoding: + description: Audio encoding of the track. Use values from tt:AudioEncoding + for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames + and + type: string + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Samplerate: + description: The sample rate in kHz. + format: int32 + type: integer + xml: + attribute: false + name: Samplerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - Samplerate + title: tt_AudioAttributes + type: object + xml: + attribute: false + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioClassCandidate: + description: '' + properties: + Likelihood: + description: A likelihood/probability that the corresponding audio event + belongs to this class. The sum of the likelihoods shall NOT exceed 1 + type: number + xml: + attribute: false + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_AudioClassType' + - description: Indicates audio class label + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + - Likelihood + title: tt_AudioClassCandidate + type: object + xml: + attribute: false + name: AudioClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioClassDescriptor: + description: '' + properties: + ClassCandidate: + description: Array of audio class label and class probability + items: + $ref: '#/components/schemas/tt_AudioClassCandidate' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioClassDescriptorExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_AudioClassDescriptor + type: object + xml: + attribute: false + name: AudioClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioClassDescriptorExtension: + description: '' + title: tt_AudioClassDescriptorExtension + type: object + xml: + attribute: false + name: AudioClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioClassType: + description: "AudioClassType acceptable values are;\n\t\t gun_shot, scream,\ + \ glass_breaking, tire_screech" + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + title: tt_AudioClassType + type: string + xml: + attribute: false + name: AudioClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - type: object + xml: + attribute: false + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: 'The Audio Decoder Configuration does not contain any that parameter + to configure the + + decoding .A decoder shall decode every data it receives (according to its + capabilities).' + title: tt_AudioDecoderConfiguration + tt_AudioDecoderConfigurationOptions: + description: '' + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/tt_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section + describes the supported configurations + xml: + attribute: false + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + G711DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section + describes the supported configurations + xml: + attribute: false + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + G726DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section + describes the supported configurations + xml: + attribute: false + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_AudioDecoderConfigurationOptions + type: object + xml: + attribute: false + name: AudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioDecoderConfigurationOptionsExtension: + description: '' + title: tt_AudioDecoderConfigurationOptionsExtension + type: object + xml: + attribute: false + name: AudioDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioEncoder2Configuration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + Bitrate: + description: The output bitrate in kbps. + format: int32 + type: integer + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Encoding: + description: Audio Media Subtype for the audio format. For definitions + see tt:AudioEncodingMimeNames and + type: string + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + xml: + attribute: false + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRate: + description: The output sample rate in kHz. + format: int32 + type: integer + xml: + attribute: false + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - Bitrate + - SampleRate + type: object + xml: + attribute: false + name: AudioEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AudioEncoder2Configuration + tt_AudioEncoder2ConfigurationOptions: + description: '' + properties: + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + attribute: false + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Encoding: + description: Audio Media Subtype for the audio format. For definitions see + tt:AudioEncodingMimeNames and + type: string + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + attribute: false + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - BitrateList + - SampleRateList + title: tt_AudioEncoder2ConfigurationOptions + type: object + xml: + attribute: false + name: AudioEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + Bitrate: + description: The output bitrate in kbps. + format: int32 + type: integer + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, + G.726 or AAC) + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + xml: + attribute: false + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRate: + description: The output sample rate in kHz. + format: int32 + type: integer + xml: + attribute: false + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SessionTimeout: + description: The rtsp session timeout for the related audio stream + format: date-time + type: string + xml: + attribute: false + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + xml: + attribute: false + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AudioEncoderConfiguration + tt_AudioEncoderConfigurationOption: + description: '' + properties: + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + attribute: false + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + attribute: false + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - BitrateList + - SampleRateList + title: tt_AudioEncoderConfigurationOption + type: object + xml: + attribute: false + name: AudioEncoderConfigurationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioEncoderConfigurationOptions: + description: '' + properties: + Options: + description: list of supported AudioEncoderConfigurations + items: + $ref: '#/components/schemas/tt_AudioEncoderConfigurationOption' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_AudioEncoderConfigurationOptions + type: object + xml: + attribute: false + name: AudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioEncoding: + description: '' + enum: + - G711 + - G726 + - AAC + title: tt_AudioEncoding + type: string + xml: + attribute: false + name: AudioEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioEncodingMimeNames: + description: Audio Media Subtypes as referenced by IANA (without the leading + "audio/" Audio Media Type and except for the audio types defined in the restriction). See + also + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + title: tt_AudioEncodingMimeNames + type: string + xml: + attribute: false + name: AudioEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioOutput: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + xml: + attribute: false + name: AudioOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: Representation of a physical audio outputs. + title: tt_AudioOutput + tt_AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + OutputLevel: + description: Volume setting of the output. The applicable range is defined + via the option AudioOutputOptions.OutputLevelRange. + format: int32 + type: integer + xml: + attribute: false + name: OutputLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + OutputToken: + description: Token of the phsycial Audio output. + maxLength: 64 + type: string + xml: + attribute: false + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SendPrimacy: + 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." + type: string + xml: + attribute: false + name: SendPrimacy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - OutputToken + - OutputLevel + type: object + xml: + attribute: false + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AudioOutputConfiguration + tt_AudioOutputConfigurationOptions: + description: '' + properties: + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Minimum and maximum level range supported for this Output. + xml: + attribute: false + name: OutputLevelRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + OutputTokensAvailable: + description: Tokens of the physical Audio outputs (typically one). + items: + maxLength: 64 + type: string + xml: + attribute: false + name: OutputTokensAvailable + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SendPrimacyOptions: + description: An + items: + type: string + xml: + attribute: false + name: SendPrimacyOptions + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - OutputTokensAvailable + - OutputLevelRange + title: tt_AudioOutputConfigurationOptions + type: object + xml: + attribute: false + name: AudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioSource: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + Channels: + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + type: integer + xml: + attribute: false + name: Channels + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Channels + type: object + xml: + attribute: false + name: AudioSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: Representation of a physical audio input. + title: tt_AudioSource + tt_AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + SourceToken: + description: Token of the Audio Source the configuration applies to + maxLength: 64 + type: string + xml: + attribute: false + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SourceToken + type: object + xml: + attribute: false + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_AudioSourceConfiguration + tt_AudioSourceConfigurationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InputTokensAvailable: + description: Tokens of the audio source the configuration can be used for. + items: + maxLength: 64 + type: string + xml: + attribute: false + name: InputTokensAvailable + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - InputTokensAvailable + title: tt_AudioSourceConfigurationOptions + type: object + xml: + attribute: false + name: AudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AudioSourceOptionsExtension: + description: '' + title: tt_AudioSourceOptionsExtension + type: object + xml: + attribute: false + name: AudioSourceOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_AutoFocusMode: + description: '' + enum: + - AUTO + - MANUAL + title: tt_AutoFocusMode + type: string + xml: + attribute: false + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BacklightCompensation: + description: '' + properties: + Level: + description: Optional level parameter (unit unspecified). + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Level + title: tt_BacklightCompensation + type: object + xml: + attribute: false + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BacklightCompensation20: + description: Type describing whether BLC mode is enabled or disabled (on/off). + properties: + Level: + description: Optional level parameter (unit unspecified). + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_BacklightCompensation20 + type: object + xml: + attribute: false + name: BacklightCompensation20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BacklightCompensationMode: + description: Enumeration describing the available backlight compenstation modes. + enum: + - false + - true + title: tt_BacklightCompensationMode + type: string + xml: + attribute: false + name: BacklightCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BacklightCompensationOptions: + description: '' + properties: + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: '' + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Level + title: tt_BacklightCompensationOptions + type: object + xml: + attribute: false + name: BacklightCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BacklightCompensationOptions20: + description: '' + properties: + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Level range of BacklightCompensation. + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: '''ON'' or ''OFF''' + items: + $ref: '#/components/schemas/tt_BacklightCompensationMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_BacklightCompensationOptions20 + type: object + xml: + attribute: false + name: BacklightCompensationOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BackupFile: + description: '' + properties: + Data: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + attribute: false + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Name + - Data + title: tt_BackupFile + type: object + xml: + attribute: false + name: BackupFile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_BinaryData: + description: '' + properties: + Data: + description: base64 encoded binary data. + format: binary + type: string + xml: + attribute: false + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + contentType: + minLength: 3 + type: string + xml: + attribute: true + name: contentType + prefix: xmime + wrapped: false + required: + - Data + title: tt_BinaryData + type: object + xml: + attribute: false + name: BinaryData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Capabilities: + description: '' + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsCapabilities' + - description: Analytics capabilities + xml: + attribute: false + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Device: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilities' + - description: Device capabilities + xml: + attribute: false + name: Device + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventCapabilities' + - description: Event capabilities + xml: + attribute: false + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingCapabilities' + - description: Imaging capabilities + xml: + attribute: false + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Media: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilities' + - description: Media capabilities + xml: + attribute: false + name: Media + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZCapabilities' + - description: PTZ capabilities + xml: + attribute: false + name: PTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_Capabilities + type: object + xml: + attribute: false + name: Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CapabilitiesExtension: + description: '' + properties: + AnalyticsDevice: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceCapabilities' + - xml: + attribute: false + name: AnalyticsDevice + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DeviceIO: + allOf: + - $ref: '#/components/schemas/tt_DeviceIOCapabilities' + - xml: + attribute: false + name: DeviceIO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Display: + allOf: + - $ref: '#/components/schemas/tt_DisplayCapabilities' + - xml: + attribute: false + name: Display + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extensions: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension2' + - xml: + attribute: false + name: Extensions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tt_ReceiverCapabilities' + - xml: + attribute: false + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Recording: + allOf: + - $ref: '#/components/schemas/tt_RecordingCapabilities' + - xml: + attribute: false + name: Recording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Replay: + allOf: + - $ref: '#/components/schemas/tt_ReplayCapabilities' + - xml: + attribute: false + name: Replay + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Search: + allOf: + - $ref: '#/components/schemas/tt_SearchCapabilities' + - xml: + attribute: false + name: Search + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_CapabilitiesExtension + type: object + xml: + attribute: false + name: CapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CapabilitiesExtension2: + description: '' + title: tt_CapabilitiesExtension2 + type: object + xml: + attribute: false + name: CapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CapabilityCategory: + description: '' + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + title: tt_CapabilityCategory + type: string + xml: + attribute: false + name: CapabilityCategory + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CellLayout: + description: '' + properties: + Columns: + description: Number of columns of the cell grid (x dimension) + format: int32 + type: integer + xml: + attribute: true + name: Columns + prefix: tt + wrapped: false + Rows: + description: Number of rows of the cell grid (y dimension) + format: int32 + type: integer + xml: + attribute: true + name: Rows + prefix: tt + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid + is starting from the upper left corner and x dimension is going from + left to right and the y dimension from up to down. + xml: + attribute: false + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Columns + - Rows + - Transformation + title: tt_CellLayout + type: object + xml: + attribute: false + name: CellLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Certificate: + description: '' + properties: + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + attribute: false + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CertificateID: + description: Certificate id. + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - CertificateID + - Certificate + title: tt_Certificate + type: object + xml: + attribute: false + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateGenerationParameters: + description: '' + properties: + CertificateID: + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateGenerationParametersExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Subject: + type: string + xml: + attribute: false + name: Subject + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ValidNotAfter: + type: string + xml: + attribute: false + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ValidNotBefore: + type: string + xml: + attribute: false + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_CertificateGenerationParameters + type: object + xml: + attribute: false + name: CertificateGenerationParameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateGenerationParametersExtension: + description: '' + title: tt_CertificateGenerationParametersExtension + type: object + xml: + attribute: false + name: CertificateGenerationParametersExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateInformation: + description: '' + properties: + CertificateID: + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ExtendedKeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + attribute: false + name: ExtendedKeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IssuerDN: + type: string + xml: + attribute: false + name: IssuerDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + KeyLength: + format: int32 + type: integer + xml: + attribute: false + name: KeyLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + KeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + attribute: false + name: KeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SerialNum: + type: string + xml: + attribute: false + name: SerialNum + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SignatureAlgorithm: + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding + DateTimeRange is from "From" to "Until" + type: string + xml: + attribute: false + name: SignatureAlgorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SubjectDN: + type: string + xml: + attribute: false + name: SubjectDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Validity: + allOf: + - $ref: '#/components/schemas/tt_DateTimeRange' + - xml: + attribute: false + name: Validity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Version: + type: string + xml: + attribute: false + name: Version + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - CertificateID + title: tt_CertificateInformation + type: object + xml: + attribute: false + name: CertificateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateInformationExtension: + description: '' + title: tt_CertificateInformationExtension + type: object + xml: + attribute: false + name: CertificateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateStatus: + description: '' + properties: + CertificateID: + description: Certificate id. + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Status: + description: Indicates whether or not a certificate is used in a HTTPS configuration. + type: boolean + xml: + attribute: false + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - CertificateID + - Status + title: tt_CertificateStatus + type: object + xml: + attribute: false + name: CertificateStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateUsage: + description: '' + properties: + Critical: + type: boolean + xml: + attribute: true + name: Critical + prefix: tt + wrapped: false + required: + - Critical + title: tt_CertificateUsage + type: object + xml: + attribute: false + name: CertificateUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CertificateWithPrivateKey: + description: '' + properties: + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + attribute: false + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CertificateID: + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PrivateKey: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + attribute: false + name: PrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Certificate + - PrivateKey + title: tt_CertificateWithPrivateKey + type: object + xml: + attribute: false + name: CertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_CodingCapabilities: + description: This type contains the Audio and Video coding capabilities of a + display service. + properties: + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes + the supported codecs and their settings. + xml: + attribute: false + name: AudioDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes + the supported codecs and their configuration. + xml: + attribute: false + name: AudioEncodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their + configuration. + xml: + attribute: false + name: VideoDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - VideoDecodingCapabilities + title: tt_CodingCapabilities + type: object + xml: + attribute: false + name: CodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Color: + description: '' + properties: + Colorspace: + description: 'Acceptable values:' + type: string + xml: + attribute: true + name: Colorspace + prefix: tt + wrapped: false + X: + type: number + xml: + attribute: true + name: X + prefix: tt + wrapped: false + Y: + type: number + xml: + attribute: true + name: Y + prefix: tt + wrapped: false + Z: + type: number + xml: + attribute: true + name: Z + prefix: tt + wrapped: false + required: + - X + - Y + - Z + title: tt_Color + type: object + xml: + attribute: false + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ColorCluster: + description: '' + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + attribute: false + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Covariance: + allOf: + - $ref: '#/components/schemas/tt_ColorCovariance' + - xml: + attribute: false + name: Covariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Weight: + type: number + xml: + attribute: false + name: Weight + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Color + title: tt_ColorCluster + type: object + xml: + attribute: false + name: ColorCluster + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ColorCovariance: + description: '' + properties: + Colorspace: + description: Acceptable values are the same as in tt:Color. + type: string + xml: + attribute: true + name: Colorspace + prefix: tt + wrapped: false + XX: + type: number + xml: + attribute: true + name: XX + prefix: tt + wrapped: false + XY: + type: number + xml: + attribute: true + name: XY + prefix: tt + wrapped: false + XZ: + type: number + xml: + attribute: true + name: XZ + prefix: tt + wrapped: false + YY: + type: number + xml: + attribute: true + name: YY + prefix: tt + wrapped: false + YZ: + type: number + xml: + attribute: true + name: YZ + prefix: tt + wrapped: false + ZZ: + type: number + xml: + attribute: true + name: ZZ + prefix: tt + wrapped: false + required: + - XX + - YY + - ZZ + title: tt_ColorCovariance + type: object + xml: + attribute: false + name: ColorCovariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ColorDescriptor: + description: '' + properties: + ColorCluster: + description: '' + items: + $ref: '#/components/schemas/tt_ColorCluster' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ColorDescriptor + type: object + xml: + attribute: false + name: ColorDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ColorOptions: + description: Describe the colors supported. Either list each color or define + the range of color values. + properties: + ColorList: + description: List the supported color. + items: + $ref: '#/components/schemas/tt_Color' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ColorspaceRange: + description: Define the range of color supported. + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ColorOptions + type: object + xml: + attribute: false + name: ColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ColorOptionsChoice0: + properties: + ColorList: + description: List the supported color. + items: + $ref: '#/components/schemas/tt_Color' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ColorOptionsChoice0 + type: object + tt_ColorOptionsChoice1: + properties: + ColorspaceRange: + description: Define the range of color supported. + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ColorOptionsChoice1 + type: object + tt_ColorspaceRange: + description: '' + properties: + Colorspace: + description: Acceptable values are the same as in tt:Color. + type: string + xml: + attribute: false + name: Colorspace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + X: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Y: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Y + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Z: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Z + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - X + - Y + - Z + - Colorspace + title: tt_ColorspaceRange + type: object + xml: + attribute: false + name: ColorspaceRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Config: + description: '' + properties: + Name: + description: Name of the configuration. + type: string + xml: + attribute: true + name: Name + prefix: tt + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: List of configuration parameters as defined in the corresponding + description. + xml: + attribute: false + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + 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. + type: string + xml: + attribute: true + name: Type + prefix: tt + wrapped: false + required: + - Name + - Type + - Parameters + title: tt_Config + type: object + xml: + attribute: false + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ConfigDescription: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ConfigDescriptionExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Messages: + 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." + items: + $ref: '#/components/schemas/tt_Messages' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies + the type of rule, not a type definition in a schema. + type: string + xml: + attribute: true + name: Name + prefix: tt + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - 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." + xml: + attribute: false + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + fixed: + description: The fixed attribute signals that it is not allowed to add or + remove this type of configuration. + type: boolean + xml: + attribute: true + name: fixed + prefix: tt + wrapped: false + maxInstances: + description: The maxInstances attribute signals the maximum number of instances + per configuration. + format: int32 + type: integer + xml: + attribute: true + name: maxInstances + prefix: tt + wrapped: false + required: + - Name + - Parameters + title: tt_ConfigDescription + type: object + xml: + attribute: false + name: ConfigDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ConfigDescriptionExtension: + description: '' + title: tt_ConfigDescriptionExtension + type: object + xml: + attribute: false + name: ConfigDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ConfigurationEntity: + description: Base type defining the common properties of a configuration. + properties: + Name: + description: User readable name. Length up to 64 characters. + maxLength: 64 + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + UseCount: + description: Number of internal references currently using this configuration. + format: int32 + type: integer + xml: + attribute: false + name: UseCount + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + token: + description: Token that uniquely references this configuration. Length up + to 64 characters. + maxLength: 64 + type: string + xml: + attribute: true + name: token + prefix: tt + wrapped: false + required: + - token + - Name + - UseCount + title: tt_ConfigurationEntity + type: object + xml: + attribute: false + name: ConfigurationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ContinuousFocus: + description: '' + properties: + Speed: + description: Speed parameter for the Continuous focus control. + type: number + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Speed + title: tt_ContinuousFocus + type: object + xml: + attribute: false + name: ContinuousFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ContinuousFocusOptions: + description: '' + properties: + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Speed + title: tt_ContinuousFocusOptions + type: object + xml: + attribute: false + name: ContinuousFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DNSInformation: + description: '' + properties: + DNSFromDHCP: + description: List of DNS addresses received from DHCP. + items: + $ref: '#/components/schemas/tt_IPAddress' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DNSManual: + description: List of manually entered DNS addresses. + items: + $ref: '#/components/schemas/tt_IPAddress' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DNSInformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FromDHCP: + description: Indicates whether or not DNS information is retrieved from + DHCP. + type: boolean + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SearchDomain: + description: Search domain. + items: + type: string + xml: + attribute: false + name: SearchDomain + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FromDHCP + title: tt_DNSInformation + type: object + xml: + attribute: false + name: DNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DNSInformationExtension: + description: '' + title: tt_DNSInformationExtension + type: object + xml: + attribute: false + name: DNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Date: + description: '' + properties: + Day: + description: Range is 1 to 31. + format: int32 + type: integer + xml: + attribute: false + name: Day + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Month: + description: Range is 1 to 12. + format: int32 + type: integer + xml: + attribute: false + name: Month + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Year: + format: int32 + type: integer + xml: + attribute: false + name: Year + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Year + - Month + - Day + title: tt_Date + type: object + xml: + attribute: false + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DateTime: + description: '' + properties: + Date: + allOf: + - $ref: '#/components/schemas/tt_Date' + - xml: + attribute: false + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Time: + allOf: + - $ref: '#/components/schemas/tt_Time' + - xml: + attribute: false + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Time + - Date + title: tt_DateTime + type: object + xml: + attribute: false + name: DateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DateTimeRange: + description: '' + properties: + From: + format: date-time + type: string + xml: + attribute: false + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Until: + format: date-time + type: string + xml: + attribute: false + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - From + - Until + title: tt_DateTimeRange + type: object + xml: + attribute: false + name: DateTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Defogging: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_DefoggingExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Level: + description: Optional level parameter specified with unitless normalized + value from 0.0 to +1.0. + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Parameter to enable/disable or automatic Defogging feature. + Its options shall be chosen from tt:DefoggingMode Type. + type: string + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_Defogging + type: object + xml: + attribute: false + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DefoggingExtension: + description: '' + title: tt_DefoggingExtension + type: object + xml: + attribute: false + name: DefoggingExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DefoggingMode: + description: '' + enum: + - false + - true + - AUTO + title: tt_DefoggingMode + type: string + xml: + attribute: false + name: DefoggingMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DefoggingOptions: + description: '' + properties: + Level: + description: Indicates whether or not support Level parameter for Defogging. + type: boolean + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Supported options for Defogging mode. Its options shall be + chosen from tt:DefoggingMode Type. + items: + type: string + xml: + attribute: false + name: Mode + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Level + title: tt_DefoggingOptions + type: object + xml: + attribute: false + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DeviceCapabilities: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IO: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilities' + - description: I/O capabilities. + xml: + attribute: false + name: IO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilities' + - description: Network capabilities. + xml: + attribute: false + name: Network + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilities' + - description: Security capabilities. + xml: + attribute: false + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilities' + - description: System capabilities. + xml: + attribute: false + name: System + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + description: Device service URI. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + title: tt_DeviceCapabilities + type: object + xml: + attribute: false + name: DeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DeviceCapabilitiesExtension: + description: '' + title: tt_DeviceCapabilitiesExtension + type: object + xml: + attribute: false + name: DeviceCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DeviceEntity: + description: Base class for physical entities like inputs and outputs. + properties: + token: + description: Unique identifier referencing the physical entity. + maxLength: 64 + type: string + xml: + attribute: true + name: token + prefix: tt + wrapped: false + required: + - token + title: tt_DeviceEntity + type: object + xml: + attribute: false + name: DeviceEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DeviceIOCapabilities: + description: '' + properties: + AudioOutputs: + format: int32 + type: integer + xml: + attribute: false + name: AudioOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AudioSources: + format: int32 + type: integer + xml: + attribute: false + name: AudioSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RelayOutputs: + format: int32 + type: integer + xml: + attribute: false + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoOutputs: + format: int32 + type: integer + xml: + attribute: false + name: VideoOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoSources: + format: int32 + type: integer + xml: + attribute: false + name: VideoSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + title: tt_DeviceIOCapabilities + type: object + xml: + attribute: false + name: DeviceIOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DigitalIdleState: + description: '' + enum: + - closed + - open + title: tt_DigitalIdleState + type: string + xml: + attribute: false + name: DigitalIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DigitalInput: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + IdleState: + allOf: + - $ref: '#/components/schemas/tt_DigitalIdleState' + - description: Indicate the Digital IdleState status. + xml: + attribute: true + name: IdleState + prefix: tt + wrapped: false + type: object + xml: + attribute: false + name: DigitalInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_DigitalInput + tt_Direction: + description: '' + enum: + - Left + - Right + - Any + title: tt_Direction + type: string + xml: + attribute: false + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DiscoveryMode: + description: '' + enum: + - Discoverable + - NonDiscoverable + title: tt_DiscoveryMode + type: string + xml: + attribute: false + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DisplayCapabilities: + description: '' + properties: + FixedLayout: + description: Indication that the SetLayout command supports only predefined + layouts. + type: boolean + xml: + attribute: false + name: FixedLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - FixedLayout + title: tt_DisplayCapabilities + type: object + xml: + attribute: false + name: DisplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11AuthAndMangementSuite: + description: '' + enum: + - None + - Dot1X + - PSK + - Extended + title: tt_Dot11AuthAndMangementSuite + type: string + xml: + attribute: false + name: Dot11AuthAndMangementSuite + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11AvailableNetworks: + description: '' + properties: + AuthAndMangementSuite: + description: See IEEE802.11 7.3.2.25.2 for details. + items: + $ref: '#/components/schemas/tt_Dot11AuthAndMangementSuite' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + BSSID: + type: string + xml: + attribute: false + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11AvailableNetworksExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GroupCipher: + description: '' + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PairCipher: + description: '' + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SSID: + format: binary + type: string + xml: + attribute: false + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + attribute: false + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SSID + title: tt_Dot11AvailableNetworks + type: object + xml: + attribute: false + name: Dot11AvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11AvailableNetworksExtension: + description: '' + title: tt_Dot11AvailableNetworksExtension + type: object + xml: + attribute: false + name: Dot11AvailableNetworksExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11Capabilities: + description: '' + properties: + AdHocStationMode: + type: boolean + xml: + attribute: false + name: AdHocStationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MultipleConfiguration: + type: boolean + xml: + attribute: false + name: MultipleConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ScanAvailableNetworks: + type: boolean + xml: + attribute: false + name: ScanAvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TKIP: + type: boolean + xml: + attribute: false + name: TKIP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WEP: + type: boolean + xml: + attribute: false + name: WEP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + title: tt_Dot11Capabilities + type: object + xml: + attribute: false + name: Dot11Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11Cipher: + description: '' + enum: + - CCMP + - TKIP + - Any + - Extended + title: tt_Dot11Cipher + type: string + xml: + attribute: false + name: Dot11Cipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11Configuration: + description: '' + properties: + Alias: + maxLength: 64 + type: string + xml: + attribute: false + name: Alias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11StationMode' + - xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Priority: + format: int32 + maximum: 31 + minimum: 0 + type: integer + xml: + attribute: false + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SSID: + format: binary + type: string + xml: + attribute: false + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfiguration' + - xml: + attribute: false + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SSID + - Mode + - Alias + - Priority + - Security + title: tt_Dot11Configuration + type: object + xml: + attribute: false + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11PSKSet: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSetExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Key: + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of + 256 bits, or 64 octets when represented in hex + format: binary + type: string + xml: + attribute: false + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Passphrase: + 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." + pattern: '[ -~]{8,63}' + type: string + xml: + attribute: false + name: Passphrase + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_Dot11PSKSet + type: object + xml: + attribute: false + name: Dot11PSKSet + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11PSKSetExtension: + description: '' + title: tt_Dot11PSKSetExtension + type: object + xml: + attribute: false + name: Dot11PSKSetExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11SecurityConfiguration: + description: '' + properties: + Algorithm: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + attribute: false + name: Algorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Dot1X: + maxLength: 64 + type: string + xml: + attribute: false + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityMode' + - xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PSK: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSet' + - xml: + attribute: false + name: PSK + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_Dot11SecurityConfiguration + type: object + xml: + attribute: false + name: Dot11SecurityConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11SecurityConfigurationExtension: + description: '' + title: tt_Dot11SecurityConfigurationExtension + type: object + xml: + attribute: false + name: Dot11SecurityConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11SecurityMode: + description: '' + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + title: tt_Dot11SecurityMode + type: string + xml: + attribute: false + name: Dot11SecurityMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11SignalStrength: + description: '' + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + title: tt_Dot11SignalStrength + type: string + xml: + attribute: false + name: Dot11SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11StationMode: + description: '' + enum: + - Ad-hoc + - Infrastructure + - Extended + title: tt_Dot11StationMode + type: string + xml: + attribute: false + name: Dot11StationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot11Status: + description: '' + properties: + ActiveConfigAlias: + maxLength: 64 + type: string + xml: + attribute: false + name: ActiveConfigAlias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + BSSID: + type: string + xml: + attribute: false + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GroupCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + attribute: false + name: GroupCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PairCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + attribute: false + name: PairCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SSID: + format: binary + type: string + xml: + attribute: false + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + attribute: false + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SSID + - ActiveConfigAlias + title: tt_Dot11Status + type: object + xml: + attribute: false + name: Dot11Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot1XConfiguration: + description: '' + properties: + AnonymousID: + type: string + xml: + attribute: false + name: AnonymousID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CACertificateID: + description: '' + items: + type: string + xml: + attribute: false + name: CACertificateID + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + attribute: false + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + EAPMethod: + description: EAP Method type as defined in + format: int32 + type: integer + xml: + attribute: false + name: EAPMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + EAPMethodConfiguration: + allOf: + - $ref: '#/components/schemas/tt_EAPMethodConfiguration' + - xml: + attribute: false + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Identity: + type: string + xml: + attribute: false + name: Identity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + title: tt_Dot1XConfiguration + type: object + xml: + attribute: false + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot1XConfigurationExtension: + description: '' + title: tt_Dot1XConfigurationExtension + type: object + xml: + attribute: false + name: Dot1XConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Dot3Configuration: + description: '' + title: tt_Dot3Configuration + type: object + xml: + attribute: false + name: Dot3Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Duplex: + description: '' + enum: + - Full + - Half + title: tt_Duplex + type: string + xml: + attribute: false + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DurationRange: + description: Range of duration greater equal Min duration and less equal Max + duration. + properties: + Max: + format: date-time + type: string + xml: + attribute: false + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Min: + format: date-time + type: string + xml: + attribute: false + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Min + - Max + title: tt_DurationRange + type: object + xml: + attribute: false + name: DurationRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DynamicDNSInformation: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: DNS name. + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TTL: + description: Time to live. + format: date-time + type: string + xml: + attribute: false + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_DynamicDNSInformation + type: object + xml: + attribute: false + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DynamicDNSInformationExtension: + description: '' + title: tt_DynamicDNSInformationExtension + type: object + xml: + attribute: false + name: DynamicDNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_DynamicDNSType: + description: '' + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + title: tt_DynamicDNSType + type: string + xml: + attribute: false + name: DynamicDNSType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EAPMethodConfiguration: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_EapMethodExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Password: + description: Password for those EAP Methods that require a password. The + password shall never be returned on a get method. + type: string + xml: + attribute: false + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/tt_TLSConfiguration' + - description: Confgiuration information for TLS Method. + xml: + attribute: false + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_EAPMethodConfiguration + type: object + xml: + attribute: false + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EFlip: + description: '' + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_EFlip + type: object + xml: + attribute: false + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EFlipMode: + description: '' + enum: + - false + - true + - Extended + title: tt_EFlipMode + type: string + xml: + attribute: false + name: EFlipMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EFlipOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Options of EFlip mode parameter. + items: + $ref: '#/components/schemas/tt_EFlipMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_EFlipOptions + type: object + xml: + attribute: false + name: EFlipOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EFlipOptionsExtension: + description: '' + title: tt_EFlipOptionsExtension + type: object + xml: + attribute: false + name: EFlipOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EapMethodExtension: + description: '' + title: tt_EapMethodExtension + type: object + xml: + attribute: false + name: EapMethodExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ElementItem: + description: Complex value structure. + properties: + Name: + description: Item name. + type: string + xml: + attribute: true + name: Name + prefix: tt + wrapped: false + required: + - Name + title: tt_ElementItem + type: object + xml: + attribute: false + name: ElementItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ElementItemDescription: + description: Description of a complex type. The Type must reference a defined + type. + properties: + Name: + description: Item name. Must be unique within a list. + type: string + xml: + attribute: true + name: Name + prefix: tt + wrapped: false + Type: + description: The type of the item. The Type must reference a defined type. + type: string + xml: + attribute: true + name: Type + prefix: tt + wrapped: false + required: + - Name + - Type + title: tt_ElementItemDescription + type: object + xml: + attribute: false + name: ElementItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Enabled: + description: '' + enum: + - ENABLED + - DISABLED + title: tt_Enabled + type: string + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EngineConfiguration: + description: '' + properties: + AnalyticsEngineInputInfo: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfo' + - xml: + attribute: false + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - xml: + attribute: false + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + title: tt_EngineConfiguration + type: object + xml: + attribute: false + name: EngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Entity: + description: '' + enum: + - Device + - VideoSource + - AudioSource + title: tt_Entity + type: string + xml: + attribute: false + name: Entity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EventCapabilities: + description: '' + properties: + WSPausableSubscriptionManagerInterfaceSupport: + description: Indicates whether or not WS Pausable Subscription Manager Interface + is supported. + type: boolean + xml: + attribute: false + name: WSPausableSubscriptionManagerInterfaceSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WSPullPointSupport: + description: Indicates whether or not WS Pull Point is supported. + type: boolean + xml: + attribute: false + name: WSPullPointSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WSSubscriptionPolicySupport: + description: Indicates whether or not WS Subscription policy is supported. + type: boolean + xml: + attribute: false + name: WSSubscriptionPolicySupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + description: Event service URI. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + title: tt_EventCapabilities + type: object + xml: + attribute: false + name: EventCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_EventFilter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + xml: + attribute: false + name: EventFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_EventFilter + tt_EventSubscription: + description: Subcription handling in the same way as base notification subscription. + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + attribute: false + name: Filter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tt_SubscriptionPolicy' + - xml: + attribute: false + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_EventSubscription + type: object + xml: + attribute: false + name: EventSubscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Exposure: + description: '' + properties: + ExposureTime: + description: "The fixed exposure time used by the image sensor (\u03BCs)." + type: number + xml: + attribute: false + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Gain: + description: The fixed gain used by the image sensor (dB). + type: number + xml: + attribute: false + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Iris: + description: The fixed attenuation of input light affected by the iris (dB). + 0dB maps to a fully opened iris. + type: number + xml: + attribute: false + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxExposureTime: + description: Maximum value of exposure time range allowed to be used by + the algorithm. + type: number + xml: + attribute: false + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxGain: + description: Maximum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + xml: + attribute: false + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxIris: + description: Maximum value of the iris range allowed to be used by the algorithm. + type: number + xml: + attribute: false + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinExposureTime: + description: Minimum value of exposure time range allowed to be used by + the algorithm. + type: number + xml: + attribute: false + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinGain: + description: Minimum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + xml: + attribute: false + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinIris: + description: Minimum value of the iris range allowed to be used by the algorithm. + type: number + xml: + attribute: false + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + attribute: false + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + attribute: false + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + title: tt_Exposure + type: object + xml: + attribute: false + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Exposure20: + description: Type describing the exposure settings. + properties: + ExposureTime: + description: "The fixed exposure time used by the image sensor (\u03BCs)." + type: number + xml: + attribute: false + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Gain: + description: The fixed gain used by the image sensor (dB). + type: number + xml: + attribute: false + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Iris: + 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. + type: number + xml: + attribute: false + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxExposureTime: + description: Maximum value of exposure time range allowed to be used by + the algorithm. + type: number + xml: + attribute: false + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxGain: + description: Maximum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + xml: + attribute: false + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxIris: + 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. + type: number + xml: + attribute: false + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinExposureTime: + description: Minimum value of exposure time range allowed to be used by + the algorithm. + type: number + xml: + attribute: false + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinGain: + description: Minimum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + xml: + attribute: false + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinIris: + 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. + type: number + xml: + attribute: false + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + attribute: false + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + attribute: false + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_Exposure20 + type: object + xml: + attribute: false + name: Exposure20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ExposureMode: + description: '' + enum: + - AUTO + - MANUAL + title: tt_ExposureMode + type: string + xml: + attribute: false + name: ExposureMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ExposureOptions: + description: '' + properties: + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: '' + items: + $ref: '#/components/schemas/tt_ExposureMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Priority: + description: '' + items: + $ref: '#/components/schemas/tt_ExposurePriority' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + title: tt_ExposureOptions + type: object + xml: + attribute: false + name: ExposureOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ExposureOptions20: + description: '' + properties: + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the ExposureTime. + xml: + attribute: false + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Gain. + xml: + attribute: false + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Iris. + xml: + attribute: false + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum ExposureTime. + xml: + attribute: false + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Gain. + xml: + attribute: false + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Iris. + xml: + attribute: false + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum ExposureTime. + xml: + attribute: false + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Gain. + xml: + attribute: false + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Iris. + xml: + attribute: false + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Exposure Mode + items: + $ref: '#/components/schemas/tt_ExposureMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Priority: + description: The exposure priority mode (low noise/framerate). + items: + $ref: '#/components/schemas/tt_ExposurePriority' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_ExposureOptions20 + type: object + xml: + attribute: false + name: ExposureOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ExposurePriority: + description: '' + enum: + - LowNoise + - FrameRate + title: tt_ExposurePriority + type: string + xml: + attribute: false + name: ExposurePriority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FactoryDefaultType: + description: Enumeration describing the available factory default modes. + enum: + - Hard + - Soft + title: tt_FactoryDefaultType + type: string + xml: + attribute: false + name: FactoryDefaultType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FileProgress: + description: '' + properties: + FileName: + description: Exported file name + type: string + xml: + attribute: false + name: FileName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Progress: + description: Normalized percentage completion for uploading the exported + file + type: number + xml: + attribute: false + name: Progress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FileName + - Progress + title: tt_FileProgress + type: object + xml: + attribute: false + name: FileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindEventResult: + description: '' + properties: + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + xml: + attribute: false + name: Event + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + description: The recording where this event was found. Empty string if no + recording is associated with this event. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StartStateEvent: + 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. + type: boolean + xml: + attribute: false + name: StartStateEvent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Time: + description: The time when the event occured. + format: date-time + type: string + xml: + attribute: false + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackToken: + description: A reference to the track where this event was found. Empty + string if no track is associated with this event. + maxLength: 64 + type: string + xml: + attribute: false + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + title: tt_FindEventResult + type: object + xml: + attribute: false + name: FindEventResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindEventResultList: + description: '' + properties: + Result: + description: A FindEventResult structure for each found event matching the + search. + items: + $ref: '#/components/schemas/tt_FindEventResult' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + xml: + attribute: false + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SearchState + title: tt_FindEventResultList + type: object + xml: + attribute: false + name: FindEventResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindMetadataResult: + description: '' + properties: + RecordingToken: + description: A reference to the recording containing the metadata. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Time: + description: The point in time when the matching metadata occurs in the + metadata track. + format: date-time + type: string + xml: + attribute: false + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackToken: + description: A reference to the metadata track containing the matching metadata. + maxLength: 64 + type: string + xml: + attribute: false + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - TrackToken + - Time + title: tt_FindMetadataResult + type: object + xml: + attribute: false + name: FindMetadataResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindMetadataResultList: + description: '' + properties: + Result: + description: A FindMetadataResult structure for each found set of Metadata + matching the search. + items: + $ref: '#/components/schemas/tt_FindMetadataResult' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + xml: + attribute: false + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SearchState + title: tt_FindMetadataResultList + type: object + xml: + attribute: false + name: FindMetadataResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindPTZPositionResult: + description: '' + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The PTZ position. + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + description: A reference to the recording containing the PTZ position. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Time: + description: The time when the PTZ position was valid. + format: date-time + type: string + xml: + attribute: false + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackToken: + description: A reference to the metadata track containing the PTZ position. + maxLength: 64 + type: string + xml: + attribute: false + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - TrackToken + - Time + - Position + title: tt_FindPTZPositionResult + type: object + xml: + attribute: false + name: FindPTZPositionResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindPTZPositionResultList: + description: '' + properties: + Result: + description: A FindPTZPositionResult structure for each found PTZ position + matching the search. + items: + $ref: '#/components/schemas/tt_FindPTZPositionResult' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + xml: + attribute: false + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SearchState + title: tt_FindPTZPositionResultList + type: object + xml: + attribute: false + name: FindPTZPositionResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FindRecordingResultList: + description: '' + properties: + RecordingInformation: + description: A RecordingInformation structure for each found recording matching + the search. + items: + $ref: '#/components/schemas/tt_RecordingInformation' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + xml: + attribute: false + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SearchState + title: tt_FindRecordingResultList + type: object + xml: + attribute: false + name: FindRecordingResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FloatItems: + description: '' + properties: + Items: + description: '' + items: + type: number + xml: + attribute: false + name: Items + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_FloatItems + type: object + xml: + attribute: false + name: FloatItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FloatRange: + description: Range of values greater equal Min value and less equal Max value. + properties: + Max: + type: number + xml: + attribute: false + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Min: + type: number + xml: + attribute: false + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Min + - Max + title: tt_FloatRange + type: object + xml: + attribute: false + name: FloatRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusConfiguration: + description: '' + properties: + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - xml: + attribute: false + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultSpeed: + type: number + xml: + attribute: false + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FarLimit: + description: 'Parameter to set autofocus far limit (unit: meter). + + If set to 0.0, infinity will be used.' + type: number + xml: + attribute: false + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NearLimit: + description: 'Parameter to set autofocus near limit (unit: meter).' + type: number + xml: + attribute: false + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + title: tt_FocusConfiguration + type: object + xml: + attribute: false + name: FocusConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusConfiguration20: + description: '' + properties: + AFMode: + description: Zero or more modes as defined in enumeration tt:AFModes. + type: string + xml: + attribute: true + name: AFMode + prefix: tt + wrapped: false + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - description: Mode of auto focus. + xml: + attribute: false + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultSpeed: + type: number + xml: + attribute: false + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FarLimit: + description: 'Parameter to set autofocus far limit (unit: meter).' + type: number + xml: + attribute: false + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NearLimit: + description: 'Parameter to set autofocus near limit (unit: meter).' + type: number + xml: + attribute: false + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AutoFocusMode + title: tt_FocusConfiguration20 + type: object + xml: + attribute: false + name: FocusConfiguration20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusConfiguration20Extension: + description: '' + title: tt_FocusConfiguration20Extension + type: object + xml: + attribute: false + name: FocusConfiguration20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusMove: + description: '' + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocus' + - description: Parameters for the absolute focus control. + xml: + attribute: false + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocus' + - description: Parameter for the continuous focus control. + xml: + attribute: false + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocus' + - description: Parameters for the relative focus control. + xml: + attribute: false + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_FocusMove + type: object + xml: + attribute: false + name: FocusMove + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusOptions: + description: '' + properties: + AutoFocusModes: + description: '' + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - DefaultSpeed + - NearLimit + - FarLimit + title: tt_FocusOptions + type: object + xml: + attribute: false + name: FocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusOptions20: + description: '' + properties: + AutoFocusModes: + description: Supported modes for auto focus. + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of DefaultSpeed. + xml: + attribute: false + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of FarLimit. + xml: + attribute: false + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of NearLimit. + xml: + attribute: false + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_FocusOptions20 + type: object + xml: + attribute: false + name: FocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusOptions20Extension: + description: '' + properties: + AFModes: + description: Supported options for auto focus. Options shall be chosen from + tt:AFModes. + items: + type: string + xml: + attribute: false + name: AFModes + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_FocusOptions20Extension + type: object + xml: + attribute: false + name: FocusOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusStatus: + description: '' + properties: + Error: + description: Error status of focus. + type: string + xml: + attribute: false + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + attribute: false + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Position: + description: Status of focus position. + type: number + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Position + - MoveStatus + - Error + title: tt_FocusStatus + type: object + xml: + attribute: false + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusStatus20: + description: '' + properties: + Error: + description: Error status of focus. + type: string + xml: + attribute: false + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + attribute: false + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Position: + description: Status of focus position. + type: number + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Position + - MoveStatus + title: tt_FocusStatus20 + type: object + xml: + attribute: false + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_FocusStatus20Extension: + description: '' + title: tt_FocusStatus20Extension + type: object + xml: + attribute: false + name: FocusStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_G711DecOptions: + description: '' + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + attribute: false + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Bitrate + - SampleRateRange + title: tt_G711DecOptions + type: object + xml: + attribute: false + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_G726DecOptions: + description: '' + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + attribute: false + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Bitrate + - SampleRateRange + title: tt_G726DecOptions + type: object + xml: + attribute: false + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GenericEapPwdConfigurationExtension: + description: '' + title: tt_GenericEapPwdConfigurationExtension + type: object + xml: + attribute: false + name: GenericEapPwdConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GeoLocation: + description: '' + properties: + elevation: + description: Hight in meters above sea level. + type: number + xml: + attribute: true + name: elevation + prefix: tt + wrapped: false + lat: + description: North south location as angle. + type: number + xml: + attribute: true + name: lat + prefix: tt + wrapped: false + lon: + description: East west location as angle. + type: number + xml: + attribute: true + name: lon + prefix: tt + wrapped: false + title: tt_GeoLocation + type: object + xml: + attribute: false + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GeoOrientation: + description: '' + properties: + pitch: + description: Rotation around the y axis. + type: number + xml: + attribute: true + name: pitch + prefix: tt + wrapped: false + roll: + description: Rotation around the x axis. + type: number + xml: + attribute: true + name: roll + prefix: tt + wrapped: false + yaw: + description: Rotation around the z axis. + type: number + xml: + attribute: true + name: yaw + prefix: tt + wrapped: false + title: tt_GeoOrientation + type: object + xml: + attribute: false + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GetRecordingJobsResponseItem: + description: '' + properties: + JobConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfiguration' + - xml: + attribute: false + name: JobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + JobToken: + maxLength: 64 + type: string + xml: + attribute: false + name: JobToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - JobToken + - JobConfiguration + title: tt_GetRecordingJobsResponseItem + type: object + xml: + attribute: false + name: GetRecordingJobsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GetRecordingsResponseItem: + description: '' + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_RecordingConfiguration' + - description: Configuration of the recording. + xml: + attribute: false + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + description: Token of the recording. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_GetTracksResponseList' + - description: List of tracks. + xml: + attribute: false + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - Configuration + - Tracks + title: tt_GetRecordingsResponseItem + type: object + xml: + attribute: false + name: GetRecordingsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GetTracksResponseItem: + description: '' + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_TrackConfiguration' + - description: Configuration of the track. + xml: + attribute: false + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackToken: + description: Token of the track. + maxLength: 64 + type: string + xml: + attribute: false + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TrackToken + - Configuration + title: tt_GetTracksResponseItem + type: object + xml: + attribute: false + name: GetTracksResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_GetTracksResponseList: + description: '' + properties: + Track: + description: Configuration of a track. + items: + $ref: '#/components/schemas/tt_GetTracksResponseItem' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_GetTracksResponseList + type: object + xml: + attribute: false + name: GetTracksResponseList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_H264Configuration: + description: '' + properties: + GovLength: + 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. + format: int32 + type: integer + xml: + attribute: false + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + H264Profile: + allOf: + - $ref: '#/components/schemas/tt_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + xml: + attribute: false + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - GovLength + - H264Profile + title: tt_H264Configuration + type: object + xml: + attribute: false + name: H264Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_H264DecOptions: + description: '' + properties: + ResolutionsAvailable: + description: List of supported H.264 Video Resolutions + items: + $ref: '#/components/schemas/tt_VideoResolution' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 framerate range in fps + xml: + attribute: false + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedH264Profiles: + description: List of supported H264 Profiles (either baseline, main, extended + or high) + items: + $ref: '#/components/schemas/tt_H264Profile' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 bitrate range in kbps + xml: + attribute: false + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + title: tt_H264DecOptions + type: object + xml: + attribute: false + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_H264Options: + description: '' + properties: + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + xml: + attribute: false + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + attribute: false + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically + corresponds to the I-Frame distance. + xml: + attribute: false + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + H264ProfilesSupported: + description: List of supported H.264 profiles. + items: + $ref: '#/components/schemas/tt_H264Profile' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/tt_VideoResolution' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + title: tt_H264Options + type: object + xml: + attribute: false + name: H264Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_H264Options2: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + attribute: false + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BitrateRange + type: object + xml: + attribute: false + name: H264Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_H264Options2 + tt_H264Profile: + description: '' + enum: + - Baseline + - Main + - Extended + - High + title: tt_H264Profile + type: string + xml: + attribute: false + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_HostnameInformation: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FromDHCP: + description: Indicates whether the hostname is obtained from DHCP or not. + type: boolean + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: Indicates the hostname. + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FromDHCP + title: tt_HostnameInformation + type: object + xml: + attribute: false + name: HostnameInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_HostnameInformationExtension: + description: '' + title: tt_HostnameInformationExtension + type: object + xml: + attribute: false + name: HostnameInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IOCapabilities: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InputConnectors: + description: Number of input connectors. + format: int32 + type: integer + xml: + attribute: false + name: InputConnectors + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RelayOutputs: + description: Number of relay outputs. + format: int32 + type: integer + xml: + attribute: false + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_IOCapabilities + type: object + xml: + attribute: false + name: IOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IOCapabilitiesExtension: + description: '' + properties: + Auxiliary: + type: boolean + xml: + attribute: false + name: Auxiliary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AuxiliaryCommands: + description: '' + items: + maxLength: 128 + type: string + xml: + attribute: false + name: AuxiliaryCommands + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Extension + title: tt_IOCapabilitiesExtension + type: object + xml: + attribute: false + name: IOCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IOCapabilitiesExtension2: + description: '' + title: tt_IOCapabilitiesExtension2 + type: object + xml: + attribute: false + name: IOCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPAddress: + description: '' + properties: + IPv4Address: + description: IPv4 address. + type: string + xml: + attribute: false + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv6Address: + description: IPv6 address + type: string + xml: + attribute: false + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_IPAddress + type: object + xml: + attribute: false + name: IPAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPAddressFilter: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv4Address: + description: '' + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv6Address: + description: '' + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterType' + - xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_IPAddressFilter + type: object + xml: + attribute: false + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPAddressFilterExtension: + description: '' + title: tt_IPAddressFilterExtension + type: object + xml: + attribute: false + name: IPAddressFilterExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPAddressFilterType: + description: '' + enum: + - Allow + - Deny + title: tt_IPAddressFilterType + type: string + xml: + attribute: false + name: IPAddressFilterType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPType: + description: '' + enum: + - IPv4 + - IPv6 + title: tt_IPType + type: string + xml: + attribute: false + name: IPType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv4Configuration: + description: '' + properties: + DHCP: + description: Indicates whether or not DHCP is used. + type: boolean + xml: + attribute: false + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FromDHCP: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + LinkLocal: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: Link local address. + xml: + attribute: false + name: LinkLocal + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Manual: + description: List of manually added IPv4 addresses. + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - DHCP + title: tt_IPv4Configuration + type: object + xml: + attribute: false + name: IPv4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv4NetworkInterface: + description: '' + properties: + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv4Configuration' + - description: IPv4 configuration. + xml: + attribute: false + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Enabled: + description: Indicates whether or not IPv4 is enabled. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Enabled + - Config + title: tt_IPv4NetworkInterface + type: object + xml: + attribute: false + name: IPv4NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv4NetworkInterfaceSetConfiguration: + description: '' + properties: + DHCP: + description: Indicates whether or not DHCP is used. + type: boolean + xml: + attribute: false + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Enabled: + description: Indicates whether or not IPv4 is enabled. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Manual: + description: List of manually added IPv4 addresses. + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_IPv4NetworkInterfaceSetConfiguration + type: object + xml: + attribute: false + name: IPv4NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv6Configuration: + description: '' + properties: + AcceptRouterAdvert: + description: Indicates whether router advertisment is used. + type: boolean + xml: + attribute: false + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + attribute: false + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPv6ConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FromDHCP: + description: List of IPv6 addresses configured by using DHCP. + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FromRA: + description: List of IPv6 addresses configured by using router advertisment. + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + LinkLocal: + description: List of link local IPv6 addresses. + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Manual: + description: List of manually entered IPv6 addresses. + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - DHCP + title: tt_IPv6Configuration + type: object + xml: + attribute: false + name: IPv6Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv6ConfigurationExtension: + description: '' + title: tt_IPv6ConfigurationExtension + type: object + xml: + attribute: false + name: IPv6ConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv6DHCPConfiguration: + description: '' + enum: + - Auto + - Stateful + - Stateless + - false + title: tt_IPv6DHCPConfiguration + type: string + xml: + attribute: false + name: IPv6DHCPConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv6NetworkInterface: + description: '' + properties: + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv6Configuration' + - description: IPv6 configuration. + xml: + attribute: false + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Enabled: + description: Indicates whether or not IPv6 is enabled. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Enabled + title: tt_IPv6NetworkInterface + type: object + xml: + attribute: false + name: IPv6NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IPv6NetworkInterfaceSetConfiguration: + description: '' + properties: + AcceptRouterAdvert: + description: Indicates whether router advertisment is used. + type: boolean + xml: + attribute: false + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + attribute: false + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Enabled: + description: Indicates whether or not IPv6 is enabled. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Manual: + description: List of manually added IPv6 addresses. + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_IPv6NetworkInterfaceSetConfiguration + type: object + xml: + attribute: false + name: IPv6NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImageSendingType: + description: '' + enum: + - Embedded + - LocalStorage + - RemoteStorage + title: tt_ImageSendingType + type: string + xml: + attribute: false + name: ImageSendingType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImageStabilization: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Level: + description: Optional level parameter (unit unspecified) + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_ImageStabilization + type: object + xml: + attribute: false + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImageStabilizationExtension: + description: '' + title: tt_ImageStabilizationExtension + type: object + xml: + attribute: false + name: ImageStabilizationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImageStabilizationMode: + description: '' + enum: + - false + - true + - AUTO + - Extended + title: tt_ImageStabilizationMode + type: string + xml: + attribute: false + name: ImageStabilizationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImageStabilizationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Image Stabilization. + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Supported options of Image Stabilization mode parameter. + items: + $ref: '#/components/schemas/tt_ImageStabilizationMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_ImageStabilizationOptions + type: object + xml: + attribute: false + name: ImageStabilizationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImageStabilizationOptionsExtension: + description: '' + title: tt_ImageStabilizationOptionsExtension + type: object + xml: + attribute: false + name: ImageStabilizationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingCapabilities: + description: '' + properties: + XAddr: + description: Imaging service URI. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + title: tt_ImagingCapabilities + type: object + xml: + attribute: false + name: ImagingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingOptions: + description: '' + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions' + - xml: + attribute: false + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions' + - xml: + attribute: false + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions' + - xml: + attribute: false + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IrCutFilterModes: + description: '' + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions' + - xml: + attribute: false + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions' + - xml: + attribute: false + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + title: tt_ImagingOptions + type: object + xml: + attribute: false + name: ImagingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingOptions20: + description: '' + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + xml: + attribute: false + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Brightness. + xml: + attribute: false + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Color Saturation. + xml: + attribute: false + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Contrast. + xml: + attribute: false + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions20' + - description: Valid range of Exposure. + xml: + attribute: false + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20' + - description: Valid range of Focus. + xml: + attribute: false + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IrCutFilterModes: + description: Valid range of IrCutFilterModes. + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Sharpness. + xml: + attribute: false + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + xml: + attribute: false + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + xml: + attribute: false + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingOptions20 + type: object + xml: + attribute: false + name: ImagingOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingOptions20Extension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + xml: + attribute: false + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingOptions20Extension + type: object + xml: + attribute: false + name: ImagingOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingOptions20Extension2: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension3' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto + mode. + xml: + attribute: false + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingOptions20Extension2 + type: object + xml: + attribute: false + name: ImagingOptions20Extension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingOptions20Extension3: + description: '' + properties: + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/tt_DefoggingOptions' + - description: Options of parameters for Defogging feature. + xml: + attribute: false + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension4' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/tt_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + xml: + attribute: false + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + xml: + attribute: false + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingOptions20Extension3 + type: object + xml: + attribute: false + name: ImagingOptions20Extension3 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingOptions20Extension4: + description: '' + title: tt_ImagingOptions20Extension4 + type: object + xml: + attribute: false + name: ImagingOptions20Extension4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettings: + description: '' + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + xml: + attribute: false + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Brightness: + description: Image brightness (unit unspecified). + type: number + xml: + attribute: false + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ColorSaturation: + description: Color saturation of the image (unit unspecified). + type: number + xml: + attribute: false + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Contrast: + description: Contrast of the image (unit unspecified). + type: number + xml: + attribute: false + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure' + - description: Exposure mode of the device. + xml: + attribute: false + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration' + - description: Focus configuration. + xml: + attribute: false + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + attribute: false + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Sharpness: + description: Sharpness of the Video image. + type: number + xml: + attribute: false + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance' + - description: White balance settings. + xml: + attribute: false + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange' + - description: WDR settings. + xml: + attribute: false + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingSettings + type: object + xml: + attribute: false + name: ImagingSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettings20: + description: Type describing the ImagingSettings of a VideoSource. The supported + options and ranges can be obtained via the GetOptions command. + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + xml: + attribute: false + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Brightness: + description: Image brightness (unit unspecified). + type: number + xml: + attribute: false + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ColorSaturation: + description: Color saturation of the image (unit unspecified). + type: number + xml: + attribute: false + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Contrast: + description: Contrast of the image (unit unspecified). + type: number + xml: + attribute: false + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure20' + - description: Exposure mode of the device. + xml: + attribute: false + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension20' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20' + - description: Focus configuration. + xml: + attribute: false + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + attribute: false + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Sharpness: + description: Sharpness of the Video image. + type: number + xml: + attribute: false + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20' + - description: White balance settings. + xml: + attribute: false + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange20' + - description: WDR settings. + xml: + attribute: false + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingSettings20 + type: object + xml: + attribute: false + name: ImagingSettings20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettingsExtension: + description: '' + title: tt_ImagingSettingsExtension + type: object + xml: + attribute: false + name: ImagingSettingsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettingsExtension20: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension202' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + xml: + attribute: false + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingSettingsExtension20 + type: object + xml: + attribute: false + name: ImagingSettingsExtension20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettingsExtension202: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension203' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IrCutFilterAutoAdjustment: + description: An optional parameter applied to only auto mode to adjust timing + of toggling Ir cut filter. + items: + $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustment' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingSettingsExtension202 + type: object + xml: + attribute: false + name: ImagingSettingsExtension202 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettingsExtension203: + description: '' + properties: + Defogging: + allOf: + - $ref: '#/components/schemas/tt_Defogging' + - description: Optional element to configure Image Defogging. + xml: + attribute: false + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension204' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NoiseReduction: + allOf: + - $ref: '#/components/schemas/tt_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + xml: + attribute: false + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ToneCompensation: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + xml: + attribute: false + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingSettingsExtension203 + type: object + xml: + attribute: false + name: ImagingSettingsExtension203 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingSettingsExtension204: + description: '' + title: tt_ImagingSettingsExtension204 + type: object + xml: + attribute: false + name: ImagingSettingsExtension204 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingStatus: + description: '' + properties: + FocusStatus: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus' + - xml: + attribute: false + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FocusStatus + title: tt_ImagingStatus + type: object + xml: + attribute: false + name: ImagingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingStatus20: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FocusStatus20: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20' + - description: Status of focus. + xml: + attribute: false + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ImagingStatus20 + type: object + xml: + attribute: false + name: ImagingStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ImagingStatus20Extension: + description: '' + title: tt_ImagingStatus20Extension + type: object + xml: + attribute: false + name: ImagingStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IntItems: + description: List of values. + properties: + Items: + description: '' + items: + format: int32 + type: integer + xml: + attribute: false + name: Items + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_IntItems + type: object + xml: + attribute: false + name: IntItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IntRange: + description: Range of values greater equal Min value and less equal Max value. + properties: + Max: + format: int32 + type: integer + xml: + attribute: false + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Min: + format: int32 + type: integer + xml: + attribute: false + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Min + - Max + title: tt_IntRange + type: object + xml: + attribute: false + name: IntRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IntRectangle: + description: Rectangle defined by lower left corner position and size. Units + are pixel. + properties: + height: + format: int32 + type: integer + xml: + attribute: true + name: height + prefix: tt + wrapped: false + width: + format: int32 + type: integer + xml: + attribute: true + name: width + prefix: tt + wrapped: false + x: + format: int32 + type: integer + xml: + attribute: true + name: x + prefix: tt + wrapped: false + y: + format: int32 + type: integer + xml: + attribute: true + name: y + prefix: tt + wrapped: false + required: + - x + - y + - width + - height + title: tt_IntRectangle + type: object + xml: + attribute: false + name: IntRectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IntRectangleRange: + description: Range of a rectangle. The rectangle itself is defined by lower + left corner position and size. Units are pixel. + properties: + HeightRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of height. + xml: + attribute: false + name: HeightRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + WidthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of width. + xml: + attribute: false + name: WidthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of X-axis. + xml: + attribute: false + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of Y-axis. + xml: + attribute: false + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XRange + - YRange + - WidthRange + - HeightRange + title: tt_IntRectangleRange + type: object + xml: + attribute: false + name: IntRectangleRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IrCutFilterAutoAdjustment: + description: '' + properties: + BoundaryOffset: + 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). + type: number + xml: + attribute: false + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + BoundaryType: + description: Specifies which boundaries to automatically toggle Ir cut filter + following parameters are applied to. Its options shall be chosen from + tt:IrCutFilterAutoBoundaryType. + type: string + xml: + attribute: false + name: BoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResponseTime: + description: Delay time of toggling Ir cut filter to on/off after crossing + of the boundary exposure levels. + format: date-time + type: string + xml: + attribute: false + name: ResponseTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BoundaryType + title: tt_IrCutFilterAutoAdjustment + type: object + xml: + attribute: false + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IrCutFilterAutoAdjustmentExtension: + description: '' + title: tt_IrCutFilterAutoAdjustmentExtension + type: object + xml: + attribute: false + name: IrCutFilterAutoAdjustmentExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IrCutFilterAutoAdjustmentOptions: + description: '' + properties: + BoundaryOffset: + description: Indicates whether or not boundary offset for toggling Ir cut + filter is supported. + type: boolean + xml: + attribute: false + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + BoundaryType: + description: Supported options of boundary types for adjustment of Ir cut + filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + items: + type: string + xml: + attribute: false + name: BoundaryType + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + xml: + attribute: false + name: ResponseTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BoundaryType + title: tt_IrCutFilterAutoAdjustmentOptions + type: object + xml: + attribute: false + name: IrCutFilterAutoAdjustmentOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IrCutFilterAutoAdjustmentOptionsExtension: + description: '' + title: tt_IrCutFilterAutoAdjustmentOptionsExtension + type: object + xml: + attribute: false + name: IrCutFilterAutoAdjustmentOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IrCutFilterAutoBoundaryType: + description: '' + enum: + - Common + - ToOn + - ToOff + - Extended + title: tt_IrCutFilterAutoBoundaryType + type: string + xml: + attribute: false + name: IrCutFilterAutoBoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_IrCutFilterMode: + description: '' + enum: + - true + - false + - AUTO + title: tt_IrCutFilterMode + type: string + xml: + attribute: false + name: IrCutFilterMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ItemList: + description: '' + properties: + ElementItem: + description: Complex value structure. + items: + $ref: '#/components/schemas/tt_ElementItem' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SimpleItem: + description: Value name pair as defined by the corresponding description. + items: + $ref: '#/components/schemas/tt_SimpleItem' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ItemList + type: object + xml: + attribute: false + name: ItemList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_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." + properties: + ElementItemDescription: + description: Description of a complex type. The Type must reference a defined + type. + items: + $ref: '#/components/schemas/tt_ElementItemDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescriptionExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SimpleItemDescription: + description: Description of a simple item. The type must be of cathegory + simpleType (xs:string, xs:integer, xs:float, ...). + items: + $ref: '#/components/schemas/tt_SimpleItemDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ItemListDescription + type: object + xml: + attribute: false + name: ItemListDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ItemListDescriptionExtension: + description: '' + title: tt_ItemListDescriptionExtension + type: object + xml: + attribute: false + name: ItemListDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ItemListExtension: + description: '' + title: tt_ItemListExtension + type: object + xml: + attribute: false + name: ItemListExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_JpegDecOptions: + description: '' + properties: + ResolutionsAvailable: + description: List of supported Jpeg Video Resolutions + items: + $ref: '#/components/schemas/tt_VideoResolution' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg framerate range in fps + xml: + attribute: false + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg bitrate range in kbps + xml: + attribute: false + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + title: tt_JpegDecOptions + type: object + xml: + attribute: false + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_JpegOptions: + description: '' + properties: + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + xml: + attribute: false + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + attribute: false + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/tt_VideoResolution' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + title: tt_JpegOptions + type: object + xml: + attribute: false + name: JpegOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_JpegOptions2: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + attribute: false + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BitrateRange + type: object + xml: + attribute: false + name: JpegOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_JpegOptions2 + tt_Layout: + description: A layout describes a set of Video windows that are displayed simultaniously + on a display. + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PaneLayout: + description: List of panes assembling the display layout. + items: + $ref: '#/components/schemas/tt_PaneLayout' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PaneLayout + title: tt_Layout + type: object + xml: + attribute: false + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LayoutExtension: + description: '' + title: tt_LayoutExtension + type: object + xml: + attribute: false + name: LayoutExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LayoutOptions: + description: The options supported for a display layout. + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PaneLayoutOptions: + description: Lists the possible Pane Layouts of the Video Output + items: + $ref: '#/components/schemas/tt_PaneLayoutOptions' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PaneLayoutOptions + title: tt_LayoutOptions + type: object + xml: + attribute: false + name: LayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LayoutOptionsExtension: + description: '' + title: tt_LayoutOptionsExtension + type: object + xml: + attribute: false + name: LayoutOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LensDescription: + description: '' + properties: + FocalLength: + description: Optional focal length of the optical system. + type: number + xml: + attribute: true + name: FocalLength + prefix: tt + wrapped: false + Offset: + allOf: + - $ref: '#/components/schemas/tt_LensOffset' + - description: Offset of the lens center to the imager center in normalized + coordinates. + xml: + attribute: false + name: Offset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Projection: + description: "Radial description of the projection characteristics. The\ + \ resulting curve is defined by the B-Spline interpolation \n\t\t\t\t\t\ + over 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)." + items: + $ref: '#/components/schemas/tt_LensProjection' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XFactor: + description: Compensation of the x coordinate needed for the ONVIF normalized + coordinate system. + type: number + xml: + attribute: false + name: XFactor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Offset + - Projection + - XFactor + title: tt_LensDescription + type: object + xml: + attribute: false + name: LensDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LensOffset: + description: '' + properties: + x: + description: Optional horizontal offset of the lens center in normalized + coordinates. + type: number + xml: + attribute: true + name: x + prefix: tt + wrapped: false + y: + description: Optional vertical offset of the lens center in normalized coordinates. + type: number + xml: + attribute: true + name: y + prefix: tt + wrapped: false + title: tt_LensOffset + type: object + xml: + attribute: false + name: LensOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LensProjection: + description: '' + properties: + Angle: + description: Angle of incidence. + type: number + xml: + attribute: false + name: Angle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Radius: + description: Mapping radius as a consequence of the emergent angle. + type: number + xml: + attribute: false + name: Radius + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Transmittance: + description: Optional ray absorption at the given angle due to vignetting. + A value of one means no absorption. + type: number + xml: + attribute: false + name: Transmittance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Angle + - Radius + title: tt_LensProjection + type: object + xml: + attribute: false + name: LensProjection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LocalLocation: + description: '' + properties: + x: + description: East west location as angle. + type: number + xml: + attribute: true + name: x + prefix: tt + wrapped: false + y: + description: North south location as angle. + type: number + xml: + attribute: true + name: y + prefix: tt + wrapped: false + z: + description: Offset in meters from the sea level. + type: number + xml: + attribute: true + name: z + prefix: tt + wrapped: false + title: tt_LocalLocation + type: object + xml: + attribute: false + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LocalOrientation: + description: '' + properties: + pan: + description: Rotation around the y axis. + type: number + xml: + attribute: true + name: pan + prefix: tt + wrapped: false + roll: + description: Rotation around the x axis. + type: number + xml: + attribute: true + name: roll + prefix: tt + wrapped: false + tilt: + description: Rotation around the z axis. + type: number + xml: + attribute: true + name: tilt + prefix: tt + wrapped: false + title: tt_LocalOrientation + type: object + xml: + attribute: false + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_LocationEntity: + description: '' + properties: + AutoGeo: + description: If set the geo location is obtained internally. + type: boolean + xml: + attribute: true + name: AutoGeo + prefix: tt + wrapped: false + Entity: + description: Entity type the entry refers to, use a value from the tt:Entity + enumeration. + type: string + xml: + attribute: true + name: Entity + prefix: tt + wrapped: false + Fixed: + description: If this value is true the entity cannot be deleted. + type: boolean + xml: + attribute: true + name: Fixed + prefix: tt + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: Location on earth. + xml: + attribute: false + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GeoOrientation: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Orientation relative to earth. + xml: + attribute: false + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GeoSource: + description: Optional reference to the XAddr of another devices DeviceManagement + service. + type: string + xml: + attribute: true + name: GeoSource + prefix: tt + wrapped: false + LocalLocation: + allOf: + - $ref: '#/components/schemas/tt_LocalLocation' + - description: Indoor location offset. + xml: + attribute: false + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + LocalOrientation: + allOf: + - $ref: '#/components/schemas/tt_LocalOrientation' + - description: Indoor orientation offset. + xml: + attribute: false + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Token: + description: Optional entity token. + maxLength: 64 + type: string + xml: + attribute: true + name: Token + prefix: tt + wrapped: false + title: tt_LocationEntity + type: object + xml: + attribute: false + name: LocationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MaximumNumberOfOSDs: + description: '' + properties: + Date: + format: int32 + type: integer + xml: + attribute: true + name: Date + prefix: tt + wrapped: false + DateAndTime: + format: int32 + type: integer + xml: + attribute: true + name: DateAndTime + prefix: tt + wrapped: false + Image: + format: int32 + type: integer + xml: + attribute: true + name: Image + prefix: tt + wrapped: false + PlainText: + format: int32 + type: integer + xml: + attribute: true + name: PlainText + prefix: tt + wrapped: false + Time: + format: int32 + type: integer + xml: + attribute: true + name: Time + prefix: tt + wrapped: false + Total: + format: int32 + type: integer + xml: + attribute: true + name: Total + prefix: tt + wrapped: false + required: + - Total + title: tt_MaximumNumberOfOSDs + type: object + xml: + attribute: false + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MediaAttributes: + description: A set of media attributes valid for a recording at a point in time + or for a time interval. + properties: + From: + description: The attributes are valid from this point in time in the recording. + format: date-time + type: string + xml: + attribute: false + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + description: A reference to the recording that has these attributes. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackAttributes: + description: A set of attributes for each track. + items: + $ref: '#/components/schemas/tt_TrackAttributes' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Until: + 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. + format: date-time + type: string + xml: + attribute: false + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - From + - Until + title: tt_MediaAttributes + type: object + xml: + attribute: false + name: MediaAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MediaCapabilities: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + xml: + attribute: false + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + description: Media service URI. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - StreamingCapabilities + title: tt_MediaCapabilities + type: object + xml: + attribute: false + name: MediaCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MediaCapabilitiesExtension: + description: '' + properties: + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tt_ProfileCapabilities' + - xml: + attribute: false + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ProfileCapabilities + title: tt_MediaCapabilitiesExtension + type: object + xml: + attribute: false + name: MediaCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MediaUri: + description: '' + properties: + InvalidAfterConnect: + description: Indicates if the Uri is only valid until the connection is + established. The value shall be set to "false". + type: boolean + xml: + attribute: false + name: InvalidAfterConnect + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InvalidAfterReboot: + description: Indicates if the Uri is invalid after a reboot of the device. + The value shall be set to "false". + type: boolean + xml: + attribute: false + name: InvalidAfterReboot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Timeout: + 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 + format: date-time + type: string + xml: + attribute: false + name: Timeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Uri: + description: Stable Uri to be used for requesting the media stream + type: string + xml: + attribute: false + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + title: tt_MediaUri + type: object + xml: + attribute: false + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Message: + description: '' + properties: + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + attribute: false + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + attribute: false + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PropertyOperation: + allOf: + - $ref: '#/components/schemas/tt_PropertyOperation' + - xml: + attribute: true + name: PropertyOperation + prefix: tt + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: Token value pairs that triggered this message. Typically + only one item is present. + xml: + attribute: false + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + UtcTime: + format: date-time + type: string + xml: + attribute: true + name: UtcTime + prefix: tt + wrapped: false + required: + - UtcTime + title: tt_Message + type: object + xml: + attribute: false + name: Message + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MessageDescription: + description: '' + properties: + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes the payload of the message. + xml: + attribute: false + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageDescriptionExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IsProperty: + 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. + type: boolean + xml: + attribute: true + name: IsProperty + prefix: tt + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes optional message payload parameters that may be + used as key. E.g. object IDs of tracked objects are conveyed as key. + xml: + attribute: false + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - 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." + xml: + attribute: false + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_MessageDescription + type: object + xml: + attribute: false + name: MessageDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MessageDescriptionExtension: + description: '' + title: tt_MessageDescriptionExtension + type: object + xml: + attribute: false + name: MessageDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MessageExtension: + description: '' + title: tt_MessageExtension + type: object + xml: + attribute: false + name: MessageExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Messages: + allOf: + - $ref: '#/components/schemas/tt_MessageDescription' + - properties: + ParentTopic: + description: The topic of the message. For historical reason the element + is named ParentTopic, but the full topic is expected. + type: string + xml: + attribute: false + name: ParentTopic + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ParentTopic + type: object + xml: + attribute: false + name: Messages + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: 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." + title: tt_Messages + tt_MetadataAttributes: + description: '' + properties: + CanContainAnalytics: + description: Indicates that there can be analytics data in the metadata + track in the specified time interval. + type: boolean + xml: + attribute: false + name: CanContainAnalytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CanContainNotifications: + description: Indicates that there can be notifications in the metadata track + in the specified time interval. + type: boolean + xml: + attribute: false + name: CanContainNotifications + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CanContainPTZ: + description: Indicates that there can be PTZ data in the metadata track + in the specified time interval. + type: boolean + xml: + attribute: false + name: CanContainPTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PtzSpaces: + 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. + type: string + xml: + attribute: true + name: PtzSpaces + prefix: tt + wrapped: false + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + title: tt_MetadataAttributes + type: object + xml: + attribute: false + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataCompressionType: + description: '' + enum: + - None + - GZIP + - EXI + title: tt_MetadataCompressionType + type: string + xml: + attribute: false + name: MetadataCompressionType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + Analytics: + description: Defines whether the streamed metadata will include metadata + from the analytics engines (video, cell motion, audio etc.) + type: boolean + xml: + attribute: false + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - 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." + xml: + attribute: false + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CompressionType: + description: Optional parameter to configure compression type of Metadata + payload. Use values from enumeration MetadataCompressionType. + type: string + xml: + attribute: true + name: CompressionType + prefix: tt + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventSubscription' + - 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\t\ + none or some of the events produced by the device:" + xml: + attribute: false + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GeoLocation: + description: Optional parameter to configure if the metadata stream shall + contain the Geo Location coordinates of each target. + type: boolean + xml: + attribute: true + name: GeoLocation + prefix: tt + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + xml: + attribute: false + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZFilter' + - description: optional element to configure which PTZ related data is + to include in the metadata stream + xml: + attribute: false + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SessionTimeout: + description: The rtsp session timeout for the related audio stream (when + using Media2 Service, this value is deprecated and ignored) + format: date-time + type: string + xml: + attribute: false + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ShapePolygon: + description: Optional parameter to configure if the generated metadata + stream should contain shape information as polygon. + type: boolean + xml: + attribute: true + name: ShapePolygon + prefix: tt + wrapped: false + required: + - Multicast + - SessionTimeout + type: object + xml: + attribute: false + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_MetadataConfiguration + tt_MetadataConfigurationExtension: + description: '' + title: tt_MetadataConfigurationExtension + type: object + xml: + attribute: false + name: MetadataConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataConfigurationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GeoLocation: + description: True if the device is able to stream the Geo Located positions + of each target. + type: boolean + xml: + attribute: true + name: GeoLocation + prefix: tt + wrapped: false + MaxContentFilterSize: + description: A device signalling support for content filtering shall support + expressions with the provided expression size. + format: int32 + type: integer + xml: + attribute: true + name: MaxContentFilterSize + prefix: tt + wrapped: false + PTZStatusFilterOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptions' + - xml: + attribute: false + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PTZStatusFilterOptions + title: tt_MetadataConfigurationOptions + type: object + xml: + attribute: false + name: MetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataConfigurationOptionsExtension: + description: '' + properties: + CompressionType: + description: List of supported metadata compression type. Its options shall + be chosen from tt:MetadataCompressionType. + items: + type: string + xml: + attribute: false + name: CompressionType + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_MetadataConfigurationOptionsExtension + type: object + xml: + attribute: false + name: MetadataConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataConfigurationOptionsExtension2: + description: '' + title: tt_MetadataConfigurationOptionsExtension2 + type: object + xml: + attribute: false + name: MetadataConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataFilter: + description: '' + properties: + MetadataStreamFilter: + type: string + xml: + attribute: false + name: MetadataStreamFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - MetadataStreamFilter + title: tt_MetadataFilter + type: object + xml: + attribute: false + name: MetadataFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataInput: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataInputExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MetadataConfig: + description: '' + items: + $ref: '#/components/schemas/tt_Config' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_MetadataInput + type: object + xml: + attribute: false + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MetadataInputExtension: + description: '' + title: tt_MetadataInputExtension + type: object + xml: + attribute: false + name: MetadataInputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ModeOfOperation: + description: '' + enum: + - Idle + - Active + - Unknown + title: tt_ModeOfOperation + type: string + xml: + attribute: false + name: ModeOfOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MotionExpression: + description: '' + properties: + Expression: + description: Motion Expression data structure contains motion expression + which is based on Scene Descriptor schema with XPATH syntax. The Type + argument could allow introduction of different dialects + type: string + xml: + attribute: false + name: Expression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + type: string + xml: + attribute: true + name: Type + prefix: tt + wrapped: false + required: + - Expression + title: tt_MotionExpression + type: object + xml: + attribute: false + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MotionExpressionConfiguration: + description: '' + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/tt_MotionExpression' + - description: Contains Rule MotionExpression configuration + xml: + attribute: false + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - MotionExpression + title: tt_MotionExpressionConfiguration + type: object + xml: + attribute: false + name: MotionExpressionConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MoveAndTrackMethod: + description: '' + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + title: tt_MoveAndTrackMethod + type: string + xml: + attribute: false + name: MoveAndTrackMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MoveOptions: + description: '' + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - xml: + attribute: false + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - xml: + attribute: false + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions' + - xml: + attribute: false + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_MoveOptions + type: object + xml: + attribute: false + name: MoveOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MoveOptions20: + description: '' + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + xml: + attribute: false + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + xml: + attribute: false + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + xml: + attribute: false + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_MoveOptions20 + type: object + xml: + attribute: false + name: MoveOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MoveStatus: + description: '' + enum: + - IDLE + - MOVING + - UNKNOWN + title: tt_MoveStatus + type: string + xml: + attribute: false + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Mpeg4Configuration: + description: '' + properties: + GovLength: + 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. + format: int32 + type: integer + xml: + attribute: false + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced + simple profile (ASP) + xml: + attribute: false + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - GovLength + - Mpeg4Profile + title: tt_Mpeg4Configuration + type: object + xml: + attribute: false + name: Mpeg4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Mpeg4DecOptions: + description: '' + properties: + ResolutionsAvailable: + description: List of supported Mpeg4 Video Resolutions + items: + $ref: '#/components/schemas/tt_VideoResolution' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 framerate range in fps + xml: + attribute: false + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + xml: + attribute: false + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedMpeg4Profiles: + description: List of supported Mpeg4 Profiles (either SP or ASP) + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + title: tt_Mpeg4DecOptions + type: object + xml: + attribute: false + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Mpeg4Options: + description: '' + properties: + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + xml: + attribute: false + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + attribute: false + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically + corresponds to the I-Frame distance. + xml: + attribute: false + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mpeg4ProfilesSupported: + description: List of supported MPEG-4 profiles. + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/tt_VideoResolution' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + title: tt_Mpeg4Options + type: object + xml: + attribute: false + name: Mpeg4Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Mpeg4Options2: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + attribute: false + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BitrateRange + type: object + xml: + attribute: false + name: Mpeg4Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_Mpeg4Options2 + tt_Mpeg4Profile: + description: '' + enum: + - SP + - ASP + title: tt_Mpeg4Profile + type: string + xml: + attribute: false + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_MulticastConfiguration: + description: '' + properties: + Address: + allOf: + - $ref: '#/components/schemas/tt_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast + streaming is enaled) + xml: + attribute: false + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AutoStart: + description: Read only property signalling that streaming is persistant. + Use the methods StartMulticastStreaming and StopMulticastStreaming to + switch its state. + type: boolean + xml: + attribute: false + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Port: + description: The RTP mutlicast 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. + format: int32 + type: integer + xml: + attribute: false + name: Port + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TTL: + 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. + format: int32 + type: integer + xml: + attribute: false + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Address + - Port + - TTL + - AutoStart + title: tt_MulticastConfiguration + type: object + xml: + attribute: false + name: MulticastConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NTPInformation: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_NTPInformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FromDHCP: + description: Indicates if NTP information is to be retrieved by using DHCP. + type: boolean + xml: + attribute: false + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NTPFromDHCP: + description: List of NTP addresses retrieved by using DHCP. + items: + $ref: '#/components/schemas/tt_NetworkHost' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NTPManual: + description: List of manually entered NTP addresses. + items: + $ref: '#/components/schemas/tt_NetworkHost' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FromDHCP + title: tt_NTPInformation + type: object + xml: + attribute: false + name: NTPInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NTPInformationExtension: + description: '' + title: tt_NTPInformationExtension + type: object + xml: + attribute: false + name: NTPInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkCapabilities: + description: '' + properties: + DynDNS: + description: Indicates whether or not is supported. + type: boolean + xml: + attribute: false + name: DynDNS + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPFilter: + description: Indicates whether or not IP filtering is supported. + type: boolean + xml: + attribute: false + name: IPFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPVersion6: + description: Indicates whether or not IPv6 is supported. + type: boolean + xml: + attribute: false + name: IPVersion6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ZeroConfiguration: + description: Indicates whether or not zeroconf is supported. + type: boolean + xml: + attribute: false + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_NetworkCapabilities + type: object + xml: + attribute: false + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkCapabilitiesExtension: + description: '' + properties: + Dot11Configuration: + type: boolean + xml: + attribute: false + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_NetworkCapabilitiesExtension + type: object + xml: + attribute: false + name: NetworkCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkCapabilitiesExtension2: + description: '' + title: tt_NetworkCapabilitiesExtension2 + type: object + xml: + attribute: false + name: NetworkCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkGateway: + description: '' + properties: + IPv4Address: + description: IPv4 address string. + items: + type: string + xml: + attribute: false + name: IPv4Address + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv6Address: + description: IPv6 address string. + items: + type: string + xml: + attribute: false + name: IPv6Address + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_NetworkGateway + type: object + xml: + attribute: false + name: NetworkGateway + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkHost: + description: '' + properties: + DNSname: + description: DNS name. + type: string + xml: + attribute: false + name: DNSname + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv4Address: + description: IPv4 address. + type: string + xml: + attribute: false + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv6Address: + description: IPv6 address. + type: string + xml: + attribute: false + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_NetworkHost + type: object + xml: + attribute: false + name: NetworkHost + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkHostExtension: + description: '' + title: tt_NetworkHostExtension + type: object + xml: + attribute: false + name: NetworkHostExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkHostType: + description: '' + enum: + - IPv4 + - IPv6 + - DNS + title: tt_NetworkHostType + type: string + xml: + attribute: false + name: NetworkHostType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterface: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + Enabled: + description: Indicates whether or not an interface is enabled. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + xml: + attribute: false + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + xml: + attribute: false + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Info: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceInfo' + - description: Network interface information + xml: + attribute: false + name: Info + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceLink' + - description: Link configuration. + xml: + attribute: false + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Enabled + type: object + xml: + attribute: false + name: NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_NetworkInterface + tt_NetworkInterfaceConnectionSetting: + description: '' + properties: + AutoNegotiation: + description: Auto negotiation on/off. + type: boolean + xml: + attribute: false + name: AutoNegotiation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Duplex: + allOf: + - $ref: '#/components/schemas/tt_Duplex' + - description: Duplex type, Half or Full. + xml: + attribute: false + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + description: Speed. + format: int32 + type: integer + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AutoNegotiation + - Speed + - Duplex + title: tt_NetworkInterfaceConnectionSetting + type: object + xml: + attribute: false + name: NetworkInterfaceConnectionSetting + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceExtension: + description: '' + properties: + Dot11: + description: '' + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Dot3: + description: Extension point prepared for future 802.3 configuration. + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InterfaceType: + format: int32 + type: integer + xml: + attribute: false + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - InterfaceType + title: tt_NetworkInterfaceExtension + type: object + xml: + attribute: false + name: NetworkInterfaceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceExtension2: + description: '' + title: tt_NetworkInterfaceExtension2 + type: object + xml: + attribute: false + name: NetworkInterfaceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceInfo: + description: '' + properties: + HwAddress: + description: Network interface MAC address. + type: string + xml: + attribute: false + name: HwAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MTU: + description: Maximum transmission unit. + format: int32 + type: integer + xml: + attribute: false + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: Network interface name, for example eth0. + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - HwAddress + title: tt_NetworkInterfaceInfo + type: object + xml: + attribute: false + name: NetworkInterfaceInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceLink: + description: '' + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + xml: + attribute: false + name: AdminSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InterfaceType: + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + type: integer + xml: + attribute: false + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + OperSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + xml: + attribute: false + name: OperSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AdminSettings + - OperSettings + - InterfaceType + title: tt_NetworkInterfaceLink + type: object + xml: + attribute: false + name: NetworkInterfaceLink + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceSetConfiguration: + description: '' + properties: + Enabled: + description: Indicates whether or not an interface is enabled. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + xml: + attribute: false + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + xml: + attribute: false + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Link configuration. + xml: + attribute: false + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MTU: + description: Maximum transmission unit. + format: int32 + type: integer + xml: + attribute: false + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_NetworkInterfaceSetConfiguration + type: object + xml: + attribute: false + name: NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension: + description: '' + properties: + Dot11: + description: '' + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Dot3: + description: '' + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_NetworkInterfaceSetConfigurationExtension + type: object + xml: + attribute: false + name: NetworkInterfaceSetConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension2: + description: '' + title: tt_NetworkInterfaceSetConfigurationExtension2 + type: object + xml: + attribute: false + name: NetworkInterfaceSetConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkProtocol: + description: '' + properties: + Enabled: + description: Indicates if the protocol is enabled or not. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolType' + - description: Network protocol type string. + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Port: + description: The port that is used by the protocol. + items: + format: int32 + type: integer + xml: + attribute: false + name: Port + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Name + - Enabled + - Port + title: tt_NetworkProtocol + type: object + xml: + attribute: false + name: NetworkProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkProtocolExtension: + description: '' + title: tt_NetworkProtocolExtension + type: object + xml: + attribute: false + name: NetworkProtocolExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkProtocolType: + description: '' + enum: + - HTTP + - HTTPS + - RTSP + title: tt_NetworkProtocolType + type: string + xml: + attribute: false + name: NetworkProtocolType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkZeroConfiguration: + description: '' + properties: + Addresses: + description: The zero-configuration IPv4 address(es) + items: + type: string + xml: + attribute: false + name: Addresses + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Enabled: + description: Indicates whether the zero-configuration is enabled or not. + type: boolean + xml: + attribute: false + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + InterfaceToken: + description: Unique identifier of network interface. + maxLength: 64 + type: string + xml: + attribute: false + name: InterfaceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - InterfaceToken + - Enabled + title: tt_NetworkZeroConfiguration + type: object + xml: + attribute: false + name: NetworkZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkZeroConfigurationExtension: + description: '' + properties: + Additional: + description: Optional array holding the configuration for the second and + possibly further interfaces. + items: + $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_NetworkZeroConfigurationExtension + type: object + xml: + attribute: false + name: NetworkZeroConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NetworkZeroConfigurationExtension2: + description: '' + title: tt_NetworkZeroConfigurationExtension2 + type: object + xml: + attribute: false + name: NetworkZeroConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NoiseReduction: + description: '' + properties: + Level: + description: Level parameter specified with unitless normalized value from + 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Level + title: tt_NoiseReduction + type: object + xml: + attribute: false + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_NoiseReductionOptions: + description: '' + properties: + Level: + description: Indicates whether or not support Level parameter for NoiseReduction. + type: boolean + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Level + title: tt_NoiseReductionOptions + type: object + xml: + attribute: false + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDColor: + description: 'The value range of "Transparent" could be defined by vendors only + should follow this rule: the minimum value means non-transparent and the maximum + value maens fully transparent.' + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + attribute: false + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Transparent: + format: int32 + type: integer + xml: + attribute: true + name: Transparent + prefix: tt + wrapped: false + required: + - Color + title: tt_OSDColor + type: object + xml: + attribute: false + name: OSDColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDColorOptions: + description: Describe the option of the color and its transparency. + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorOptions' + - description: Optional list of supported colors. + xml: + attribute: false + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Transparent: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + xml: + attribute: false + name: Transparent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_OSDColorOptions + type: object + xml: + attribute: false + name: OSDColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDColorOptionsExtension: + description: '' + title: tt_OSDColorOptionsExtension + type: object + xml: + attribute: false + name: OSDColorOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDConfiguration: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Image: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the + value of Type field is Image + xml: + attribute: false + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfiguration' + - description: Position configuration of OSD. + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TextString: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the + value of Type field is Text. + xml: + attribute: false + name: TextString + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_OSDType' + - description: Type of OSD. + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/tt_OSDReference' + - description: Reference to the video source configuration. + xml: + attribute: false + name: VideoSourceConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + xml: + attribute: false + name: OSDConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_OSDConfiguration + tt_OSDConfigurationExtension: + description: '' + title: tt_OSDConfigurationExtension + type: object + xml: + attribute: false + name: OSDConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDConfigurationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ImageOption: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall + be returned if the device is signaling the support for Image. + xml: + attribute: false + name: ImageOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/tt_MaximumNumberOfOSDs' + - 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. + xml: + attribute: false + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PositionOption: + description: 'List available OSD position type. Following are the pre-defined:' + items: + type: string + xml: + attribute: false + name: PositionOption + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TextOption: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall + be returned if the device is signaling the support for Text. + xml: + attribute: false + name: TextOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + 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. + items: + $ref: '#/components/schemas/tt_OSDType' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + title: tt_OSDConfigurationOptions + type: object + xml: + attribute: false + name: OSDConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDConfigurationOptionsExtension: + description: '' + title: tt_OSDConfigurationOptionsExtension + type: object + xml: + attribute: false + name: OSDConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDImgConfiguration: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ImgPath: + description: The URI of the image which to be displayed. + type: string + xml: + attribute: false + name: ImgPath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ImgPath + title: tt_OSDImgConfiguration + type: object + xml: + attribute: false + name: OSDImgConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDImgConfigurationExtension: + description: '' + title: tt_OSDImgConfigurationExtension + type: object + xml: + attribute: false + name: OSDImgConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDImgOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FormatsSupported: + description: List of supported image MIME types, such as "image/png". + type: string + xml: + attribute: true + name: FormatsSupported + prefix: tt + wrapped: false + ImagePath: + description: List of available image URIs. + items: + type: string + xml: + attribute: false + name: ImagePath + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxHeight: + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + type: integer + xml: + attribute: true + name: MaxHeight + prefix: tt + wrapped: false + MaxSize: + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + type: integer + xml: + attribute: true + name: MaxSize + prefix: tt + wrapped: false + MaxWidth: + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + type: integer + xml: + attribute: true + name: MaxWidth + prefix: tt + wrapped: false + required: + - ImagePath + title: tt_OSDImgOptions + type: object + xml: + attribute: false + name: OSDImgOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDImgOptionsExtension: + description: '' + title: tt_OSDImgOptionsExtension + type: object + xml: + attribute: false + name: OSDImgOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDPosConfiguration: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Pos: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + attribute: false + name: Pos + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + description: 'For OSD position type, following are the pre-defined:' + type: string + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_OSDPosConfiguration + type: object + xml: + attribute: false + name: OSDPosConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDPosConfigurationExtension: + description: '' + title: tt_OSDPosConfigurationExtension + type: object + xml: + attribute: false + name: OSDPosConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDReference: + description: '' + title: tt_OSDReference + type: object + xml: + attribute: false + name: OSDReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDTextConfiguration: + description: '' + properties: + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Background color of the text. + xml: + attribute: false + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DateFormat: + 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:' + type: string + xml: + attribute: false + name: DateFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Font color of the text. + xml: + attribute: false + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FontSize: + description: Font size of the text in pt. + format: int32 + type: integer + xml: + attribute: false + name: FontSize + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IsPersistentText: + 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. + type: boolean + xml: + attribute: true + name: IsPersistentText + prefix: tt + wrapped: false + PlainText: + description: The content of text to be displayed. + type: string + xml: + attribute: false + name: PlainText + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TimeFormat: + 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:' + type: string + xml: + attribute: false + name: TimeFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + description: 'The following OSD Text Type are defined:' + type: string + xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_OSDTextConfiguration + type: object + xml: + attribute: false + name: OSDTextConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDTextConfigurationExtension: + description: '' + title: tt_OSDTextConfigurationExtension + type: object + xml: + attribute: false + name: OSDTextConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDTextOptions: + description: '' + properties: + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported background color. + xml: + attribute: false + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DateFormat: + description: List of supported date format. + items: + type: string + xml: + attribute: false + name: DateFormat + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported font color. + xml: + attribute: false + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FontSizeRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the font size value. + xml: + attribute: false + name: FontSizeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TimeFormat: + description: List of supported time format. + items: + type: string + xml: + attribute: false + name: TimeFormat + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + 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. + items: + type: string + xml: + attribute: false + name: Type + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + title: tt_OSDTextOptions + type: object + xml: + attribute: false + name: OSDTextOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDTextOptionsExtension: + description: '' + title: tt_OSDTextOptionsExtension + type: object + xml: + attribute: false + name: OSDTextOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OSDType: + description: '' + enum: + - Text + - Image + - Extended + title: tt_OSDType + type: string + xml: + attribute: false + name: OSDType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_OnvifVersion: + description: '' + properties: + Major: + description: Major version number. + format: int32 + type: integer + xml: + attribute: false + name: Major + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Minor: + 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." + format: int32 + type: integer + xml: + attribute: false + name: Minor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Major + - Minor + title: tt_OnvifVersion + type: object + xml: + attribute: false + name: OnvifVersion + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTControlDirection: + description: '' + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlip' + - description: Optional element to configure related parameters for E-Flip. + xml: + attribute: false + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_Reverse' + - description: Optional element to configure related parameters for reversing + of PT Control Direction. + xml: + attribute: false + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTControlDirection + type: object + xml: + attribute: false + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTControlDirectionExtension: + description: '' + title: tt_PTControlDirectionExtension + type: object + xml: + attribute: false + name: PTControlDirectionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTControlDirectionOptions: + description: '' + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptions' + - description: Supported options for EFlip feature. + xml: + attribute: false + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptions' + - description: Supported options for Reverse feature. + xml: + attribute: false + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTControlDirectionOptions + type: object + xml: + attribute: false + name: PTControlDirectionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTControlDirectionOptionsExtension: + description: '' + title: tt_PTControlDirectionOptionsExtension + type: object + xml: + attribute: false + name: PTControlDirectionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZCapabilities: + description: '' + properties: + XAddr: + description: PTZ service URI. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + title: tt_PTZCapabilities + type: object + xml: + attribute: false + name: PTZCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + DefaultAbsolutePantTiltPositionSpace: + description: If the PTZ Node supports absolute Pan/Tilt movements, it + shall specify one Absolute Pan/Tilt Position Space as default. + type: string + xml: + attribute: false + name: DefaultAbsolutePantTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultAbsoluteZoomPositionSpace: + description: If the PTZ Node supports absolute zoom movements, it shall + specify one Absolute Zoom Position Space as default. + type: string + xml: + attribute: false + name: DefaultAbsoluteZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultContinuousPanTiltVelocitySpace: + description: If the PTZ Node supports continuous Pan/Tilt movements, it + shall specify one Continuous Pan/Tilt Velocity Space as default. + type: string + xml: + attribute: false + name: DefaultContinuousPanTiltVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultContinuousZoomVelocitySpace: + description: If the PTZ Node supports continuous zoom movements, it shall + specify one Continuous Zoom Velocity Space as default. + type: string + xml: + attribute: false + name: DefaultContinuousZoomVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, + it shall specify corresponding default Pan/Tilt and Zoom speeds. + xml: + attribute: false + name: DefaultPTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultPTZTimeout: + description: If the PTZ Node supports continuous movements, it shall specify + a default timeout, after which the movement stops. + format: date-time + type: string + xml: + attribute: false + name: DefaultPTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultRelativePanTiltTranslationSpace: + description: If the PTZ Node supports relative Pan/Tilt movements, it + shall specify one RelativePan/Tilt Translation Space as default. + type: string + xml: + attribute: false + name: DefaultRelativePanTiltTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DefaultRelativeZoomTranslationSpace: + description: If the PTZ Node supports relative zoom movements, it shall + specify one Relative Zoom Translation Space as default. + type: string + xml: + attribute: false + name: DefaultRelativeZoomTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MoveRamp: + description: The optional acceleration ramp used by the device when moving. + format: int32 + type: integer + xml: + attribute: true + name: MoveRamp + prefix: tt + wrapped: false + NodeToken: + description: A mandatory reference to the PTZ Node that the PTZ Configuration + belongs to. + maxLength: 64 + type: string + xml: + attribute: false + name: NodeToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/tt_PanTiltLimits' + - 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 \u2013INF or +INF." + xml: + attribute: false + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PresetRamp: + description: The optional acceleration ramp used by the device when recalling + presets. + format: int32 + type: integer + xml: + attribute: true + name: PresetRamp + prefix: tt + wrapped: false + PresetTourRamp: + description: The optional acceleration ramp used by the device when executing + PresetTours. + format: int32 + type: integer + xml: + attribute: true + name: PresetTourRamp + prefix: tt + wrapped: false + ZoomLimits: + allOf: + - $ref: '#/components/schemas/tt_ZoomLimits' + - 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. + xml: + attribute: false + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - NodeToken + type: object + xml: + attribute: false + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_PTZConfiguration + tt_PTZConfigurationExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirection' + - description: Optional element to configure PT Control Direction related + features. + xml: + attribute: false + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZConfigurationExtension + type: object + xml: + attribute: false + name: PTZConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZConfigurationExtension2: + description: '' + title: tt_PTZConfigurationExtension2 + type: object + xml: + attribute: false + name: PTZConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZConfigurationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + xml: + attribute: false + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZRamps: + 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." + format: int32 + type: integer + xml: + attribute: true + name: PTZRamps + prefix: tt + wrapped: false + PTZTimeout: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the + PTZ Node. + xml: + attribute: false + name: PTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Spaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of supported coordinate systems including their range + limitations. + xml: + attribute: false + name: Spaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Spaces + - PTZTimeout + title: tt_PTZConfigurationOptions + type: object + xml: + attribute: false + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZConfigurationOptions2: + description: '' + title: tt_PTZConfigurationOptions2 + type: object + xml: + attribute: false + name: PTZConfigurationOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZFilter: + description: '' + properties: + Position: + description: True if the metadata stream shall contain the PTZ position + type: boolean + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Status: + description: True if the metadata stream shall contain the PTZ status (IDLE, + MOVING or UNKNOWN) + type: boolean + xml: + attribute: false + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Status + - Position + title: tt_PTZFilter + type: object + xml: + attribute: false + name: PTZFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZMoveStatus: + description: '' + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + attribute: false + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + attribute: false + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZMoveStatus + type: object + xml: + attribute: false + name: PTZMoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZNode: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + AuxiliaryCommands: + description: A list of supported Auxiliary commands. If the list is not + empty, the Auxiliary Operations MUST be available for this PTZ Node. + items: + maxLength: 128 + type: string + xml: + attribute: false + name: AuxiliaryCommands + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FixedHomePosition: + description: Indication whether the HomePosition of a Node is fixed or + it can be changed via the SetHomePosition command. + type: boolean + xml: + attribute: true + name: FixedHomePosition + prefix: tt + wrapped: false + GeoMove: + description: Indication whether the Node supports the geo-referenced move + command. + type: boolean + xml: + attribute: true + name: GeoMove + prefix: tt + wrapped: false + HomeSupported: + 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. + type: boolean + xml: + attribute: false + name: HomeSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaximumNumberOfPresets: + description: All preset operations MUST be available for this PTZ Node + if one preset is supported. + format: int32 + type: integer + xml: + attribute: false + name: MaximumNumberOfPresets + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: A unique identifier that is used to reference PTZ Nodes. + maxLength: 64 + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. + For each Coordinate System, the PTZ Node MUST specify its allowed + range. + xml: + attribute: false + name: SupportedPTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + xml: + attribute: false + name: PTZNode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_PTZNode + tt_PTZNodeExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + xml: + attribute: false + name: SupportedPresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZNodeExtension + type: object + xml: + attribute: false + name: PTZNodeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZNodeExtension2: + description: '' + title: tt_PTZNodeExtension2 + type: object + xml: + attribute: false + name: PTZNodeExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPositionFilter: + description: '' + properties: + EnterOrExit: + description: If true, search for when entering the specified PTZ volume. + type: boolean + xml: + attribute: false + name: EnterOrExit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + xml: + attribute: false + name: MaxPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MinPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + xml: + attribute: false + name: MinPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - MinPosition + - MaxPosition + - EnterOrExit + title: tt_PTZPositionFilter + type: object + xml: + attribute: false + name: PTZPositionFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPreset: + description: '' + properties: + Name: + description: A list of preset position name. + maxLength: 64 + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A list of preset position. + xml: + attribute: false + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + token: + maxLength: 64 + type: string + xml: + attribute: true + name: token + prefix: tt + wrapped: false + title: tt_PTZPreset + type: object + xml: + attribute: false + name: PTZPreset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourDirection: + description: '' + enum: + - Forward + - Backward + - Extended + title: tt_PTZPresetTourDirection + type: string + xml: + attribute: false + name: PTZPresetTourDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourExtension: + description: '' + title: tt_PTZPresetTourExtension + type: object + xml: + attribute: false + name: PTZPresetTourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourOperation: + description: '' + enum: + - Start + - Stop + - Pause + - Extended + title: tt_PTZPresetTourOperation + type: string + xml: + attribute: false + name: PTZPresetTourOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourOptions: + description: '' + properties: + AutoStart: + description: Indicates whether or not the AutoStart is supported. + type: boolean + xml: + attribute: false + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + xml: + attribute: false + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + xml: + attribute: false + name: TourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AutoStart + - StartingCondition + - TourSpot + title: tt_PTZPresetTourOptions + type: object + xml: + attribute: false + name: PTZPresetTourOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourPresetDetail: + description: '' + properties: + Home: + 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. + type: boolean + xml: + attribute: false + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ + node directly. + xml: + attribute: false + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PresetToken: + description: Option to specify the preset position with Preset Token defined + in advance. + maxLength: 64 + type: string + xml: + attribute: false + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + attribute: false + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZPresetTourPresetDetail + type: object + xml: + attribute: false + name: PTZPresetTourPresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourPresetDetailOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Home: + description: An option to indicate Home postion for tour spots. + type: boolean + xml: + attribute: false + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + xml: + attribute: false + name: PanTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PresetToken: + description: A list of available Preset Tokens for tour spots. + items: + maxLength: 64 + type: string + xml: + attribute: false + name: PresetToken + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + xml: + attribute: false + name: ZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZPresetTourPresetDetailOptions + type: object + xml: + attribute: false + name: PTZPresetTourPresetDetailOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourPresetDetailOptionsExtension: + description: '' + title: tt_PTZPresetTourPresetDetailOptionsExtension + type: object + xml: + attribute: false + name: PTZPresetTourPresetDetailOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourSpot: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + xml: + attribute: false + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on + moving toward this tour spot. + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StayTime: + description: Optional parameter to specify time duration of staying on this + tour sport. + format: date-time + type: string + xml: + attribute: false + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PresetDetail + title: tt_PTZPresetTourSpot + type: object + xml: + attribute: false + name: PTZPresetTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourSpotExtension: + description: '' + title: tt_PTZPresetTourSpotExtension + type: object + xml: + attribute: false + name: PTZPresetTourSpotExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourSpotOptions: + description: '' + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position + of the tour spot. + xml: + attribute: false + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StayTime: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of stay time for a tour spot. + xml: + attribute: false + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PresetDetail + - StayTime + title: tt_PTZPresetTourSpotOptions + type: object + xml: + attribute: false + name: PTZPresetTourSpotOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourStartingCondition: + description: '' + properties: + Direction: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour + goes. Forward shall be chosen in case it is omitted. + xml: + attribute: false + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RandomPresetOrder: + 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. + type: boolean + xml: + attribute: true + name: RandomPresetOrder + prefix: tt + wrapped: false + RecurringDuration: + description: Optional parameter to specify how long time duration the preset + tour is recurred. + format: date-time + type: string + xml: + attribute: false + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecurringTime: + description: Optional parameter to specify how many times the preset tour + is recurred. + format: int32 + type: integer + xml: + attribute: false + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZPresetTourStartingCondition + type: object + xml: + attribute: false + name: PTZPresetTourStartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourStartingConditionExtension: + description: '' + title: tt_PTZPresetTourStartingConditionExtension + type: object + xml: + attribute: false + name: PTZPresetTourStartingConditionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourStartingConditionOptions: + description: '' + properties: + Direction: + description: Supported options for Direction of Preset Tour. + items: + $ref: '#/components/schemas/tt_PTZPresetTourDirection' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecurringDuration: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of Recurring Duration. + xml: + attribute: false + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecurringTime: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of Recurring Time. + xml: + attribute: false + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZPresetTourStartingConditionOptions + type: object + xml: + attribute: false + name: PTZPresetTourStartingConditionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourStartingConditionOptionsExtension: + description: '' + title: tt_PTZPresetTourStartingConditionOptionsExtension + type: object + xml: + attribute: false + name: PTZPresetTourStartingConditionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourState: + description: '' + enum: + - Idle + - Touring + - Paused + - Extended + title: tt_PTZPresetTourState + type: string + xml: + attribute: false + name: PTZPresetTourState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourStatus: + description: '' + properties: + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + xml: + attribute: false + name: CurrentTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatusExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - State + title: tt_PTZPresetTourStatus + type: object + xml: + attribute: false + name: PTZPresetTourStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourStatusExtension: + description: '' + title: tt_PTZPresetTourStatusExtension + type: object + xml: + attribute: false + name: PTZPresetTourStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourSupported: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupportedExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaximumNumberOfPresetTours: + 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. + format: int32 + type: integer + xml: + attribute: false + name: MaximumNumberOfPresetTours + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZPresetTourOperation: + description: Indicates which preset tour operations are available for this + PTZ Node. + items: + $ref: '#/components/schemas/tt_PTZPresetTourOperation' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - MaximumNumberOfPresetTours + title: tt_PTZPresetTourSupported + type: object + xml: + attribute: false + name: PTZPresetTourSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourSupportedExtension: + description: '' + title: tt_PTZPresetTourSupportedExtension + type: object + xml: + attribute: false + name: PTZPresetTourSupportedExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZPresetTourTypeExtension: + description: '' + title: tt_PTZPresetTourTypeExtension + type: object + xml: + attribute: false + name: PTZPresetTourTypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZSpaces: + description: '' + properties: + AbsolutePanTiltPositionSpace: + 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." + items: + $ref: '#/components/schemas/tt_Space2DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AbsoluteZoomPositionSpace: + 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." + items: + $ref: '#/components/schemas/tt_Space1DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ContinuousPanTiltVelocitySpace: + 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\u2019\ + 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." + items: + $ref: '#/components/schemas/tt_Space2DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ContinuousZoomVelocitySpace: + 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." + items: + $ref: '#/components/schemas/tt_Space1DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZSpacesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PanTiltSpeedSpace: + 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." + items: + $ref: '#/components/schemas/tt_Space1DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RelativePanTiltTranslationSpace: + 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." + items: + $ref: '#/components/schemas/tt_Space2DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RelativeZoomTranslationSpace: + 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." + items: + $ref: '#/components/schemas/tt_Space1DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ZoomSpeedSpace: + 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\t\ + In contrast to the velocity spaces, speed spaces do not contain any directional\ + \ information." + items: + $ref: '#/components/schemas/tt_Space1DDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZSpaces + type: object + xml: + attribute: false + name: PTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZSpacesExtension: + description: '' + title: tt_PTZSpacesExtension + type: object + xml: + attribute: false + name: PTZSpacesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZSpeed: + description: '' + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - 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. + xml: + attribute: false + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) + Zoom movement should not be affected. + xml: + attribute: false + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZSpeed + type: object + xml: + attribute: false + name: PTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZStatus: + description: '' + properties: + Error: + description: States a current PTZ error. + type: string + xml: + attribute: false + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, + idle or in an unknown state. + xml: + attribute: false + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - 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. + xml: + attribute: false + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + UtcTime: + description: Specifies the UTC time when this status was generated. + format: date-time + type: string + xml: + attribute: false + name: UtcTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - UtcTime + title: tt_PTZStatus + type: object + xml: + attribute: false + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZStatusFilterOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PanTiltPositionSupported: + description: True if the device is able to stream the pan or tilt position. + type: boolean + xml: + attribute: false + name: PanTiltPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PanTiltStatusSupported: + description: True if the device is able to stream pan or tilt status information. + type: boolean + xml: + attribute: false + name: PanTiltStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ZoomPositionSupported: + description: True if the device is able to stream zoom position information. + type: boolean + xml: + attribute: false + name: ZoomPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ZoomStatusSupported: + description: True if the device is able to stream zoom status inforamtion. + type: boolean + xml: + attribute: false + name: ZoomStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PanTiltStatusSupported + - ZoomStatusSupported + title: tt_PTZStatusFilterOptions + type: object + xml: + attribute: false + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZStatusFilterOptionsExtension: + description: '' + title: tt_PTZStatusFilterOptionsExtension + type: object + xml: + attribute: false + name: PTZStatusFilterOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PTZVector: + description: '' + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan + and the y component to tilt. + xml: + attribute: false + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom position. + xml: + attribute: false + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PTZVector + type: object + xml: + attribute: false + name: PTZVector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PanTiltLimits: + description: '' + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: A range of pan tilt limits. + xml: + attribute: false + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Range + title: tt_PanTiltLimits + type: object + xml: + attribute: false + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PaneConfiguration: + description: Configuration of the streaming and coding settings of a Video window. + properties: + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: 'The configuration of the audio encoder including codec, + bitrate + + and sample rate.' + xml: + attribute: false + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AudioOutputToken: + description: 'If the device has audio outputs, this element contains a pointer + to the audio output that is associated with the pane. A client + + can retrieve the available audio outputs of a device using the GetAudioOutputs + command of the DeviceIO service.' + maxLength: 64 + type: string + xml: + attribute: false + name: AudioOutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AudioSourceToken: + description: 'If the device has audio sources, this element contains a pointer + to the audio source that is associated with this pane. + + The 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 + + DeviceIO service.' + maxLength: 64 + type: string + xml: + attribute: false + name: AudioSourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PaneName: + description: Optional name of the pane configuration. + type: string + xml: + attribute: false + name: PaneName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ReceiverToken: + 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." + maxLength: 64 + type: string + xml: + attribute: false + name: ReceiverToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Token: + description: A unique identifier in the display device. + maxLength: 64 + type: string + xml: + attribute: false + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Token + title: tt_PaneConfiguration + type: object + xml: + attribute: false + name: PaneConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PaneLayout: + description: A pane layout describes one Video window of a display. It links + a pane configuration to a region of the screen. + properties: + Area: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Describes the location and size of the area on the monitor. + The area coordinate values are espressed in normalized units [-1.0, + 1.0]. + xml: + attribute: false + name: Area + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Pane: + description: Reference to the configuration of the streaming and coding + parameters. + maxLength: 64 + type: string + xml: + attribute: false + name: Pane + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Pane + - Area + title: tt_PaneLayout + type: object + xml: + attribute: false + name: PaneLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PaneLayoutOptions: + description: Description of a pane layout describing a complete display layout. + properties: + Area: + description: List of areas assembling a layout. Coordinate values are in + the range [-1.0, 1.0]. + items: + $ref: '#/components/schemas/tt_Rectangle' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PaneOptionExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Area + title: tt_PaneLayoutOptions + type: object + xml: + attribute: false + name: PaneLayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PaneOptionExtension: + description: '' + title: tt_PaneOptionExtension + type: object + xml: + attribute: false + name: PaneOptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Polygon: + description: '' + properties: + Point: + description: '' + items: + $ref: '#/components/schemas/tt_Vector' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Point + title: tt_Polygon + type: object + xml: + attribute: false + name: Polygon + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PolygonOptions: + description: '' + properties: + RectangleOnly: + description: 'True if the device supports defining a region only using Rectangle. + + The rectangle points are still passed using a Polygon element if the device + does not support polygon regions. In this case, the points provided in + the Polygon element shall represent a rectangle.' + type: boolean + xml: + attribute: false + name: RectangleOnly + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VertexLimits: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: 'Provides the minimum and maximum number of points that can + be defined in the Polygon. + + If RectangleOnly is not set to true, this parameter is required.' + xml: + attribute: false + name: VertexLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_PolygonOptions + type: object + xml: + attribute: false + name: PolygonOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Polyline: + description: '' + properties: + Point: + description: '' + items: + $ref: '#/components/schemas/tt_Vector' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Point + title: tt_Polyline + type: object + xml: + attribute: false + name: Polyline + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PolylineArray: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_PolylineArrayExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Segment: + description: Contains array of Polyline + items: + $ref: '#/components/schemas/tt_Polyline' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Segment + title: tt_PolylineArray + type: object + xml: + attribute: false + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PolylineArrayConfiguration: + description: '' + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/tt_PolylineArray' + - description: Contains PolylineArray configuration data + xml: + attribute: false + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - PolylineArray + title: tt_PolylineArrayConfiguration + type: object + xml: + attribute: false + name: PolylineArrayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PolylineArrayExtension: + description: '' + title: tt_PolylineArrayExtension + type: object + xml: + attribute: false + name: PolylineArrayExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PrefixedIPv4Address: + description: '' + properties: + Address: + description: IPv4 address + type: string + xml: + attribute: false + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PrefixLength: + description: Prefix/submask length + format: int32 + type: integer + xml: + attribute: false + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Address + - PrefixLength + title: tt_PrefixedIPv4Address + type: object + xml: + attribute: false + name: PrefixedIPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PrefixedIPv6Address: + description: '' + properties: + Address: + description: IPv6 address + type: string + xml: + attribute: false + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PrefixLength: + description: Prefix/submask length + format: int32 + type: integer + xml: + attribute: false + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Address + - PrefixLength + title: tt_PrefixedIPv6Address + type: object + xml: + attribute: false + name: PrefixedIPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PresetTour: + description: '' + properties: + AutoStart: + description: Auto Start flag of the preset tour. True allows the preset + tour to be activated always. + type: boolean + xml: + attribute: false + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: Readable name of the preset tour. + maxLength: 64 + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + xml: + attribute: false + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Status: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset + tour. + xml: + attribute: false + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TourSpot: + description: A list of detail of touring spots including preset positions. + items: + $ref: '#/components/schemas/tt_PTZPresetTourSpot' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + token: + description: Unique identifier of this preset tour. + maxLength: 64 + type: string + xml: + attribute: true + name: token + prefix: tt + wrapped: false + required: + - Status + - AutoStart + - StartingCondition + title: tt_PresetTour + type: object + xml: + attribute: false + name: PresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_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." + properties: + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + xml: + attribute: false + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + attribute: false + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + attribute: false + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: User readable name of the profile. + maxLength: 64 + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + attribute: false + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and + rule engine. + xml: + attribute: false + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + xml: + attribute: false + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + attribute: false + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + fixed: + description: A value of true signals that the profile cannot be deleted. + Default is false. + type: boolean + xml: + attribute: true + name: fixed + prefix: tt + wrapped: false + token: + description: Unique identifier of the profile. + maxLength: 64 + type: string + xml: + attribute: true + name: token + prefix: tt + wrapped: false + required: + - token + - Name + title: tt_Profile + type: object + xml: + attribute: false + name: Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ProfileCapabilities: + description: '' + properties: + MaximumNumberOfProfiles: + description: Maximum number of profiles. + format: int32 + type: integer + xml: + attribute: false + name: MaximumNumberOfProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - MaximumNumberOfProfiles + title: tt_ProfileCapabilities + type: object + xml: + attribute: false + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ProfileExtension: + description: '' + properties: + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + attribute: false + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + attribute: false + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ProfileExtension + type: object + xml: + attribute: false + name: ProfileExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ProfileExtension2: + description: '' + title: tt_ProfileExtension2 + type: object + xml: + attribute: false + name: ProfileExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ProfileStatus: + description: '' + properties: + ActiveConnections: + description: '' + items: + $ref: '#/components/schemas/tt_ActiveConnection' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileStatusExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ProfileStatus + type: object + xml: + attribute: false + name: ProfileStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ProfileStatusExtension: + description: '' + title: tt_ProfileStatusExtension + type: object + xml: + attribute: false + name: ProfileStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_PropertyOperation: + description: '' + enum: + - Initialized + - Deleted + - Changed + title: tt_PropertyOperation + type: string + xml: + attribute: false + name: PropertyOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RealTimeStreamingCapabilities: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RTPMulticast: + description: Indicates whether or not RTP multicast is supported. + type: boolean + xml: + attribute: false + name: RTPMulticast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RTP_RTSP_TCP: + description: Indicates whether or not RTP/RTSP/TCP is supported. + type: boolean + xml: + attribute: false + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RTP_TCP: + description: Indicates whether or not RTP over TCP is supported. + type: boolean + xml: + attribute: false + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_RealTimeStreamingCapabilities + type: object + xml: + attribute: false + name: RealTimeStreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RealTimeStreamingCapabilitiesExtension: + description: '' + title: tt_RealTimeStreamingCapabilitiesExtension + type: object + xml: + attribute: false + name: RealTimeStreamingCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Receiver: + description: Description of a receiver, including its token and configuration. + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + xml: + attribute: false + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Token: + description: Unique identifier of the receiver. + maxLength: 64 + type: string + xml: + attribute: false + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Token + - Configuration + title: tt_Receiver + type: object + xml: + attribute: false + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReceiverCapabilities: + description: '' + properties: + MaximumRTSPURILength: + description: The maximum allowed length for RTSP URIs. + format: int32 + type: integer + xml: + attribute: false + name: MaximumRTSPURILength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RTP_Multicast: + description: Indicates whether the device can receive RTP multicast streams. + type: boolean + xml: + attribute: false + name: RTP_Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RTP_RTSP_TCP: + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + type: boolean + xml: + attribute: false + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RTP_TCP: + description: Indicates whether the device can receive RTP/TCP streams + type: boolean + xml: + attribute: false + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedReceivers: + description: The maximum number of receivers supported by the device. + format: int32 + type: integer + xml: + attribute: false + name: SupportedReceivers + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + description: The address of the receiver service. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + title: tt_ReceiverCapabilities + type: object + xml: + attribute: false + name: ReceiverCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReceiverConfiguration: + description: Describes the configuration of a receiver. + properties: + MediaUri: + description: Details of the URI to which the receiver should connect. + type: string + xml: + attribute: false + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReceiverMode' + - description: 'The following connection modes are defined:' + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream connection parameters. + xml: + attribute: false + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - MediaUri + - StreamSetup + title: tt_ReceiverConfiguration + type: object + xml: + attribute: false + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReceiverMode: + description: Specifies a receiver connection mode. + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + title: tt_ReceiverMode + type: string + xml: + attribute: false + name: ReceiverMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReceiverState: + description: Specifies the current connection state of the receiver. + enum: + - NotConnected + - Connecting + - Connected + - Unknown + title: tt_ReceiverState + type: string + xml: + attribute: false + name: ReceiverState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReceiverStateInformation: + description: Contains information about a receiver's current state. + properties: + AutoCreated: + description: Indicates whether or not the receiver was created automatically. + type: boolean + xml: + attribute: false + name: AutoCreated + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_ReceiverState' + - description: 'The connection state of the receiver may have one of the + following states:' + xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - State + - AutoCreated + title: tt_ReceiverStateInformation + type: object + xml: + attribute: false + name: ReceiverStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingCapabilities: + description: '' + properties: + DynamicRecordings: + type: boolean + xml: + attribute: false + name: DynamicRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DynamicTracks: + type: boolean + xml: + attribute: false + name: DynamicTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaxStringLength: + format: int32 + type: integer + xml: + attribute: false + name: MaxStringLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MediaProfileSource: + type: boolean + xml: + attribute: false + name: MediaProfileSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ReceiverSource: + type: boolean + xml: + attribute: false + name: ReceiverSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + title: tt_RecordingCapabilities + type: object + xml: + attribute: false + name: RecordingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingConfiguration: + description: '' + properties: + Content: + description: Informative description of the source. + type: string + xml: + attribute: false + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaximumRetentionTime: + description: "Sspecifies 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." + format: date-time + type: string + xml: + attribute: false + name: MaximumRetentionTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: Information about the source of the recording. + xml: + attribute: false + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Source + - Content + - MaximumRetentionTime + title: tt_RecordingConfiguration + type: object + xml: + attribute: false + name: RecordingConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingInformation: + description: '' + properties: + Content: + type: string + xml: + attribute: false + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + EarliestRecording: + format: date-time + type: string + xml: + attribute: false + name: EarliestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + LatestRecording: + format: date-time + type: string + xml: + attribute: false + name: LatestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingStatus: + allOf: + - $ref: '#/components/schemas/tt_RecordingStatus' + - xml: + attribute: false + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - 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." + xml: + attribute: false + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Track: + description: Basic information about the track. Note that a track may represent + a single contiguous time span or consist of multiple slices. + items: + $ref: '#/components/schemas/tt_TrackInformation' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - Source + - Content + - RecordingStatus + title: tt_RecordingInformation + type: object + xml: + attribute: false + name: RecordingInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobConfiguration: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + 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." + type: string + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Priority: + 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." + format: int32 + type: integer + xml: + attribute: false + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + description: Identifies the recording to which this job shall store the + received data. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Source: + description: Source of the recording. + items: + $ref: '#/components/schemas/tt_RecordingJobSource' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - Mode + - Priority + title: tt_RecordingJobConfiguration + type: object + xml: + attribute: false + name: RecordingJobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobConfigurationExtension: + description: '' + title: tt_RecordingJobConfigurationExtension + type: object + xml: + attribute: false + name: RecordingJobConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobSource: + description: '' + properties: + AutoCreateReceiver: + 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." + type: boolean + xml: + attribute: false + name: AutoCreateReceiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobSourceExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - 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, instructing the\n\t\t\t\tdevice\ + \ to obtain data from a profile that exists on the local device." + xml: + attribute: false + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Tracks: + description: List of tracks associated with the recording. + items: + $ref: '#/components/schemas/tt_RecordingJobTrack' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_RecordingJobSource + type: object + xml: + attribute: false + name: RecordingJobSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobSourceExtension: + description: '' + title: tt_RecordingJobSourceExtension + type: object + xml: + attribute: false + name: RecordingJobSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobStateInformation: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateInformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingToken: + description: Identification of the recording that the recording job records + to. + maxLength: 64 + type: string + xml: + attribute: false + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Sources: + description: Identifies the data source of the recording job. + items: + $ref: '#/components/schemas/tt_RecordingJobStateSource' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + description: Holds the aggregated state over the whole RecordingJobInformation + structure. + type: string + xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - RecordingToken + - State + title: tt_RecordingJobStateInformation + type: object + xml: + attribute: false + name: RecordingJobStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobStateInformationExtension: + description: '' + title: tt_RecordingJobStateInformationExtension + type: object + xml: + attribute: false + name: RecordingJobStateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobStateSource: + description: '' + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: Identifies the data source of the recording job. + xml: + attribute: false + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + type: string + xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateTracks' + - description: List of track items. + xml: + attribute: false + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SourceToken + - State + - Tracks + title: tt_RecordingJobStateSource + type: object + xml: + attribute: false + name: RecordingJobStateSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobStateTrack: + description: '' + properties: + Destination: + description: Indicates the destination track. + maxLength: 64 + type: string + xml: + attribute: false + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Error: + description: "Optionally holds an implementation defined string value that\ + \ describes the error.\n\t\t\t\tThe string should be in the English language." + type: string + xml: + attribute: false + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SourceTag: + description: Identifies the track of the data source that provides the data. + type: string + xml: + attribute: false + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + State: + description: "Provides the job state of the track. The valid\n\t\t\t\tvalues\ + \ of state shall be \u201CIdle\u201D, \u201CActive\u201D and \u201CError\u201D\ + . If state equals \u201CError\u201D, the Error field may be filled in\ + \ with an implementation defined value." + type: string + xml: + attribute: false + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SourceTag + - Destination + - State + title: tt_RecordingJobStateTrack + type: object + xml: + attribute: false + name: RecordingJobStateTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobStateTracks: + description: '' + properties: + Track: + description: '' + items: + $ref: '#/components/schemas/tt_RecordingJobStateTrack' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_RecordingJobStateTracks + type: object + xml: + attribute: false + name: RecordingJobStateTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingJobTrack: + description: '' + properties: + Destination: + description: "The destination is the tracktoken of the track to which the\ + \ device shall store the\n\t\t\t\treceived data." + maxLength: 64 + type: string + xml: + attribute: false + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SourceTag: + 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." + type: string + xml: + attribute: false + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SourceTag + - Destination + title: tt_RecordingJobTrack + type: object + xml: + attribute: false + name: RecordingJobTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingSourceInformation: + description: A set of informative desciptions of a data source. The Search searvice + allows a client to filter on recordings based on information in this structure. + properties: + Address: + description: URI provided by the service supplying data to be recorded. + A device shall support at least 128 characters. + type: string + xml: + attribute: false + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Description: + description: Informative description of the source. + type: string + xml: + attribute: false + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Location: + description: Informative description of the physical location of the source, + e.g. the coordinates on a map. + type: string + xml: + attribute: false + name: Location + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + description: Informative user readable name of the source, e.g. "Camera23". + A device shall support at least 20 characters. + maxLength: 64 + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SourceId: + 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." + type: string + xml: + attribute: false + name: SourceId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SourceId + - Name + - Location + - Description + - Address + title: tt_RecordingSourceInformation + type: object + xml: + attribute: false + name: RecordingSourceInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingStatus: + description: '' + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + title: tt_RecordingStatus + type: string + xml: + attribute: false + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RecordingSummary: + description: '' + properties: + DataFrom: + description: The earliest point in time where there is recorded data on + the device. + format: date-time + type: string + xml: + attribute: false + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DataUntil: + description: The most recent point in time where there is recorded data + on the device. + format: date-time + type: string + xml: + attribute: false + name: DataUntil + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + NumberRecordings: + description: The device contains this many recordings. + format: int32 + type: integer + xml: + attribute: false + name: NumberRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - DataFrom + - DataUntil + - NumberRecordings + title: tt_RecordingSummary + type: object + xml: + attribute: false + name: RecordingSummary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Rectangle: + description: '' + properties: + bottom: + type: number + xml: + attribute: true + name: bottom + prefix: tt + wrapped: false + left: + type: number + xml: + attribute: true + name: left + prefix: tt + wrapped: false + right: + type: number + xml: + attribute: true + name: right + prefix: tt + wrapped: false + top: + type: number + xml: + attribute: true + name: top + prefix: tt + wrapped: false + title: tt_Rectangle + type: object + xml: + attribute: false + name: Rectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelativeFocus: + description: '' + properties: + Distance: + description: Distance parameter for the relative focus control. + type: number + xml: + attribute: false + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + description: Speed parameter for the relative focus control. + type: number + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Distance + title: tt_RelativeFocus + type: object + xml: + attribute: false + name: RelativeFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelativeFocusOptions: + description: '' + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + attribute: false + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Distance + - Speed + title: tt_RelativeFocusOptions + type: object + xml: + attribute: false + name: RelativeFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelativeFocusOptions20: + description: '' + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + attribute: false + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + attribute: false + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Distance + title: tt_RelativeFocusOptions20 + type: object + xml: + attribute: false + name: RelativeFocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelayIdleState: + description: '' + enum: + - closed + - open + title: tt_RelayIdleState + type: string + xml: + attribute: false + name: RelayIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelayLogicalState: + description: '' + enum: + - active + - inactive + title: tt_RelayLogicalState + type: string + xml: + attribute: false + name: RelayLogicalState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelayMode: + description: '' + enum: + - Monostable + - Bistable + title: tt_RelayMode + type: string + xml: + attribute: false + name: RelayMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RelayOutput: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + attribute: false + name: Properties + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Properties + type: object + xml: + attribute: false + name: RelayOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_RelayOutput + tt_RelayOutputSettings: + description: '' + properties: + DelayTime: + 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. + format: date-time + type: string + xml: + attribute: false + name: DelayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IdleState: + allOf: + - $ref: '#/components/schemas/tt_RelayIdleState' + - description: '''open'' or ''closed''' + xml: + attribute: false + name: IdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_RelayMode' + - description: '''Bistable'' or ''Monostable''' + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - DelayTime + - IdleState + title: tt_RelayOutputSettings + type: object + xml: + attribute: false + name: RelayOutputSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RemoteUser: + description: '' + properties: + Password: + type: string + xml: + attribute: false + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + UseDerivedPassword: + type: boolean + xml: + attribute: false + name: UseDerivedPassword + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Username: + type: string + xml: + attribute: false + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Username + - UseDerivedPassword + title: tt_RemoteUser + type: object + xml: + attribute: false + name: RemoteUser + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReplayCapabilities: + description: '' + properties: + XAddr: + description: The address of the replay service. + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + title: tt_ReplayCapabilities + type: object + xml: + attribute: false + name: ReplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReplayConfiguration: + description: Configuration parameters for the replay service. + properties: + SessionTimeout: + description: The RTSP session timeout. + format: date-time + type: string + xml: + attribute: false + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - SessionTimeout + title: tt_ReplayConfiguration + type: object + xml: + attribute: false + name: ReplayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Reverse: + description: '' + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_Reverse + type: object + xml: + attribute: false + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReverseMode: + description: '' + enum: + - false + - true + - AUTO + - Extended + title: tt_ReverseMode + type: string + xml: + attribute: false + name: ReverseMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReverseOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Options of Reverse mode parameter. + items: + $ref: '#/components/schemas/tt_ReverseMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_ReverseOptions + type: object + xml: + attribute: false + name: ReverseOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ReverseOptionsExtension: + description: '' + title: tt_ReverseOptionsExtension + type: object + xml: + attribute: false + name: ReverseOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Rotate: + description: '' + properties: + Degree: + 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. + format: int32 + type: integer + xml: + attribute: false + name: Degree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_RotateMode' + - description: Parameter to enable/disable Rotation feature. + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_Rotate + type: object + xml: + attribute: false + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RotateExtension: + description: '' + title: tt_RotateExtension + type: object + xml: + attribute: false + name: RotateExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RotateMode: + description: '' + enum: + - false + - true + - AUTO + title: tt_RotateMode + type: string + xml: + attribute: false + name: RotateMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RotateOptions: + description: '' + properties: + DegreeList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported degree value for rotation. + xml: + attribute: false + name: DegreeList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Supported options of Rotate mode parameter. + items: + $ref: '#/components/schemas/tt_RotateMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Reboot: + description: "After setting the rotation, if a device starts to reboot this\ + \ value is true.\n\t\t\t\tIf a device can handle rotation setting without\ + \ rebooting this value is false." + type: boolean + xml: + attribute: true + name: Reboot + prefix: tt + wrapped: false + required: + - Mode + title: tt_RotateOptions + type: object + xml: + attribute: false + name: RotateOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RotateOptionsExtension: + description: '' + title: tt_RotateOptionsExtension + type: object + xml: + attribute: false + name: RotateOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RuleEngineConfiguration: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Rule: + description: '' + items: + $ref: '#/components/schemas/tt_Config' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_RuleEngineConfiguration + type: object + xml: + attribute: false + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_RuleEngineConfigurationExtension: + description: '' + title: tt_RuleEngineConfigurationExtension + type: object + xml: + attribute: false + name: RuleEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SceneOrientation: + description: '' + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene + orientation. + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Orientation: + 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." + type: string + xml: + attribute: false + name: Orientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_SceneOrientation + type: object + xml: + attribute: false + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SceneOrientationMode: + description: '' + enum: + - MANUAL + - AUTO + title: tt_SceneOrientationMode + type: string + xml: + attribute: false + name: SceneOrientationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SceneOrientationOption: + description: Defines the acceptable values for the Orientation element of the + SceneOrientation type + enum: + - Below + - Horizon + - Above + title: tt_SceneOrientationOption + type: string + xml: + attribute: false + name: SceneOrientationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Scope: + description: '' + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/tt_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + xml: + attribute: false + name: ScopeDef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ScopeItem: + description: Scope item URI. + type: string + xml: + attribute: false + name: ScopeItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - ScopeDef + - ScopeItem + title: tt_Scope + type: object + xml: + attribute: false + name: Scope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ScopeDefinition: + description: '' + enum: + - Fixed + - Configurable + title: tt_ScopeDefinition + type: string + xml: + attribute: false + name: ScopeDefinition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SearchCapabilities: + description: '' + properties: + MetadataSearch: + type: boolean + xml: + attribute: false + name: MetadataSearch + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XAddr: + type: string + xml: + attribute: false + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - XAddr + - MetadataSearch + title: tt_SearchCapabilities + type: object + xml: + attribute: false + name: SearchCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SearchScope: + description: A structure for defining a limited scope when searching in recorded + data. + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_SearchScopeExtension' + - description: Extension point + xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IncludedRecordings: + 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. + items: + maxLength: 64 + type: string + xml: + attribute: false + name: IncludedRecordings + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + IncludedSources: + 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. + items: + $ref: '#/components/schemas/tt_SourceReference' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RecordingInformationFilter: + 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. + type: string + xml: + attribute: false + name: RecordingInformationFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_SearchScope + type: object + xml: + attribute: false + name: SearchScope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SearchScopeExtension: + description: '' + title: tt_SearchScopeExtension + type: object + xml: + attribute: false + name: SearchScopeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SearchState: + description: '' + enum: + - Queued + - Searching + - Completed + - Unknown + title: tt_SearchState + type: string + xml: + attribute: false + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SecurityCapabilities: + description: '' + properties: + AccessPolicyConfig: + description: Indicates whether or not access policy configuration is supported. + type: boolean + xml: + attribute: false + name: AccessPolicyConfig + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + KerberosToken: + description: Indicates whether or not WS-Security Kerberos token is supported. + type: boolean + xml: + attribute: false + name: KerberosToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + OnboardKeyGeneration: + description: Indicates whether or not onboard key generation is supported. + type: boolean + xml: + attribute: false + name: OnboardKeyGeneration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RELToken: + description: Indicates whether or not WS-Security REL token is supported. + type: boolean + xml: + attribute: false + name: RELToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SAMLToken: + description: Indicates whether or not WS-Security SAML token is supported. + type: boolean + xml: + attribute: false + name: SAMLToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TLS1.1: + description: Indicates whether or not TLS 1.1 is supported. + type: boolean + xml: + attribute: false + name: TLS1.1 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TLS1.2: + description: Indicates whether or not TLS 1.2 is supported. + type: boolean + xml: + attribute: false + name: TLS1.2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + X.509Token: + description: Indicates whether or not WS-Security X.509 token is supported. + type: boolean + xml: + attribute: false + name: X.509Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + title: tt_SecurityCapabilities + type: object + xml: + attribute: false + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SecurityCapabilitiesExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TLS1.0: + type: boolean + xml: + attribute: false + name: TLS1.0 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TLS1.0 + title: tt_SecurityCapabilitiesExtension + type: object + xml: + attribute: false + name: SecurityCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SecurityCapabilitiesExtension2: + description: '' + properties: + Dot1X: + type: boolean + xml: + attribute: false + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RemoteUserHandling: + type: boolean + xml: + attribute: false + name: RemoteUserHandling + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedEAPMethod: + description: EAP Methods supported by the device. The int values refer to + the + items: + format: int32 + type: integer + xml: + attribute: false + name: SupportedEAPMethod + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Dot1X + - RemoteUserHandling + title: tt_SecurityCapabilitiesExtension2 + type: object + xml: + attribute: false + name: SecurityCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SetDateTimeType: + description: '' + enum: + - Manual + - NTP + title: tt_SetDateTimeType + type: string + xml: + attribute: false + name: SetDateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SimpleItem: + description: Value name pair as defined by the corresponding description. + properties: + Name: + description: Item name. + type: string + xml: + attribute: true + name: Name + prefix: tt + wrapped: false + Value: + description: Item value. The type is defined in the corresponding description. + type: string + xml: + attribute: true + name: Value + prefix: tt + wrapped: false + required: + - Name + - Value + title: tt_SimpleItem + type: object + xml: + attribute: false + name: SimpleItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SimpleItemDescription: + description: Description of a simple item. The type must be of cathegory simpleType + (xs:string, xs:integer, xs:float, ...). + properties: + Name: + description: Item name. Must be unique within a list. + type: string + xml: + attribute: true + name: Name + prefix: tt + wrapped: false + Type: + type: string + xml: + attribute: true + name: Type + prefix: tt + wrapped: false + required: + - Name + - Type + title: tt_SimpleItemDescription + type: object + xml: + attribute: false + name: SimpleItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SourceIdentification: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentificationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Name: + type: string + xml: + attribute: false + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Token: + description: '' + items: + maxLength: 64 + type: string + xml: + attribute: false + name: Token + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Name + - Token + title: tt_SourceIdentification + type: object + xml: + attribute: false + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SourceIdentificationExtension: + description: '' + title: tt_SourceIdentificationExtension + type: object + xml: + attribute: false + name: SourceIdentificationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SourceReference: + description: '' + properties: + Token: + maxLength: 64 + type: string + xml: + attribute: false + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Type: + default: http://www.onvif.org/ver10/schema/Receiver + type: string + xml: + attribute: true + name: Type + prefix: tt + wrapped: false + required: + - Token + title: tt_SourceReference + type: object + xml: + attribute: false + name: SourceReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Space1DDescription: + description: '' + properties: + URI: + description: A URI of coordinate systems. + type: string + xml: + attribute: false + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + attribute: false + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - URI + - XRange + title: tt_Space1DDescription + type: object + xml: + attribute: false + name: Space1DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Space2DDescription: + description: '' + properties: + URI: + description: A URI of coordinate systems. + type: string + xml: + attribute: false + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + attribute: false + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of y-axis. + xml: + attribute: false + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - URI + - XRange + - YRange + title: tt_Space2DDescription + type: object + xml: + attribute: false + name: Space2DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_StorageReferencePath: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_StorageReferencePathExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RelativePath: + description: gives the relative directory path on the storage + type: string + xml: + attribute: false + name: RelativePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + StorageToken: + description: identifier of an existing Storage Configuration. + maxLength: 64 + type: string + xml: + attribute: false + name: StorageToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - StorageToken + title: tt_StorageReferencePath + type: object + xml: + attribute: false + name: StorageReferencePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_StorageReferencePathExtension: + description: '' + title: tt_StorageReferencePathExtension + type: object + xml: + attribute: false + name: StorageReferencePathExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_StreamSetup: + description: '' + properties: + Stream: + allOf: + - $ref: '#/components/schemas/tt_StreamType' + - description: Defines if a multicast or unicast stream is requested + xml: + attribute: false + name: Stream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Transport: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - xml: + attribute: false + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Stream + - Transport + title: tt_StreamSetup + type: object + xml: + attribute: false + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_StreamType: + description: '' + enum: + - RTP-Unicast + - RTP-Multicast + title: tt_StreamType + type: string + xml: + attribute: false + name: StreamType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_StringItems: + description: '' + properties: + Item: + description: '' + items: + type: string + xml: + attribute: false + name: Item + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Item + title: tt_StringItems + type: object + xml: + attribute: false + name: StringItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SubscriptionPolicy: + description: '' + title: tt_SubscriptionPolicy + type: object + xml: + attribute: false + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SupportInformation: + description: '' + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The support information as attachment data. + xml: + attribute: false + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + String: + description: The support information as character data. + type: string + xml: + attribute: false + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_SupportInformation + type: object + xml: + attribute: false + name: SupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SupportedAnalyticsModules: + description: '' + properties: + AnalyticsModuleContentSchemaLocation: + 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." + items: + type: string + xml: + attribute: false + name: AnalyticsModuleContentSchemaLocation + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + AnalyticsModuleDescription: + description: '' + items: + $ref: '#/components/schemas/tt_ConfigDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModulesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Limit: + description: Maximum number of concurrent instances. + format: int32 + type: integer + xml: + attribute: true + name: Limit + prefix: tt + wrapped: false + title: tt_SupportedAnalyticsModules + type: object + xml: + attribute: false + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SupportedAnalyticsModulesExtension: + description: '' + title: tt_SupportedAnalyticsModulesExtension + type: object + xml: + attribute: false + name: SupportedAnalyticsModulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SupportedRules: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedRulesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Limit: + description: Maximum number of concurrent instances. + format: int32 + type: integer + xml: + attribute: true + name: Limit + prefix: tt + wrapped: false + RuleContentSchemaLocation: + description: Lists the location of all schemas that are referenced in the + rules. + items: + type: string + xml: + attribute: false + name: RuleContentSchemaLocation + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RuleDescription: + description: List of rules supported by the Video Analytics configuration.. + items: + $ref: '#/components/schemas/tt_ConfigDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_SupportedRules + type: object + xml: + attribute: false + name: SupportedRules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SupportedRulesExtension: + description: '' + title: tt_SupportedRulesExtension + type: object + xml: + attribute: false + name: SupportedRulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemCapabilities: + description: '' + properties: + DiscoveryBye: + description: Indicates whether or not WS-Discovery Bye is supported. + type: boolean + xml: + attribute: false + name: DiscoveryBye + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DiscoveryResolve: + description: Indicates whether or not WS Discovery resolve requests are + supported. + type: boolean + xml: + attribute: false + name: DiscoveryResolve + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FirmwareUpgrade: + description: Indicates whether or not firmware upgrade is supported. + type: boolean + xml: + attribute: false + name: FirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RemoteDiscovery: + description: Indicates whether or not remote discovery is supported. + type: boolean + xml: + attribute: false + name: RemoteDiscovery + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SupportedVersions: + description: Indicates supported ONVIF version(s). + items: + $ref: '#/components/schemas/tt_OnvifVersion' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SystemBackup: + description: Indicates whether or not system backup is supported. + type: boolean + xml: + attribute: false + name: SystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SystemLogging: + description: Indicates whether or not system logging is supported. + type: boolean + xml: + attribute: false + name: SystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + title: tt_SystemCapabilities + type: object + xml: + attribute: false + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemCapabilitiesExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + HttpFirmwareUpgrade: + type: boolean + xml: + attribute: false + name: HttpFirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + HttpSupportInformation: + type: boolean + xml: + attribute: false + name: HttpSupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + HttpSystemBackup: + type: boolean + xml: + attribute: false + name: HttpSystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + HttpSystemLogging: + type: boolean + xml: + attribute: false + name: HttpSystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_SystemCapabilitiesExtension + type: object + xml: + attribute: false + name: SystemCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemCapabilitiesExtension2: + description: '' + title: tt_SystemCapabilitiesExtension2 + type: object + xml: + attribute: false + name: SystemCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemDateTime: + description: General date time inforamtion returned by the GetSystemDateTime + method. + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + xml: + attribute: false + name: DateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DaylightSavings: + description: Informative indicator whether daylight savings is currently + on/off. + type: boolean + xml: + attribute: false + name: DaylightSavings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTimeExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + LocalDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in local format. + xml: + attribute: false + name: LocalDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: Timezone information in Posix format. + xml: + attribute: false + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Current system date and time in UTC format. This field is + mandatory since version 2.0. + xml: + attribute: false + name: UTCDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - DateTimeType + - DaylightSavings + title: tt_SystemDateTime + type: object + xml: + attribute: false + name: SystemDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemDateTimeExtension: + description: '' + title: tt_SystemDateTimeExtension + type: object + xml: + attribute: false + name: SystemDateTimeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemLog: + description: '' + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The log information as attachment data. + xml: + attribute: false + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + String: + description: The log information as character data. + type: string + xml: + attribute: false + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_SystemLog + type: object + xml: + attribute: false + name: SystemLog + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemLogType: + description: Enumeration describing the available system log modes. + enum: + - System + - Access + title: tt_SystemLogType + type: string + xml: + attribute: false + name: SystemLogType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemLogUri: + description: '' + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - xml: + attribute: false + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Uri: + type: string + xml: + attribute: false + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Type + - Uri + title: tt_SystemLogUri + type: object + xml: + attribute: false + name: SystemLogUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_SystemLogUriList: + description: '' + properties: + SystemLog: + description: '' + items: + $ref: '#/components/schemas/tt_SystemLogUri' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_SystemLogUriList + type: object + xml: + attribute: false + name: SystemLogUriList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TLSConfiguration: + description: '' + properties: + CertificateID: + type: string + xml: + attribute: false + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - CertificateID + title: tt_TLSConfiguration + type: object + xml: + attribute: false + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Time: + description: '' + properties: + Hour: + description: Range is 0 to 23. + format: int32 + type: integer + xml: + attribute: false + name: Hour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Minute: + description: Range is 0 to 59. + format: int32 + type: integer + xml: + attribute: false + name: Minute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Second: + description: Range is 0 to 61 (typically 59). + format: int32 + type: integer + xml: + attribute: false + name: Second + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Hour + - Minute + - Second + title: tt_Time + type: object + xml: + attribute: false + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TimeZone: + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 + section 8.3 + properties: + TZ: + description: Posix timezone string. + type: string + xml: + attribute: false + name: TZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TZ + title: tt_TimeZone + type: object + xml: + attribute: false + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ToneCompensation: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Level: + description: Optional level parameter specified with unitless normalized + value from 0.0 to +1.0. + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Parameter to enable/disable or automatic ToneCompensation feature. + Its options shall be chosen from tt:ToneCompensationMode Type. + type: string + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_ToneCompensation + type: object + xml: + attribute: false + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ToneCompensationExtension: + description: '' + title: tt_ToneCompensationExtension + type: object + xml: + attribute: false + name: ToneCompensationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ToneCompensationMode: + description: '' + enum: + - false + - true + - AUTO + title: tt_ToneCompensationMode + type: string + xml: + attribute: false + name: ToneCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ToneCompensationOptions: + description: '' + properties: + Level: + description: Indicates whether or not support Level parameter for Tone Compensation. + type: boolean + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Supported options for Tone Compensation mode. Its options shall + be chosen from tt:ToneCompensationMode Type. + items: + type: string + xml: + attribute: false + name: Mode + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Level + title: tt_ToneCompensationOptions + type: object + xml: + attribute: false + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TrackAttributes: + description: '' + properties: + AudioAttributes: + allOf: + - $ref: '#/components/schemas/tt_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure + shall be present and contain the audio attributes. + xml: + attribute: false + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TrackAttributesExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/tt_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure + shall be present and contain the metadata attributes. + xml: + attribute: false + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackInformation: + allOf: + - $ref: '#/components/schemas/tt_TrackInformation' + - description: The basic information about the track. Note that a track + may represent a single contiguous time span or consist of multiple slices. + xml: + attribute: false + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + VideoAttributes: + allOf: + - $ref: '#/components/schemas/tt_VideoAttributes' + - description: If the track is a video track, exactly one of this structure + shall be present and contain the video attributes. + xml: + attribute: false + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TrackInformation + title: tt_TrackAttributes + type: object + xml: + attribute: false + name: TrackAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TrackAttributesExtension: + description: '' + title: tt_TrackAttributesExtension + type: object + xml: + attribute: false + name: TrackAttributesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TrackConfiguration: + description: '' + properties: + Description: + description: Informative description of the track. + type: string + xml: + attribute: false + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: "Type of the track. It shall be equal to the strings \u201C\ + Video\u201D,\n\t\t\t\t\u201CAudio\u201D or \u201CMetadata\u201D. The\ + \ track shall only be able to hold data of that type." + xml: + attribute: false + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TrackType + - Description + title: tt_TrackConfiguration + type: object + xml: + attribute: false + name: TrackConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TrackInformation: + description: '' + properties: + DataFrom: + description: The start date and time of the oldest recorded data in the + track. + format: date-time + type: string + xml: + attribute: false + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + DataTo: + description: The stop date and time of the newest recorded data in the track. + format: date-time + type: string + xml: + attribute: false + name: DataTo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Description: + description: Informative description of the contents of the track. + type: string + xml: + attribute: false + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackToken: + maxLength: 64 + type: string + xml: + attribute: false + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - 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." + xml: + attribute: false + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + title: tt_TrackInformation + type: object + xml: + attribute: false + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TrackType: + description: '' + enum: + - Video + - Audio + - Metadata + - Extended + title: tt_TrackType + type: string + xml: + attribute: false + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Transformation: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_TransformationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Scale: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + attribute: false + name: Scale + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Translate: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + attribute: false + name: Translate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_Transformation + type: object + xml: + attribute: false + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TransformationExtension: + description: '' + title: tt_TransformationExtension + type: object + xml: + attribute: false + name: TransformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Transport: + description: '' + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/tt_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, + RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + xml: + attribute: false + name: Protocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Tunnel: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - description: Optional element to describe further tunnel options. This + element is normally not needed + xml: + attribute: false + name: Tunnel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Protocol + title: tt_Transport + type: object + xml: + attribute: false + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_TransportProtocol: + description: '' + enum: + - UDP + - TCP + - RTSP + - HTTP + title: tt_TransportProtocol + type: string + xml: + attribute: false + name: TransportProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_User: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_UserExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Password: + description: Password string. + type: string + xml: + attribute: false + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + UserLevel: + allOf: + - $ref: '#/components/schemas/tt_UserLevel' + - description: User level string. + xml: + attribute: false + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Username: + description: Username string. + type: string + xml: + attribute: false + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Username + - UserLevel + title: tt_User + type: object + xml: + attribute: false + name: User + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_UserExtension: + description: '' + title: tt_UserExtension + type: object + xml: + attribute: false + name: UserExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_UserLevel: + description: '' + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + title: tt_UserLevel + type: string + xml: + attribute: false + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Vector: + description: '' + properties: + x: + type: number + xml: + attribute: true + name: x + prefix: tt + wrapped: false + y: + type: number + xml: + attribute: true + name: y + prefix: tt + wrapped: false + title: tt_Vector + type: object + xml: + attribute: false + name: Vector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Vector1D: + description: '' + properties: + space: + description: 'Zoom coordinate space selector. The following options are + defined:' + type: string + xml: + attribute: true + name: space + prefix: tt + wrapped: false + x: + type: number + xml: + attribute: true + name: x + prefix: tt + wrapped: false + required: + - x + title: tt_Vector1D + type: object + xml: + attribute: false + name: Vector1D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_Vector2D: + description: '' + properties: + space: + description: 'Pan/tilt coordinate space selector. The following options + are defined:' + type: string + xml: + attribute: true + name: space + prefix: tt + wrapped: false + x: + type: number + xml: + attribute: true + name: x + prefix: tt + wrapped: false + y: + type: number + xml: + attribute: true + name: y + prefix: tt + wrapped: false + required: + - x + - y + title: tt_Vector2D + type: object + xml: + attribute: false + name: Vector2D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - xml: + attribute: false + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RuleEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfiguration' + - xml: + attribute: false + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + xml: + attribute: false + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_VideoAnalyticsConfiguration + tt_VideoAttributes: + description: '' + properties: + Bitrate: + description: Average bitrate in kbps. + format: int32 + type: integer + xml: + attribute: false + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Encoding: + description: Video encoding of the track. Use value from tt:VideoEncoding + for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + type: string + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Framerate: + description: Average framerate in frames per second. + type: number + xml: + attribute: false + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Height: + description: The height of the video in pixels. + format: int32 + type: integer + xml: + attribute: false + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Width: + description: The width of the video in pixels. + format: int32 + type: integer + xml: + attribute: false + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Width + - Height + - Encoding + - Framerate + title: tt_VideoAttributes + type: object + xml: + attribute: false + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoDecoderConfigurationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + H264DecOptions: + allOf: + - $ref: '#/components/schemas/tt_H264DecOptions' + - description: If the device is able to decode H.264 streams this element + describes the supported codecs and configurations + xml: + attribute: false + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/tt_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element + describes the supported codecs and configurations + xml: + attribute: false + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element + describes the supported codecs and configurations + xml: + attribute: false + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoDecoderConfigurationOptions + type: object + xml: + attribute: false + name: VideoDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoDecoderConfigurationOptionsExtension: + description: '' + title: tt_VideoDecoderConfigurationOptionsExtension + type: object + xml: + attribute: false + name: VideoDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncoder2Configuration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + Encoding: + description: Video Media Subtype for the video format. For definitions + see tt:VideoEncodingMimeNames and + type: string + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GovLength: + 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. + format: int32 + type: integer + xml: + attribute: true + name: GovLength + prefix: tt + wrapped: false + GuaranteedFrameRate: + 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." + type: boolean + xml: + attribute: true + name: GuaranteedFrameRate + prefix: tt + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + xml: + attribute: false + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Profile: + description: The encoder profile as defined in tt:VideoEncodingProfiles. + type: string + xml: + attribute: true + name: Profile + prefix: tt + wrapped: false + Quality: + description: Relative value for the video quantizers and the quality of + the video. A high value within supported quality range means higher + quality + type: number + xml: + attribute: false + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + xml: + attribute: false + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution2' + - description: Configured video resolution + xml: + attribute: false + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - Resolution + - Quality + type: object + xml: + attribute: false + name: VideoEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_VideoEncoder2Configuration + tt_VideoEncoder2ConfigurationOptions: + description: '' + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + attribute: false + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ConstantBitRateSupported: + description: Signal whether enforcing constant bitrate is supported. + type: boolean + xml: + attribute: true + name: ConstantBitRateSupported + prefix: tt + wrapped: false + Encoding: + description: Video Media Subtype for the video format. For definitions see + tt:VideoEncodingMimeNames and + type: string + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FrameRatesSupported: + description: List of supported target frame rates in fps (frames per second). + The list shall be sorted with highest values first. + type: number + xml: + attribute: true + name: FrameRatesSupported + prefix: tt + wrapped: false + GovLengthRange: + 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. + format: int32 + type: integer + xml: + attribute: true + name: GovLengthRange + prefix: tt + wrapped: false + GuaranteedFrameRateSupported: + description: Indicates the support for the GuaranteedFrameRate attribute + on the VideoEncoder2Configuration element. + type: boolean + xml: + attribute: true + name: GuaranteedFrameRateSupported + prefix: tt + wrapped: false + ProfilesSupported: + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + type: string + xml: + attribute: true + name: ProfilesSupported + prefix: tt + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Range of the quality values. A high value means higher quality. + xml: + attribute: false + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/tt_VideoResolution2' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + title: tt_VideoEncoder2ConfigurationOptions + type: object + xml: + attribute: false + name: VideoEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + xml: + attribute: false + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GuaranteedFrameRate: + 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." + type: boolean + xml: + attribute: true + name: GuaranteedFrameRate + prefix: tt + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Configuration' + - description: Optional element to configure H.264 related parameters. + xml: + attribute: false + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + xml: + attribute: false + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + xml: + attribute: false + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Quality: + description: Relative value for the video quantizers and the quality of + the video. A high value within supported quality range means higher + quality + type: number + xml: + attribute: false + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl' + - description: Optional element to configure rate control related parameters. + xml: + attribute: false + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Configured video resolution + xml: + attribute: false + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SessionTimeout: + description: The rtsp session timeout for the related video stream + format: date-time + type: string + xml: + attribute: false + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + xml: + attribute: false + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_VideoEncoderConfiguration + tt_VideoEncoderConfigurationOptions: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + GuaranteedFrameRateSupported: + description: Indicates the support for the GuaranteedFrameRate attribute + on the VideoEncoderConfiguration element. + type: boolean + xml: + attribute: true + name: GuaranteedFrameRateSupported + prefix: tt + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension + element). + xml: + attribute: false + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension + element). + xml: + attribute: false + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension + element). + xml: + attribute: false + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the quality values. A high value means higher quality. + xml: + attribute: false + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - QualityRange + title: tt_VideoEncoderConfigurationOptions + type: object + xml: + attribute: false + name: VideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncoderOptionsExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options2' + - description: Optional H.264 encoder settings ranges. + xml: + attribute: false + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + xml: + attribute: false + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + xml: + attribute: false + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoEncoderOptionsExtension + type: object + xml: + attribute: false + name: VideoEncoderOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncoderOptionsExtension2: + description: '' + title: tt_VideoEncoderOptionsExtension2 + type: object + xml: + attribute: false + name: VideoEncoderOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncoding: + description: '' + enum: + - JPEG + - MPEG4 + - H264 + title: tt_VideoEncoding + type: string + xml: + attribute: false + name: VideoEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncodingMimeNames: + description: Video Media Subtypes as referenced by IANA (without the leading + "video/" Video Media Type). See also + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + title: tt_VideoEncodingMimeNames + type: string + xml: + attribute: false + name: VideoEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoEncodingProfiles: + description: '' + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + title: tt_VideoEncodingProfiles + type: string + xml: + attribute: false + name: VideoEncodingProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoOutput: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + AspectRatio: + description: Aspect ratio of the display as physical extent of width divided + by height. + type: number + xml: + attribute: false + name: AspectRatio + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoOutputExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Layout: + allOf: + - $ref: '#/components/schemas/tt_Layout' + - xml: + attribute: false + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + RefreshRate: + description: Refresh rate of the display in Hertz. + type: number + xml: + attribute: false + name: RefreshRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Resolution of the display in Pixel. + xml: + attribute: false + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Layout + type: object + xml: + attribute: false + name: VideoOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: Representation of a physical video outputs. + title: tt_VideoOutput + tt_VideoOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + OutputToken: + description: Token of the Video Output the configuration applies to + maxLength: 64 + type: string + xml: + attribute: false + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - OutputToken + type: object + xml: + attribute: false + name: VideoOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_VideoOutputConfiguration + tt_VideoOutputConfigurationOptions: + description: '' + title: tt_VideoOutputConfigurationOptions + type: object + xml: + attribute: false + name: VideoOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoOutputExtension: + description: '' + title: tt_VideoOutputExtension + type: object + xml: + attribute: false + name: VideoOutputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoRateControl: + description: '' + properties: + BitrateLimit: + description: the maximum output bitrate in kbps + format: int32 + type: integer + xml: + attribute: false + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + EncodingInterval: + 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 ...) + format: int32 + type: integer + xml: + attribute: false + name: EncodingInterval + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + FrameRateLimit: + description: Maximum output framerate in fps. If an EncodingInterval is + provided the resulting encoded framerate will be reduced by the given + factor. + format: int32 + type: integer + xml: + attribute: false + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + title: tt_VideoRateControl + type: object + xml: + attribute: false + name: VideoRateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoRateControl2: + description: '' + properties: + BitrateLimit: + description: the maximum output bitrate in kbps + format: int32 + type: integer + xml: + attribute: false + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ConstantBitRate: + description: Enforce constant bitrate. + type: boolean + xml: + attribute: true + name: ConstantBitRate + prefix: tt + wrapped: false + FrameRateLimit: + description: Desired frame rate in fps. The actual rate may be lower due + to e.g. performance limitations. + type: number + xml: + attribute: false + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - FrameRateLimit + - BitrateLimit + title: tt_VideoRateControl2 + type: object + xml: + attribute: false + name: VideoRateControl2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoResolution: + description: '' + properties: + Height: + description: Number of the lines of the Video image. + format: int32 + type: integer + xml: + attribute: false + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Width: + description: Number of the columns of the Video image. + format: int32 + type: integer + xml: + attribute: false + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Width + - Height + title: tt_VideoResolution + type: object + xml: + attribute: false + name: VideoResolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoResolution2: + description: '' + properties: + Height: + description: Number of the lines of the Video image. + format: int32 + type: integer + xml: + attribute: false + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Width: + description: Number of the columns of the Video image. + format: int32 + type: integer + xml: + attribute: false + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Width + - Height + title: tt_VideoResolution2 + type: object + xml: + attribute: false + name: VideoResolution2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSource: + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Framerate: + description: Frame rate in frames per second. + type: number + xml: + attribute: false + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings' + - description: Optional configuration of the image sensor. + xml: + attribute: false + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Horizontal and vertical resolution + xml: + attribute: false + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Framerate + - Resolution + type: object + xml: + attribute: false + name: VideoSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: Representation of a physical video input. + title: tt_VideoSource + tt_VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - properties: + Bounds: + allOf: + - $ref: '#/components/schemas/tt_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing + area shall not be larger than the whole Video source area. + xml: + attribute: false + name: Bounds + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SourceToken: + description: Reference to the physical input. + maxLength: 64 + type: string + xml: + attribute: false + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + ViewMode: + description: Readonly parameter signalling Source configuration's view + mode, for devices supporting different view modes as defined in tt:viewModes. + type: string + xml: + attribute: true + name: ViewMode + prefix: tt + wrapped: false + required: + - SourceToken + - Bounds + type: object + xml: + attribute: false + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + description: '' + title: tt_VideoSourceConfiguration + tt_VideoSourceConfigurationExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Rotate: + allOf: + - $ref: '#/components/schemas/tt_Rotate' + - 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." + xml: + attribute: false + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoSourceConfigurationExtension + type: object + xml: + attribute: false + name: VideoSourceConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSourceConfigurationExtension2: + description: '' + properties: + LensDescription: + description: Optional element describing the geometric lens distortion. + Multiple instances for future variable lens support. + items: + $ref: '#/components/schemas/tt_LensDescription' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + SceneOrientation: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientation' + - description: "Optional element describing the scene orientation in the\ + \ camera\u2019s field of view." + xml: + attribute: false + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoSourceConfigurationExtension2 + type: object + xml: + attribute: false + name: VideoSourceConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSourceConfigurationOptions: + description: '' + properties: + BoundsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRectangleRange' + - 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." + xml: + attribute: false + name: BoundsRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + MaximumNumberOfProfiles: + description: Maximum number of profiles. + format: int32 + type: integer + xml: + attribute: true + name: MaximumNumberOfProfiles + prefix: tt + wrapped: false + VideoSourceTokensAvailable: + description: List of physical inputs. + items: + maxLength: 64 + type: string + xml: + attribute: false + name: VideoSourceTokensAvailable + wrapped: false + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - BoundsRange + - VideoSourceTokensAvailable + title: tt_VideoSourceConfigurationOptions + type: object + xml: + attribute: false + name: VideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSourceConfigurationOptionsExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Rotate: + allOf: + - $ref: '#/components/schemas/tt_RotateOptions' + - description: Options of parameters for Rotation feature. + xml: + attribute: false + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoSourceConfigurationOptionsExtension + type: object + xml: + attribute: false + name: VideoSourceConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSourceConfigurationOptionsExtension2: + description: '' + properties: + SceneOrientationMode: + description: Scene orientation modes supported by the device for this configuration. + items: + $ref: '#/components/schemas/tt_SceneOrientationMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoSourceConfigurationOptionsExtension2 + type: object + xml: + attribute: false + name: VideoSourceConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSourceExtension: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension2' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if + imaging service 2.00 is supported. + xml: + attribute: false + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + title: tt_VideoSourceExtension + type: object + xml: + attribute: false + name: VideoSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_VideoSourceExtension2: + description: '' + title: tt_VideoSourceExtension2 + type: object + xml: + attribute: false + name: VideoSourceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ViewModes: + description: Source view modes supported by device. + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + title: tt_ViewModes + type: string + xml: + attribute: false + name: ViewModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalance: + description: '' + properties: + CbGain: + description: Bgain (unitless). + type: number + xml: + attribute: false + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CrGain: + description: Rgain (unitless). + type: number + xml: + attribute: false + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - CrGain + - CbGain + title: tt_WhiteBalance + type: object + xml: + attribute: false + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalance20: + description: '' + properties: + CbGain: + description: Bgain (unitless). + type: number + xml: + attribute: false + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + CrGain: + description: Rgain (unitless). + type: number + xml: + attribute: false + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: '''AUTO'' or ''MANUAL''' + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_WhiteBalance20 + type: object + xml: + attribute: false + name: WhiteBalance20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalance20Extension: + description: '' + title: tt_WhiteBalance20Extension + type: object + xml: + attribute: false + name: WhiteBalance20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalanceMode: + description: '' + enum: + - AUTO + - MANUAL + title: tt_WhiteBalanceMode + type: string + xml: + attribute: false + name: WhiteBalanceMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalanceOptions: + description: '' + properties: + Mode: + description: '' + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - YrGain + - YbGain + title: tt_WhiteBalanceOptions + type: object + xml: + attribute: false + name: WhiteBalanceOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalanceOptions20: + description: '' + properties: + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20Extension' + - xml: + attribute: false + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: Mode of WhiteBalance. + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_WhiteBalanceOptions20 + type: object + xml: + attribute: false + name: WhiteBalanceOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WhiteBalanceOptions20Extension: + description: '' + title: tt_WhiteBalanceOptions20Extension + type: object + xml: + attribute: false + name: WhiteBalanceOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WideDynamicMode: + description: '' + enum: + - false + - true + title: tt_WideDynamicMode + type: string + xml: + attribute: false + name: WideDynamicMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WideDynamicRange: + description: '' + properties: + Level: + description: Optional level parameter (unitless) + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: White dynamic range (on/off) + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Level + title: tt_WideDynamicRange + type: object + xml: + attribute: false + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WideDynamicRange20: + description: Type describing whether WDR mode is enabled or disabled (on/off). + properties: + Level: + description: Optional level parameter (unit unspecified). + type: number + xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + xml: + attribute: false + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_WideDynamicRange20 + type: object + xml: + attribute: false + name: WideDynamicRange20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WideDynamicRangeOptions: + description: '' + properties: + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: '' + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + - Level + title: tt_WideDynamicRangeOptions + type: object + xml: + attribute: false + name: WideDynamicRangeOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_WideDynamicRangeOptions20: + description: '' + properties: + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + attribute: false + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + Mode: + description: '' + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + type: array + xml: + attribute: false + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Mode + title: tt_WideDynamicRangeOptions20 + type: object + xml: + attribute: false + name: WideDynamicRangeOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + tt_ZoomLimits: + description: '' + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: A range of zoom limit + xml: + attribute: false + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + required: + - Range + title: tt_ZoomLimits + type: object + xml: + attribute: false + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + wrapped: false + wsa_AttributedAnyType: + description: '' + title: wsa_AttributedAnyType + type: object + xml: + attribute: false + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_AttributedQNameType: + description: '' + title: wsa_AttributedQNameType + type: object + xml: + attribute: false + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_AttributedURIType: + description: '' + title: wsa_AttributedURIType + type: object + xml: + attribute: false + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_EndpointReferenceType: + description: '' + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + attribute: false + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + attribute: false + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + attribute: false + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + required: + - Address + title: wsa_EndpointReferenceType + type: object + xml: + attribute: false + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_FaultCodesOpenEnumType: + description: '' + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + title: wsa_FaultCodesOpenEnumType + type: string + xml: + attribute: false + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object + wsa_MetadataType: + description: '' + title: wsa_MetadataType + type: object + xml: + attribute: false + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_ProblemActionType: + description: '' + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + attribute: false + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + SoapAction: + type: string + xml: + attribute: false + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + title: wsa_ProblemActionType + type: object + xml: + attribute: false + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_ReferenceParametersType: + description: '' + title: wsa_ReferenceParametersType + type: object + xml: + attribute: false + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_RelatesToType: + description: '' + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + attribute: true + name: RelationshipType + wrapped: false + title: wsa_RelatesToType + type: object + xml: + attribute: false + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_RelationshipTypeOpenEnum: + description: '' + enum: + - http://www.w3.org/2005/08/addressing/reply + title: wsa_RelationshipTypeOpenEnum + type: string + xml: + attribute: false + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + wrapped: false + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsnt_CreatePullPoint: + description: '' + title: wsnt_CreatePullPoint + type: object + xml: + attribute: false + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_CreatePullPointResponse: + description: '' + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - PullPoint + title: wsnt_CreatePullPointResponse + type: object + xml: + attribute: false + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_DestroyPullPoint: + description: '' + title: wsnt_DestroyPullPoint + type: object + xml: + attribute: false + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_DestroyPullPointResponse: + description: '' + title: wsnt_DestroyPullPointResponse + type: object + xml: + attribute: false + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_FilterType: + description: '' + title: wsnt_FilterType + type: object + xml: + attribute: false + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_GetCurrentMessage: + description: '' + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + attribute: false + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - Topic + title: wsnt_GetCurrentMessage + type: object + xml: + attribute: false + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_GetCurrentMessageResponse: + description: '' + title: wsnt_GetCurrentMessageResponse + type: object + xml: + attribute: false + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_GetMessages: + description: '' + properties: + MaximumNumber: + format: int32 + type: integer + xml: + attribute: false + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + title: wsnt_GetMessages + type: object + xml: + attribute: false + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_GetMessagesResponse: + description: '' + properties: + NotificationMessage: + description: '' + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + title: wsnt_GetMessagesResponse + type: object + xml: + attribute: false + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_InvalidFilterFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + UnknownFilter: + description: '' + items: + type: string + xml: + attribute: false + name: UnknownFilter + wrapped: false + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - UnknownFilter + type: object + xml: + attribute: false + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_InvalidFilterFaultType + wsnt_InvalidMessageContentExpressionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_InvalidMessageContentExpressionFaultType + wsnt_InvalidProducerPropertiesExpressionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_InvalidProducerPropertiesExpressionFaultType + wsnt_InvalidTopicExpressionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_InvalidTopicExpressionFaultType + wsnt_Message: + description: '' + title: wsnt_Message + type: object + xml: + attribute: false + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_MultipleTopicsSpecifiedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_MultipleTopicsSpecifiedFaultType + wsnt_NoCurrentMessageOnTopicFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_NoCurrentMessageOnTopicFaultType + wsnt_NotificationMessageHolderType: + description: '' + properties: + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + attribute: false + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + attribute: false + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - Message + title: wsnt_NotificationMessageHolderType + type: object + xml: + attribute: false + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_NotificationProducerRP: + description: '' + properties: + FixedTopicSet: + default: true + type: boolean + xml: + attribute: false + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + TopicExpression: + description: '' + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + TopicExpressionDialect: + description: '' + items: + type: string + xml: + attribute: false + name: TopicExpressionDialect + wrapped: false + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + attribute: false + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + title: wsnt_NotificationProducerRP + type: object + xml: + attribute: false + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_Notify: + description: '' + properties: + NotificationMessage: + description: '' + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - NotificationMessage + title: wsnt_Notify + type: object + xml: + attribute: false + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_NotifyMessageNotSupportedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_NotifyMessageNotSupportedFaultType + wsnt_PauseFailedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_PauseFailedFaultType + wsnt_PauseSubscription: + description: '' + title: wsnt_PauseSubscription + type: object + xml: + attribute: false + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_PauseSubscriptionResponse: + description: '' + title: wsnt_PauseSubscriptionResponse + type: object + xml: + attribute: false + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_QueryExpressionType: + description: '' + properties: + Dialect: + type: string + xml: + attribute: true + name: Dialect + wrapped: false + required: + - Dialect + title: wsnt_QueryExpressionType + type: object + xml: + attribute: false + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_Renew: + description: '' + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + attribute: false + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - TerminationTime + title: wsnt_Renew + type: object + xml: + attribute: false + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_RenewResponse: + description: '' + properties: + CurrentTime: + format: date-time + type: string + xml: + attribute: false + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + TerminationTime: + format: date-time + type: string + xml: + attribute: false + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - TerminationTime + title: wsnt_RenewResponse + type: object + xml: + attribute: false + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_ResumeFailedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_ResumeFailedFaultType + wsnt_ResumeSubscription: + description: '' + title: wsnt_ResumeSubscription + type: object + xml: + attribute: false + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_ResumeSubscriptionResponse: + description: '' + title: wsnt_ResumeSubscriptionResponse + type: object + xml: + attribute: false + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_Subscribe: + description: '' + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + attribute: false + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + attribute: false + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + attribute: false + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - ConsumerReference + title: wsnt_Subscribe + type: object + xml: + attribute: false + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_SubscribeCreationFailedFaultType + wsnt_SubscribeResponse: + description: '' + properties: + CurrentTime: + format: date-time + type: string + xml: + attribute: false + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + TerminationTime: + format: date-time + type: string + xml: + attribute: false + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - SubscriptionReference + title: wsnt_SubscribeResponse + type: object + xml: + attribute: false + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_SubscriptionManagerRP: + description: '' + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + CreationTime: + format: date-time + type: string + xml: + attribute: false + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + attribute: false + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + attribute: false + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - ConsumerReference + title: wsnt_SubscriptionManagerRP + type: object + xml: + attribute: false + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_SubscriptionPolicy: + description: '' + title: wsnt_SubscriptionPolicy + type: object + xml: + attribute: false + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_SubscriptionPolicyType: + description: '' + title: wsnt_SubscriptionPolicyType + type: object + xml: + attribute: false + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_TopicExpressionDialectUnknownFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_TopicExpressionDialectUnknownFaultType + wsnt_TopicExpressionType: + description: '' + properties: + Dialect: + type: string + xml: + attribute: true + name: Dialect + wrapped: false + required: + - Dialect + title: wsnt_TopicExpressionType + type: object + xml: + attribute: false + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_TopicNotSupportedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_TopicNotSupportedFaultType + wsnt_UnableToCreatePullPointFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnableToCreatePullPointFaultType + wsnt_UnableToDestroyPullPointFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnableToDestroyPullPointFaultType + wsnt_UnableToDestroySubscriptionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnableToDestroySubscriptionFaultType + wsnt_UnableToGetMessagesFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + attribute: false + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnableToGetMessagesFaultType + wsnt_UnacceptableInitialTerminationTimeFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + MaximumTime: + format: date-time + type: string + xml: + attribute: false + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + MinimumTime: + format: date-time + type: string + xml: + attribute: false + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - MinimumTime + type: object + xml: + attribute: false + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnacceptableInitialTerminationTimeFaultType + wsnt_UnacceptableTerminationTimeFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + MaximumTime: + format: date-time + type: string + xml: + attribute: false + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + MinimumTime: + format: date-time + type: string + xml: + attribute: false + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + required: + - MinimumTime + type: object + xml: + attribute: false + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnacceptableTerminationTimeFaultType + wsnt_UnrecognizedPolicyRequestFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + UnrecognizedPolicy: + description: '' + items: + type: string + xml: + attribute: false + name: UnrecognizedPolicy + wrapped: false + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + type: object + xml: + attribute: false + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnrecognizedPolicyRequestFaultType + wsnt_Unsubscribe: + description: '' + title: wsnt_Unsubscribe + type: object + xml: + attribute: false + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_UnsubscribeResponse: + description: '' + title: wsnt_UnsubscribeResponse + type: object + xml: + attribute: false + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsnt_UnsupportedPolicyRequestFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + UnsupportedPolicy: + description: '' + items: + type: string + xml: + attribute: false + name: UnsupportedPolicy + wrapped: false + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + type: object + xml: + attribute: false + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + description: '' + title: wsnt_UnsupportedPolicyRequestFaultType + wsnt_UseRaw: + description: '' + title: wsnt_UseRaw + type: object + xml: + attribute: false + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + wrapped: false + wsrf-bf_BaseFaultType: + description: '' + properties: + Description: + description: '' + items: + $ref: '#/components/schemas/wsrf-bf_Description' + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + attribute: false + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + attribute: false + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + attribute: false + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + Timestamp: + format: date-time + type: string + xml: + attribute: false + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + required: + - Timestamp + title: wsrf-bf_BaseFaultType + type: object + xml: + attribute: false + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + wsrf-bf_Description: + description: '' + properties: + lang: + description: "lang (as an attribute name)\n denotes an attribute whose\ + \ value\n is a language code for the natural language of the content\ + \ of\n any element; its value is inherited. This name is reserved\n\ + \ by virtue of its definition in the XML specification." + oneOf: + - type: string + - type: string + xml: + attribute: true + name: lang + prefix: tns1 + wrapped: false + title: wsrf-bf_Description + type: object + xml: + attribute: false + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + wsrf-bf_ErrorCode: + description: '' + properties: + dialect: + type: string + xml: + attribute: true + name: dialect + wrapped: false + required: + - dialect + title: wsrf-bf_ErrorCode + type: object + xml: + attribute: false + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + wsrf-bf_FaultCause: + description: '' + title: wsrf-bf_FaultCause + type: object + xml: + attribute: false + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + wrapped: false + wstop_Documentation: + description: '' + title: wstop_Documentation + type: object + xml: + attribute: false + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + wstop_ExtensibleDocumented: + description: '' + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + attribute: false + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + title: wstop_ExtensibleDocumented + type: object + xml: + attribute: false + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + wstop_QueryExpressionType: + description: '' + properties: + Dialect: + type: string + xml: + attribute: true + name: Dialect + wrapped: false + required: + - Dialect + title: wstop_QueryExpressionType + type: object + xml: + attribute: false + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + wstop_Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + attribute: true + name: parent + wrapped: false + type: object + xml: + attribute: false + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + description: '' + title: wstop_Topic + wstop_TopicNamespaceType: + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - properties: + Topic: + description: '' + items: + $ref: '#/components/schemas/wstop_Topic' + type: array + xml: + attribute: false + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + final: + default: false + type: boolean + xml: + attribute: true + name: final + wrapped: false + name: + type: string + xml: + attribute: true + name: name + wrapped: false + targetNamespace: + type: string + xml: + attribute: true + name: targetNamespace + wrapped: false + required: + - targetNamespace + type: object + xml: + attribute: false + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + description: '' + title: wstop_TopicNamespaceType + wstop_TopicSetType: + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + attribute: false + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + description: '' + title: wstop_TopicSetType + wstop_TopicType: + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + description: '' + items: + $ref: '#/components/schemas/wstop_TopicType' + type: array + final: + default: false + type: boolean + xml: + attribute: true + wrapped: false + messageTypes: + description: '' + items: + type: string + type: array + name: + type: string + xml: + attribute: true + wrapped: false + required: + - name + type: object + xml: + attribute: false + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + wrapped: false + description: '' + title: wstop_TopicType + xmime_base64Binary: + description: '' + properties: + contentType: + minLength: 3 + type: string + xml: + attribute: true + name: contentType + prefix: xmime + wrapped: false + title: xmime_base64Binary + type: object + xml: + attribute: false + name: base64Binary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + wrapped: false + xmime_hexBinary: + description: '' + properties: + contentType: + minLength: 3 + type: string + xml: + attribute: true + name: contentType + prefix: xmime + wrapped: false + title: xmime_hexBinary + type: object + xml: + attribute: false + name: hexBinary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + wrapped: false + xop_Include: + description: '' + properties: + href: + type: string + xml: + attribute: true + name: href + prefix: xop + wrapped: false + required: + - href + title: xop_Include + type: object + xml: + attribute: false + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + wrapped: false +info: + contact: {} + title: Untitled API + version: '1.0' +paths: + /AddIPAddressFilter: + post: + deprecated: false + description: "This operation adds an IP filter address to a device. If the device\ + \ supports device access\n\t\t\t\tcontrol based on IP filtering rules (denied\ + \ or accepted ranges of IP addresses), the device\n\t\t\t\tshall support adding\ + \ of IP filtering addresses through the AddIPAddressFilter command." + operationId: AddIPAddressFilter + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddIPAddressFilterRequest' + - xml: + attribute: false + name: AddIPAddressFilterRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddIPAddressFilterResponse' + - xml: + attribute: false + name: AddIPAddressFilterResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: AddIPAddressFilter + tags: + - DeviceBinding + /AddScopes: + post: + deprecated: false + description: "This operation adds new configurable scope parameters to a device.\ + \ The scope parameters\n\t\t\t\tare used in the device discovery to match\ + \ a probe message. The device shall\n\t\t\t\tsupport addition of discovery\ + \ scope parameters through the AddScopes command." + operationId: AddScopes + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddScopesRequest' + - xml: + attribute: false + name: AddScopesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddScopesResponse' + - xml: + attribute: false + name: AddScopesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: AddScopes + tags: + - DeviceBinding + /CreateCertificate: + post: + deprecated: false + operationId: CreateCertificate + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateCertificateRequest' + - xml: + attribute: false + name: CreateCertificateRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateCertificateResponse' + - xml: + attribute: false + name: CreateCertificateResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: CreateCertificate + tags: + - DeviceBinding + /CreateDot1XConfiguration: + post: + deprecated: false + operationId: CreateDot1XConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateDot1XConfigurationRequest' + - xml: + attribute: false + name: CreateDot1XConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateDot1XConfigurationResponse' + - xml: + attribute: false + name: CreateDot1XConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: CreateDot1XConfiguration + tags: + - DeviceBinding + /CreateStorageConfiguration: + post: + deprecated: false + description: "This operation creates a new storage configuration. \n\t\t\tThe\ + \ configuration data shall be created in the device and shall be persistent\ + \ (remain after reboot)." + operationId: CreateStorageConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateStorageConfigurationRequest' + - xml: + attribute: false + name: CreateStorageConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateStorageConfigurationResponse' + - xml: + attribute: false + name: CreateStorageConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: CreateStorageConfiguration + tags: + - DeviceBinding + /CreateUsers: + post: + deprecated: false + description: "This operation creates new device users and corresponding credentials\ + \ on a device for authentication purposes. \n\t\t\t\tThe device shall support\ + \ creation of device users and their credentials through the CreateUsers\n\ + \t\t\t\tcommand. Either all users are created successfully or a fault message\ + \ shall be returned\n\t\t\t\twithout creating any user." + operationId: CreateUsers + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateUsersRequest' + - xml: + attribute: false + name: CreateUsersRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateUsersResponse' + - xml: + attribute: false + name: CreateUsersResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: CreateUsers + tags: + - DeviceBinding + /DeleteCertificates: + post: + deprecated: false + operationId: DeleteCertificates + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteCertificatesRequest' + - xml: + attribute: false + name: DeleteCertificatesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteCertificatesResponse' + - xml: + attribute: false + name: DeleteCertificatesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: DeleteCertificates + tags: + - DeviceBinding + /DeleteDot1XConfiguration: + post: + deprecated: false + operationId: DeleteDot1XConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteDot1XConfigurationRequest' + - xml: + attribute: false + name: DeleteDot1XConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteDot1XConfigurationResponse' + - xml: + attribute: false + name: DeleteDot1XConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: DeleteDot1XConfiguration + tags: + - DeviceBinding + /DeleteGeoLocation: + post: + deprecated: false + description: This operation deletes the given geo location entries. + operationId: DeleteGeoLocation + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteGeoLocationRequest' + - xml: + attribute: false + name: DeleteGeoLocationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteGeoLocationResponse' + - xml: + attribute: false + name: DeleteGeoLocationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: DeleteGeoLocation + tags: + - DeviceBinding + /DeleteStorageConfiguration: + post: + deprecated: false + description: This operation deletes the given storage configuration and configuration + change shall always be persistent. + operationId: DeleteStorageConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteStorageConfigurationRequest' + - xml: + attribute: false + name: DeleteStorageConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteStorageConfigurationResponse' + - xml: + attribute: false + name: DeleteStorageConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: DeleteStorageConfiguration + tags: + - DeviceBinding + /DeleteUsers: + post: + deprecated: false + description: "This operation deletes users on a device. The device shall support\ + \ deletion of device users and their credentials \n\t\t\t\tthrough the DeleteUsers\ + \ command. A device may have one or more fixed users\n\t\t\t\tthat cannot\ + \ be deleted to ensure access to the unit. Either all users are deleted successfully\ + \ or a\n\t\t\t\tfault message shall be returned and no users be deleted." + operationId: DeleteUsers + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteUsersRequest' + - xml: + attribute: false + name: DeleteUsersRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteUsersResponse' + - xml: + attribute: false + name: DeleteUsersResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: DeleteUsers + tags: + - DeviceBinding + /GetAccessPolicy: + post: + deprecated: false + description: "Access to different services and sub-sets of services should be\ + \ subject to access control. The\n\t\t\t\tWS-Security framework gives the\ + \ prerequisite for end-point authentication. Authorization\n\t\t\t\tdecisions\ + \ can then be taken using an access security policy. This standard does not\ + \ mandate\n\t\t\t\tany particular policy description format or security policy\ + \ but this is up to the device\n\t\t\t\tmanufacturer or system provider to\ + \ choose policy and policy description format of choice.\n\t\t\t\tHowever,\ + \ an access policy (in arbitrary format) can be requested using this command.\ + \ If the\n\t\t\t\tdevice supports access policy settings based on WS-Security\ + \ authentication, then the device\n\t\t\t\tshall support this command." + operationId: GetAccessPolicy + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAccessPolicyRequest' + - xml: + attribute: false + name: GetAccessPolicyRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAccessPolicyResponse' + - xml: + attribute: false + name: GetAccessPolicyResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetAccessPolicy + tags: + - DeviceBinding + /GetAuthFailureWarningConfiguration: + post: + deprecated: false + description: This method allows retrieval of the current authentication failure + warning configuration settings. + operationId: GetAuthFailureWarningConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAuthFailureWarningConfigurationRequest' + - xml: + attribute: false + name: GetAuthFailureWarningConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAuthFailureWarningConfigurationResponse' + - xml: + attribute: false + name: GetAuthFailureWarningConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetAuthFailureWarningConfiguration + tags: + - DeviceBinding + /GetAuthFailureWarningOptions: + post: + deprecated: false + description: This method allows retrieval of all the available parameters and + their valid ranges for the authentication failure warning configuration. + operationId: GetAuthFailureWarningOptions + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAuthFailureWarningOptionsRequest' + - xml: + attribute: false + name: GetAuthFailureWarningOptionsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAuthFailureWarningOptionsResponse' + - xml: + attribute: false + name: GetAuthFailureWarningOptionsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetAuthFailureWarningOptions + tags: + - DeviceBinding + /GetCACertificates: + post: + deprecated: false + operationId: GetCACertificates + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCACertificatesRequest' + - xml: + attribute: false + name: GetCACertificatesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCACertificatesResponse' + - xml: + attribute: false + name: GetCACertificatesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetCACertificates + tags: + - DeviceBinding + /GetCapabilities: + post: + deprecated: false + description: "This method has been replaced by the more generic GetServices\ + \ method.\n\t\t\t For capabilities of individual services refer to the GetServiceCapabilities\ + \ methods." + operationId: GetCapabilities + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCapabilitiesRequest' + - xml: + attribute: false + name: GetCapabilitiesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCapabilitiesResponse' + - xml: + attribute: false + name: GetCapabilitiesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetCapabilities + tags: + - DeviceBinding + /GetCertificateInformation: + post: + deprecated: false + operationId: GetCertificateInformation + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCertificateInformationRequest' + - xml: + attribute: false + name: GetCertificateInformationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCertificateInformationResponse' + - xml: + attribute: false + name: GetCertificateInformationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetCertificateInformation + tags: + - DeviceBinding + /GetCertificates: + post: + deprecated: false + operationId: GetCertificates + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCertificatesRequest' + - xml: + attribute: false + name: GetCertificatesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCertificatesResponse' + - xml: + attribute: false + name: GetCertificatesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetCertificates + tags: + - DeviceBinding + /GetCertificatesStatus: + post: + deprecated: false + operationId: GetCertificatesStatus + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCertificatesStatusRequest' + - xml: + attribute: false + name: GetCertificatesStatusRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCertificatesStatusResponse' + - xml: + attribute: false + name: GetCertificatesStatusResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetCertificatesStatus + tags: + - DeviceBinding + /GetClientCertificateMode: + post: + deprecated: false + operationId: GetClientCertificateMode + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetClientCertificateModeRequest' + - xml: + attribute: false + name: GetClientCertificateModeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetClientCertificateModeResponse' + - xml: + attribute: false + name: GetClientCertificateModeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetClientCertificateMode + tags: + - DeviceBinding + /GetDNS: + post: + deprecated: false + description: "This operation gets the DNS settings from a device. The device\ + \ shall return its DNS\n\t\t\t\tconfigurations through the GetDNS command." + operationId: GetDNS + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDNSRequest' + - xml: + attribute: false + name: GetDNSRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDNSResponse' + - xml: + attribute: false + name: GetDNSResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDNS + tags: + - DeviceBinding + /GetDPAddresses: + post: + deprecated: false + description: "This operation gets the remote DP address or addresses from a\ + \ device. If the device supports\n\t\t\t\tremote discovery, as specified in\ + \ Section 7.4, the device shall support retrieval of the remote\n\t\t\t\t\ + DP address(es) through the GetDPAddresses command." + operationId: GetDPAddresses + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDPAddressesRequest' + - xml: + attribute: false + name: GetDPAddressesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDPAddressesResponse' + - xml: + attribute: false + name: GetDPAddressesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDPAddresses + tags: + - DeviceBinding + /GetDeviceInformation: + post: + deprecated: false + description: This operation gets basic device information from the device. + operationId: GetDeviceInformation + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDeviceInformationRequest' + - xml: + attribute: false + name: GetDeviceInformationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDeviceInformationResponse' + - xml: + attribute: false + name: GetDeviceInformationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDeviceInformation + tags: + - DeviceBinding + /GetDiscoveryMode: + post: + deprecated: false + description: "This operation gets the discovery mode of a device. See Section\ + \ 7.2 for the definition of the\n\t\t\t\tdifferent device discovery modes.\ + \ The device shall support retrieval of the discovery mode\n\t\t\t\tsetting\ + \ through the GetDiscoveryMode command." + operationId: GetDiscoveryMode + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDiscoveryModeRequest' + - xml: + attribute: false + name: GetDiscoveryModeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDiscoveryModeResponse' + - xml: + attribute: false + name: GetDiscoveryModeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDiscoveryMode + tags: + - DeviceBinding + /GetDot11Capabilities: + post: + deprecated: false + description: "This operation returns the IEEE802.11 capabilities. The device\ + \ shall support\n\t\t\t\tthis operation." + operationId: GetDot11Capabilities + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot11CapabilitiesRequest' + - xml: + attribute: false + name: GetDot11CapabilitiesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot11CapabilitiesResponse' + - xml: + attribute: false + name: GetDot11CapabilitiesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDot11Capabilities + tags: + - DeviceBinding + /GetDot11Status: + post: + deprecated: false + description: "This operation returns the status of a wireless network interface.\ + \ The device shall support this\n\t\t\t\tcommand." + operationId: GetDot11Status + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot11StatusRequest' + - xml: + attribute: false + name: GetDot11StatusRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot11StatusResponse' + - xml: + attribute: false + name: GetDot11StatusResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDot11Status + tags: + - DeviceBinding + /GetDot1XConfiguration: + post: + deprecated: false + operationId: GetDot1XConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot1XConfigurationRequest' + - xml: + attribute: false + name: GetDot1XConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot1XConfigurationResponse' + - xml: + attribute: false + name: GetDot1XConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDot1XConfiguration + tags: + - DeviceBinding + /GetDot1XConfigurations: + post: + deprecated: false + operationId: GetDot1XConfigurations + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot1XConfigurationsRequest' + - xml: + attribute: false + name: GetDot1XConfigurationsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDot1XConfigurationsResponse' + - xml: + attribute: false + name: GetDot1XConfigurationsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDot1XConfigurations + tags: + - DeviceBinding + /GetDynamicDNS: + post: + deprecated: false + description: "This operation gets the dynamic DNS settings from a device. If\ + \ the device supports dynamic\n\t\t\t\tDNS as specified in [RFC 2136] and\ + \ [RFC 4702], it shall be possible to get the type, name\n\t\t\t\tand TTL\ + \ through the GetDynamicDNS command." + operationId: GetDynamicDNS + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDynamicDNSRequest' + - xml: + attribute: false + name: GetDynamicDNSRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetDynamicDNSResponse' + - xml: + attribute: false + name: GetDynamicDNSResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetDynamicDNS + tags: + - DeviceBinding + /GetEndpointReference: + post: + deprecated: false + description: "A client can ask for the device service endpoint reference address\ + \ property that can be used\n\t\t\t\tto derive the password equivalent for\ + \ remote user operation. The device shall support the\n\t\t\t\tGetEndpointReference\ + \ command returning the address property of the device service\n\t\t\t\tendpoint\ + \ reference." + operationId: GetEndpointReference + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetEndpointReferenceRequest' + - xml: + attribute: false + name: GetEndpointReferenceRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetEndpointReferenceResponse' + - xml: + attribute: false + name: GetEndpointReferenceResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetEndpointReference + tags: + - DeviceBinding + /GetGeoLocation: + post: + deprecated: false + description: This operation lists all existing geo location configurations for + the device. + operationId: GetGeoLocation + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetGeoLocationRequest' + - xml: + attribute: false + name: GetGeoLocationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetGeoLocationResponse' + - xml: + attribute: false + name: GetGeoLocationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetGeoLocation + tags: + - DeviceBinding + /GetHostname: + post: + deprecated: false + description: "This operation is used by an endpoint to get the hostname from\ + \ a device. The device shall\n\t\t\t\treturn its hostname configurations through\ + \ the GetHostname command." + operationId: GetHostname + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetHostnameRequest' + - xml: + attribute: false + name: GetHostnameRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetHostnameResponse' + - xml: + attribute: false + name: GetHostnameResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetHostname + tags: + - DeviceBinding + /GetIPAddressFilter: + post: + deprecated: false + description: "This operation gets the IP address filter settings from a device.\ + \ If the device supports device\n\t\t\t\taccess control based on IP filtering\ + \ rules (denied or accepted ranges of IP addresses), the\n\t\t\t\tdevice shall\ + \ support the GetIPAddressFilter command." + operationId: GetIPAddressFilter + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetIPAddressFilterRequest' + - xml: + attribute: false + name: GetIPAddressFilterRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetIPAddressFilterResponse' + - xml: + attribute: false + name: GetIPAddressFilterResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetIPAddressFilter + tags: + - DeviceBinding + /GetNTP: + post: + deprecated: false + description: "This operation gets the NTP settings from a device. If the device\ + \ supports NTP, it shall be\n\t\t\t\tpossible to get the NTP server settings\ + \ through the GetNTP command." + operationId: GetNTP + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNTPRequest' + - xml: + attribute: false + name: GetNTPRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNTPResponse' + - xml: + attribute: false + name: GetNTPResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetNTP + tags: + - DeviceBinding + /GetNetworkDefaultGateway: + post: + deprecated: false + description: "This operation gets the default gateway settings from a device.\ + \ The device shall support the\n\t\t\t\tGetNetworkDefaultGateway command returning\ + \ configured default gateway address(es)." + operationId: GetNetworkDefaultGateway + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNetworkDefaultGatewayRequest' + - xml: + attribute: false + name: GetNetworkDefaultGatewayRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNetworkDefaultGatewayResponse' + - xml: + attribute: false + name: GetNetworkDefaultGatewayResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetNetworkDefaultGateway + tags: + - DeviceBinding + /GetNetworkInterfaces: + post: + deprecated: false + description: "This operation gets the network interface configuration from a\ + \ device. The device shall\n\t\t\t\tsupport return of network interface configuration\ + \ settings as defined by the NetworkInterface\n\t\t\t\ttype through the GetNetworkInterfaces\ + \ command." + operationId: GetNetworkInterfaces + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNetworkInterfacesRequest' + - xml: + attribute: false + name: GetNetworkInterfacesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNetworkInterfacesResponse' + - xml: + attribute: false + name: GetNetworkInterfacesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetNetworkInterfaces + tags: + - DeviceBinding + /GetNetworkProtocols: + post: + deprecated: false + description: "This operation gets defined network protocols from a device. The\ + \ device shall support the\n\t\t\t\tGetNetworkProtocols command returning\ + \ configured network protocols." + operationId: GetNetworkProtocols + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNetworkProtocolsRequest' + - xml: + attribute: false + name: GetNetworkProtocolsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNetworkProtocolsResponse' + - xml: + attribute: false + name: GetNetworkProtocolsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetNetworkProtocols + tags: + - DeviceBinding + /GetPasswordComplexityConfiguration: + post: + deprecated: false + description: This method allows retrieval of the current password complexity + configuration settings. + operationId: GetPasswordComplexityConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPasswordComplexityConfigurationRequest' + - xml: + attribute: false + name: GetPasswordComplexityConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPasswordComplexityConfigurationResponse' + - xml: + attribute: false + name: GetPasswordComplexityConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetPasswordComplexityConfiguration + tags: + - DeviceBinding + /GetPasswordComplexityOptions: + post: + deprecated: false + description: This method allows retrieval of all the available parameters and + their valid ranges for the password complexity configuration. + operationId: GetPasswordComplexityOptions + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPasswordComplexityOptionsRequest' + - xml: + attribute: false + name: GetPasswordComplexityOptionsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPasswordComplexityOptionsResponse' + - xml: + attribute: false + name: GetPasswordComplexityOptionsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetPasswordComplexityOptions + tags: + - DeviceBinding + /GetPasswordHistoryConfiguration: + post: + deprecated: false + description: This method allows retrieval of the current password history configuration + settings. + operationId: GetPasswordHistoryConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPasswordHistoryConfigurationRequest' + - xml: + attribute: false + name: GetPasswordHistoryConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPasswordHistoryConfigurationResponse' + - xml: + attribute: false + name: GetPasswordHistoryConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetPasswordHistoryConfiguration + tags: + - DeviceBinding + /GetPkcs10Request: + post: + deprecated: false + operationId: GetPkcs10Request + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPkcs10RequestRequest' + - xml: + attribute: false + name: GetPkcs10RequestRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPkcs10RequestResponse' + - xml: + attribute: false + name: GetPkcs10RequestResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetPkcs10Request + tags: + - DeviceBinding + /GetRelayOutputs: + post: + deprecated: false + description: This operation gets a list of all available relay outputs and their + settings. + operationId: GetRelayOutputs + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRelayOutputsRequest' + - xml: + attribute: false + name: GetRelayOutputsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRelayOutputsResponse' + - xml: + attribute: false + name: GetRelayOutputsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetRelayOutputs + tags: + - DeviceBinding + /GetRemoteDiscoveryMode: + post: + deprecated: false + description: "This operation gets the remote discovery mode of a device. See\ + \ Section 7.4 for the definition\n\t\t\t\tof remote discovery extensions.\ + \ A device that supports remote discovery shall support\n\t\t\t\tretrieval\ + \ of the remote discovery mode setting through the GetRemoteDiscoveryMode\n\ + \t\t\t\tcommand." + operationId: GetRemoteDiscoveryMode + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRemoteDiscoveryModeRequest' + - xml: + attribute: false + name: GetRemoteDiscoveryModeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRemoteDiscoveryModeResponse' + - xml: + attribute: false + name: GetRemoteDiscoveryModeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetRemoteDiscoveryMode + tags: + - DeviceBinding + /GetRemoteUser: + post: + deprecated: false + description: "This operation returns the configured remote user (if any). A\ + \ device supporting remote user\n\t\t\t\thandling shall support this operation.\ + \ The user is only valid for the WS-UserToken profile or\n\t\t\t\tas a HTTP\ + \ / RTSP user." + operationId: GetRemoteUser + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRemoteUserRequest' + - xml: + attribute: false + name: GetRemoteUserRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetRemoteUserResponse' + - xml: + attribute: false + name: GetRemoteUserResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetRemoteUser + tags: + - DeviceBinding + /GetScopes: + post: + deprecated: false + description: "This operation requests the scope parameters of a device. The\ + \ scope parameters are used in\n\t\t\t\tthe device discovery to match a probe\ + \ message, see Section 7. The Scope parameters are of\n\t\t\t\ttwo different\ + \ types:" + operationId: GetScopes + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetScopesRequest' + - xml: + attribute: false + name: GetScopesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetScopesResponse' + - xml: + attribute: false + name: GetScopesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetScopes + tags: + - DeviceBinding + /GetServiceCapabilities: + post: + deprecated: false + description: Returns the capabilities of the device service. The result is returned + in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + attribute: false + name: GetServiceCapabilitiesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + attribute: false + name: GetServiceCapabilitiesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetServiceCapabilities + tags: + - DeviceBinding + /GetServices: + post: + deprecated: false + description: Returns information about services on the device. + operationId: GetServices + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServicesRequest' + - xml: + attribute: false + name: GetServicesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServicesResponse' + - xml: + attribute: false + name: GetServicesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetServices + tags: + - DeviceBinding + /GetStorageConfiguration: + post: + deprecated: false + description: This operation retrieves the Storage configuration associated with + the given storage configuration token. + operationId: GetStorageConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStorageConfigurationRequest' + - xml: + attribute: false + name: GetStorageConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStorageConfigurationResponse' + - xml: + attribute: false + name: GetStorageConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetStorageConfiguration + tags: + - DeviceBinding + /GetStorageConfigurations: + post: + deprecated: false + description: This operation lists all existing storage configurations for the + device. + operationId: GetStorageConfigurations + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStorageConfigurationsRequest' + - xml: + attribute: false + name: GetStorageConfigurationsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStorageConfigurationsResponse' + - xml: + attribute: false + name: GetStorageConfigurationsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetStorageConfigurations + tags: + - DeviceBinding + /GetSystemBackup: + post: + deprecated: false + description: "This operation is retrieves system backup configuration file(s)\ + \ from a device. The device\n\t\t\t\tshould support return of back up configuration\ + \ file(s) through the GetSystemBackup command.\n\t\t\t\tThe backup is returned\ + \ with reference to a name and mime-type together with binary data.\n\t\t\t\ + \tThe exact format of the backup configuration files is outside the scope\ + \ of this standard." + operationId: GetSystemBackup + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemBackupRequest' + - xml: + attribute: false + name: GetSystemBackupRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemBackupResponse' + - xml: + attribute: false + name: GetSystemBackupResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetSystemBackup + tags: + - DeviceBinding + /GetSystemDateAndTime: + post: + deprecated: false + description: "This operation gets the device system date and time. The device\ + \ shall support the return of\n\t\t\t\tthe daylight saving setting and of\ + \ the manual system date and time (if applicable) or indication\n\t\t\t\t\ + of NTP time (if applicable) through the GetSystemDateAndTime command." + operationId: GetSystemDateAndTime + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemDateAndTimeRequest' + - xml: + attribute: false + name: GetSystemDateAndTimeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemDateAndTimeResponse' + - xml: + attribute: false + name: GetSystemDateAndTimeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetSystemDateAndTime + tags: + - DeviceBinding + /GetSystemLog: + post: + deprecated: false + description: This operation gets a system log from the device. The exact format + of the system logs is outside the scope of this standard. + operationId: GetSystemLog + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemLogRequest' + - xml: + attribute: false + name: GetSystemLogRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemLogResponse' + - xml: + attribute: false + name: GetSystemLogResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetSystemLog + tags: + - DeviceBinding + /GetSystemSupportInformation: + post: + deprecated: false + description: This operation gets arbitary device diagnostics information from + the device. + operationId: GetSystemSupportInformation + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemSupportInformationRequest' + - xml: + attribute: false + name: GetSystemSupportInformationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemSupportInformationResponse' + - xml: + attribute: false + name: GetSystemSupportInformationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetSystemSupportInformation + tags: + - DeviceBinding + /GetSystemUris: + post: + deprecated: false + description: "This operation is used to retrieve URIs from which system information\ + \ may be downloaded\n\t\t\t\tusing HTTP. URIs may be returned for the following\ + \ system information:" + operationId: GetSystemUris + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemUrisRequest' + - xml: + attribute: false + name: GetSystemUrisRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSystemUrisResponse' + - xml: + attribute: false + name: GetSystemUrisResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetSystemUris + tags: + - DeviceBinding + /GetUsers: + post: + deprecated: false + description: "This operation lists the registered users and corresponding credentials\ + \ on a device. The\n\t\t\t\tdevice shall support retrieval of registered device\ + \ users and their credentials for the user\n\t\t\t\ttoken through the GetUsers\ + \ command." + operationId: GetUsers + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetUsersRequest' + - xml: + attribute: false + name: GetUsersRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetUsersResponse' + - xml: + attribute: false + name: GetUsersResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetUsers + tags: + - DeviceBinding + /GetWsdlUrl: + post: + deprecated: false + description: This method allows to provide a URL where product specific WSDL + and schema definitions can be retrieved. This method is deprecated. + operationId: GetWsdlUrl + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetWsdlUrlRequest' + - xml: + attribute: false + name: GetWsdlUrlRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetWsdlUrlResponse' + - xml: + attribute: false + name: GetWsdlUrlResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetWsdlUrl + tags: + - DeviceBinding + /GetZeroConfiguration: + post: + deprecated: false + description: "This operation gets the zero-configuration from a device. If the\ + \ device supports dynamic IP\n\t\t\t\tconfiguration according to [RFC3927],\ + \ it shall support the return of IPv4 zero configuration\n\t\t\t\taddress\ + \ and status through the GetZeroConfiguration command." + operationId: GetZeroConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetZeroConfigurationRequest' + - xml: + attribute: false + name: GetZeroConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetZeroConfigurationResponse' + - xml: + attribute: false + name: GetZeroConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: GetZeroConfiguration + tags: + - DeviceBinding + /LoadCACertificates: + post: + deprecated: false + operationId: LoadCACertificates + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/LoadCACertificatesRequest' + - xml: + attribute: false + name: LoadCACertificatesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/LoadCACertificatesResponse' + - xml: + attribute: false + name: LoadCACertificatesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: LoadCACertificates + tags: + - DeviceBinding + /LoadCertificateWithPrivateKey: + post: + deprecated: false + operationId: LoadCertificateWithPrivateKey + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/LoadCertificateWithPrivateKeyRequest' + - xml: + attribute: false + name: LoadCertificateWithPrivateKeyRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/LoadCertificateWithPrivateKeyResponse' + - xml: + attribute: false + name: LoadCertificateWithPrivateKeyResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: LoadCertificateWithPrivateKey + tags: + - DeviceBinding + /LoadCertificates: + post: + deprecated: false + operationId: LoadCertificates + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/LoadCertificatesRequest' + - xml: + attribute: false + name: LoadCertificatesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/LoadCertificatesResponse' + - xml: + attribute: false + name: LoadCertificatesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: LoadCertificates + tags: + - DeviceBinding + /RemoveIPAddressFilter: + post: + deprecated: false + description: "This operation deletes an IP filter address from a device. If\ + \ the device supports device access\n\t\t\t\tcontrol based on IP filtering\ + \ rules (denied or accepted ranges of IP addresses), the device\n\t\t\t\t\ + shall support deletion of IP filtering addresses through the RemoveIPAddressFilter\ + \ command." + operationId: RemoveIPAddressFilter + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveIPAddressFilterRequest' + - xml: + attribute: false + name: RemoveIPAddressFilterRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveIPAddressFilterResponse' + - xml: + attribute: false + name: RemoveIPAddressFilterResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: RemoveIPAddressFilter + tags: + - DeviceBinding + /RemoveScopes: + post: + deprecated: false + description: "This operation deletes scope-configurable scope parameters from\ + \ a device. The scope\n\t\t\t\tparameters are used in the device discovery\ + \ to match a probe message, see Section 7. The\n\t\t\t\tdevice shall support\ + \ deletion of discovery scope parameters through the RemoveScopes\n\t\t\t\t\ + command.\n\t\t\t\tTable" + operationId: RemoveScopes + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveScopesRequest' + - xml: + attribute: false + name: RemoveScopesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveScopesResponse' + - xml: + attribute: false + name: RemoveScopesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: RemoveScopes + tags: + - DeviceBinding + /RestoreSystem: + post: + deprecated: false + description: "This operation restores the system backup configuration files(s)\ + \ previously retrieved from a\n\t\t\t\tdevice. The device should support restore\ + \ of backup configuration file(s) through the\n\t\t\t\tRestoreSystem command.\ + \ The exact format of the backup configuration file(s) is outside the\n\t\t\ + \t\tscope of this standard. If the command is supported, it shall accept backup\ + \ files returned by\n\t\t\t\tthe GetSystemBackup command." + operationId: RestoreSystem + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RestoreSystemRequest' + - xml: + attribute: false + name: RestoreSystemRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RestoreSystemResponse' + - xml: + attribute: false + name: RestoreSystemResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: RestoreSystem + tags: + - DeviceBinding + /ScanAvailableDot11Networks: + post: + deprecated: false + description: "This operation returns a lists of the wireless networks in range\ + \ of the device. A device should\n\t\t\t\tsupport this operation." + operationId: ScanAvailableDot11Networks + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ScanAvailableDot11NetworksRequest' + - xml: + attribute: false + name: ScanAvailableDot11NetworksRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ScanAvailableDot11NetworksResponse' + - xml: + attribute: false + name: ScanAvailableDot11NetworksResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: ScanAvailableDot11Networks + tags: + - DeviceBinding + /SendAuxiliaryCommand: + post: + deprecated: false + description: "Manage auxiliary commands supported by a device, such as controlling\ + \ an Infrared (IR) lamp, \n\t\t\t\ta heater or a wiper or a thermometer that\ + \ is connected to the device." + operationId: SendAuxiliaryCommand + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SendAuxiliaryCommandRequest' + - xml: + attribute: false + name: SendAuxiliaryCommandRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SendAuxiliaryCommandResponse' + - xml: + attribute: false + name: SendAuxiliaryCommandResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SendAuxiliaryCommand + tags: + - DeviceBinding + /SetAccessPolicy: + post: + deprecated: false + description: "This command sets the device access security policy (for more\ + \ details on the access security\n\t\t\t\tpolicy see the Get command). If\ + \ the device supports access policy settings\n\t\t\t\tbased on WS-Security\ + \ authentication, then the device shall support this command." + operationId: SetAccessPolicy + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAccessPolicyRequest' + - xml: + attribute: false + name: SetAccessPolicyRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAccessPolicyResponse' + - xml: + attribute: false + name: SetAccessPolicyResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetAccessPolicy + tags: + - DeviceBinding + /SetAuthFailureWarningConfiguration: + post: + deprecated: false + description: This method allows setting of the authentication failure warning + configuration. + operationId: SetAuthFailureWarningConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAuthFailureWarningConfigurationRequest' + - xml: + attribute: false + name: SetAuthFailureWarningConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAuthFailureWarningConfigurationResponse' + - xml: + attribute: false + name: SetAuthFailureWarningConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetAuthFailureWarningConfiguration + tags: + - DeviceBinding + /SetCertificatesStatus: + post: + deprecated: false + operationId: SetCertificatesStatus + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetCertificatesStatusRequest' + - xml: + attribute: false + name: SetCertificatesStatusRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetCertificatesStatusResponse' + - xml: + attribute: false + name: SetCertificatesStatusResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetCertificatesStatus + tags: + - DeviceBinding + /SetClientCertificateMode: + post: + deprecated: false + operationId: SetClientCertificateMode + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetClientCertificateModeRequest' + - xml: + attribute: false + name: SetClientCertificateModeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetClientCertificateModeResponse' + - xml: + attribute: false + name: SetClientCertificateModeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetClientCertificateMode + tags: + - DeviceBinding + /SetDNS: + post: + deprecated: false + description: "This operation sets the DNS settings on a device. It shall be\ + \ possible to set the device DNS\n\t\t\t\tconfigurations through the SetDNS\ + \ command." + operationId: SetDNS + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDNSRequest' + - xml: + attribute: false + name: SetDNSRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDNSResponse' + - xml: + attribute: false + name: SetDNSResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetDNS + tags: + - DeviceBinding + /SetDPAddresses: + post: + deprecated: false + description: "This operation sets the remote DP address or addresses on a device.\ + \ If the device supports\n\t\t\t\tremote discovery, as specified in Section\ + \ 7.4, the device shall support configuration of the\n\t\t\t\tremote DP address(es)\ + \ through the SetDPAddresses command." + operationId: SetDPAddresses + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDPAddressesRequest' + - xml: + attribute: false + name: SetDPAddressesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDPAddressesResponse' + - xml: + attribute: false + name: SetDPAddressesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetDPAddresses + tags: + - DeviceBinding + /SetDiscoveryMode: + post: + deprecated: false + description: "This operation sets the discovery mode operation of a device.\ + \ See Section 7.2 for the\n\t\t\t\tdefinition of the different device discovery\ + \ modes. The device shall support configuration of\n\t\t\t\tthe discovery\ + \ mode setting through the SetDiscoveryMode command." + operationId: SetDiscoveryMode + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDiscoveryModeRequest' + - xml: + attribute: false + name: SetDiscoveryModeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDiscoveryModeResponse' + - xml: + attribute: false + name: SetDiscoveryModeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetDiscoveryMode + tags: + - DeviceBinding + /SetDot1XConfiguration: + post: + deprecated: false + operationId: SetDot1XConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDot1XConfigurationRequest' + - xml: + attribute: false + name: SetDot1XConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDot1XConfigurationResponse' + - xml: + attribute: false + name: SetDot1XConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetDot1XConfiguration + tags: + - DeviceBinding + /SetDynamicDNS: + post: + deprecated: false + description: "This operation sets the dynamic DNS settings on a device. If the\ + \ device supports dynamic\n\t\t\t\tDNS as specified in [RFC 2136] and [RFC\ + \ 4702], it shall be possible to set the type, name\n\t\t\t\tand TTL through\ + \ the SetDynamicDNS command." + operationId: SetDynamicDNS + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDynamicDNSRequest' + - xml: + attribute: false + name: SetDynamicDNSRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetDynamicDNSResponse' + - xml: + attribute: false + name: SetDynamicDNSResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetDynamicDNS + tags: + - DeviceBinding + /SetGeoLocation: + post: + deprecated: false + description: This operation allows to modify one or more geo configuration entries. + operationId: SetGeoLocation + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetGeoLocationRequest' + - xml: + attribute: false + name: SetGeoLocationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetGeoLocationResponse' + - xml: + attribute: false + name: SetGeoLocationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetGeoLocation + tags: + - DeviceBinding + /SetHostname: + post: + deprecated: false + description: "This operation sets the hostname on a device. It shall be possible\ + \ to set the device hostname\n\t\t\t\tconfigurations through the SetHostname\ + \ command." + operationId: SetHostname + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetHostnameRequest' + - xml: + attribute: false + name: SetHostnameRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetHostnameResponse' + - xml: + attribute: false + name: SetHostnameResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetHostname + tags: + - DeviceBinding + /SetHostnameFromDHCP: + post: + deprecated: false + description: This operation controls whether the hostname is set manually or + retrieved via DHCP. + operationId: SetHostnameFromDHCP + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetHostnameFromDHCPRequest' + - xml: + attribute: false + name: SetHostnameFromDHCPRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetHostnameFromDHCPResponse' + - xml: + attribute: false + name: SetHostnameFromDHCPResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetHostnameFromDHCP + tags: + - DeviceBinding + /SetIPAddressFilter: + post: + deprecated: false + description: "This operation sets the IP address filter settings on a device.\ + \ If the device supports device\n\t\t\t\taccess control based on IP filtering\ + \ rules (denied or accepted ranges of IP addresses), the\n\t\t\t\tdevice shall\ + \ support configuration of IP filtering rules through the SetIPAddressFilter\n\ + \t\t\t\tcommand." + operationId: SetIPAddressFilter + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetIPAddressFilterRequest' + - xml: + attribute: false + name: SetIPAddressFilterRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetIPAddressFilterResponse' + - xml: + attribute: false + name: SetIPAddressFilterResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetIPAddressFilter + tags: + - DeviceBinding + /SetNTP: + post: + deprecated: false + description: "This operation sets the NTP settings on a device. If the device\ + \ supports NTP, it shall be\n\t\t\t\tpossible to set the NTP server settings\ + \ through the SetNTP command." + operationId: SetNTP + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNTPRequest' + - xml: + attribute: false + name: SetNTPRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNTPResponse' + - xml: + attribute: false + name: SetNTPResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetNTP + tags: + - DeviceBinding + /SetNetworkDefaultGateway: + post: + deprecated: false + description: "This operation sets the default gateway settings on a device.\ + \ The device shall support\n\t\t\t\tconfiguration of default gateway through\ + \ the SetNetworkDefaultGateway command." + operationId: SetNetworkDefaultGateway + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNetworkDefaultGatewayRequest' + - xml: + attribute: false + name: SetNetworkDefaultGatewayRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNetworkDefaultGatewayResponse' + - xml: + attribute: false + name: SetNetworkDefaultGatewayResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetNetworkDefaultGateway + tags: + - DeviceBinding + /SetNetworkInterfaces: + post: + deprecated: false + description: "This operation sets the network interface configuration on a device.\ + \ The device shall support\n\t\t\t\tnetwork configuration of supported network\ + \ interfaces through the SetNetworkInterfaces\n\t\t\t\tcommand." + operationId: SetNetworkInterfaces + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNetworkInterfacesRequest' + - xml: + attribute: false + name: SetNetworkInterfacesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNetworkInterfacesResponse' + - xml: + attribute: false + name: SetNetworkInterfacesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetNetworkInterfaces + tags: + - DeviceBinding + /SetNetworkProtocols: + post: + deprecated: false + description: "This operation configures defined network protocols on a device.\ + \ The device shall support\n\t\t\t\tconfiguration of defined network protocols\ + \ through the SetNetworkProtocols command." + operationId: SetNetworkProtocols + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNetworkProtocolsRequest' + - xml: + attribute: false + name: SetNetworkProtocolsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetNetworkProtocolsResponse' + - xml: + attribute: false + name: SetNetworkProtocolsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetNetworkProtocols + tags: + - DeviceBinding + /SetPasswordComplexityConfiguration: + post: + deprecated: false + description: This method allows setting of the password complexity configuration. + operationId: SetPasswordComplexityConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetPasswordComplexityConfigurationRequest' + - xml: + attribute: false + name: SetPasswordComplexityConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetPasswordComplexityConfigurationResponse' + - xml: + attribute: false + name: SetPasswordComplexityConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetPasswordComplexityConfiguration + tags: + - DeviceBinding + /SetPasswordHistoryConfiguration: + post: + deprecated: false + description: This method allows setting of the password history configuration. + operationId: SetPasswordHistoryConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetPasswordHistoryConfigurationRequest' + - xml: + attribute: false + name: SetPasswordHistoryConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetPasswordHistoryConfigurationResponse' + - xml: + attribute: false + name: SetPasswordHistoryConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetPasswordHistoryConfiguration + tags: + - DeviceBinding + /SetRelayOutputSettings: + post: + deprecated: false + description: This operation sets the settings of a relay output. + operationId: SetRelayOutputSettings + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRelayOutputSettingsRequest' + - xml: + attribute: false + name: SetRelayOutputSettingsRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRelayOutputSettingsResponse' + - xml: + attribute: false + name: SetRelayOutputSettingsResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetRelayOutputSettings + tags: + - DeviceBinding + /SetRelayOutputState: + post: + deprecated: false + description: This operation sets the state of a relay output. + operationId: SetRelayOutputState + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRelayOutputStateRequest' + - xml: + attribute: false + name: SetRelayOutputStateRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRelayOutputStateResponse' + - xml: + attribute: false + name: SetRelayOutputStateResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetRelayOutputState + tags: + - DeviceBinding + /SetRemoteDiscoveryMode: + post: + deprecated: false + description: "This operation sets the remote discovery mode of operation of\ + \ a device. See Section 7.4 for\n\t\t\t\tthe definition of remote discovery\ + \ remote extensions. A device that supports remote discovery\n\t\t\t\tshall\ + \ support configuration of the discovery mode setting through the\n\t\t\t\t\ + SetRemoteDiscoveryMode command." + operationId: SetRemoteDiscoveryMode + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRemoteDiscoveryModeRequest' + - xml: + attribute: false + name: SetRemoteDiscoveryModeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRemoteDiscoveryModeResponse' + - xml: + attribute: false + name: SetRemoteDiscoveryModeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetRemoteDiscoveryMode + tags: + - DeviceBinding + /SetRemoteUser: + post: + deprecated: false + description: "This operation sets the remote user. A device supporting remote\ + \ user handling shall support this\n\t\t\t\toperation. The user is only valid\ + \ for the WS-UserToken profile or as a HTTP / RTSP user." + operationId: SetRemoteUser + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRemoteUserRequest' + - xml: + attribute: false + name: SetRemoteUserRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetRemoteUserResponse' + - xml: + attribute: false + name: SetRemoteUserResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetRemoteUser + tags: + - DeviceBinding + /SetScopes: + post: + deprecated: false + description: "This operation sets the scope parameters of a device. The scope\ + \ parameters are used in the\n\t\t\t\tdevice discovery to match a probe message.\n\ + \t\t\t\tThis operation replaces all existing configurable scope parameters\ + \ (not fixed parameters). If\n\t\t\t\tthis shall be avoided, one should use\ + \ the scope add command instead. The device shall\n\t\t\t\tsupport configuration\ + \ of discovery scope parameters through the SetScopes command." + operationId: SetScopes + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetScopesRequest' + - xml: + attribute: false + name: SetScopesRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetScopesResponse' + - xml: + attribute: false + name: SetScopesResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetScopes + tags: + - DeviceBinding + /SetStorageConfiguration: + post: + deprecated: false + description: This operation modifies an existing Storage configuration. + operationId: SetStorageConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetStorageConfigurationRequest' + - xml: + attribute: false + name: SetStorageConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetStorageConfigurationResponse' + - xml: + attribute: false + name: SetStorageConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetStorageConfiguration + tags: + - DeviceBinding + /SetSystemDateAndTime: + post: + deprecated: false + description: "This operation sets the device system date and time. The device\ + \ shall support the\n\t\t\t\tconfiguration of the daylight saving setting\ + \ and of the manual system date and time (if\n\t\t\t\tapplicable) or indication\ + \ of NTP time (if applicable) through the SetSystemDateAndTime\n\t\t\t\tcommand." + operationId: SetSystemDateAndTime + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSystemDateAndTimeRequest' + - xml: + attribute: false + name: SetSystemDateAndTimeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSystemDateAndTimeResponse' + - xml: + attribute: false + name: SetSystemDateAndTimeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetSystemDateAndTime + tags: + - DeviceBinding + /SetSystemFactoryDefault: + post: + deprecated: false + description: This operation reloads the parameters on the device to their factory + default values. + operationId: SetSystemFactoryDefault + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSystemFactoryDefaultRequest' + - xml: + attribute: false + name: SetSystemFactoryDefaultRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSystemFactoryDefaultResponse' + - xml: + attribute: false + name: SetSystemFactoryDefaultResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetSystemFactoryDefault + tags: + - DeviceBinding + /SetUser: + post: + deprecated: false + description: "This operation updates the settings for one or several users on\ + \ a device for authentication purposes.\n\t\t\t\tThe device shall support\ + \ update of device users and their credentials through the SetUser command.\ + \ \n\t\t\t\tEither all change requests are processed successfully or a fault\ + \ message shall be returned and no change requests be processed." + operationId: SetUser + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetUserRequest' + - xml: + attribute: false + name: SetUserRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetUserResponse' + - xml: + attribute: false + name: SetUserResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetUser + tags: + - DeviceBinding + /SetZeroConfiguration: + post: + deprecated: false + description: This operation sets the zero-configuration. Use GetCapalities to + get if zero-zero-configuration is supported or not. + operationId: SetZeroConfiguration + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetZeroConfigurationRequest' + - xml: + attribute: false + name: SetZeroConfigurationRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetZeroConfigurationResponse' + - xml: + attribute: false + name: SetZeroConfigurationResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SetZeroConfiguration + tags: + - DeviceBinding + /StartFirmwareUpgrade: + post: + deprecated: false + description: "This operation initiates a firmware upgrade using the HTTP POST\ + \ mechanism. The response\n\t\t\t\tto the command includes an HTTP URL to\ + \ which the upgrade file may be uploaded. The\n\t\t\t\tactual upgrade takes\ + \ place as soon as the HTTP POST operation has completed. The device\n\t\t\ + \t\tshould support firmware upgrade through the StartFirmwareUpgrade command.\ + \ The exact\n\t\t\t\tformat of the firmware data is outside the scope of this\ + \ specification.\n\t\t\t\tFirmware upgrade over HTTP may be achieved using\ + \ the following steps:" + operationId: StartFirmwareUpgrade + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartFirmwareUpgradeRequest' + - xml: + attribute: false + name: StartFirmwareUpgradeRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartFirmwareUpgradeResponse' + - xml: + attribute: false + name: StartFirmwareUpgradeResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: StartFirmwareUpgrade + tags: + - DeviceBinding + /StartSystemRestore: + post: + deprecated: false + description: "This operation initiates a system restore from backed up configuration\ + \ data using the HTTP\n\t\t\t\tPOST mechanism. The response to the command\ + \ includes an HTTP URL to which the backup\n\t\t\t\tfile may be uploaded.\ + \ The actual restore takes place as soon as the HTTP POST operation\n\t\t\t\ + \thas completed. Devices should support system restore through the StartSystemRestore\n\ + \t\t\t\tcommand. The exact format of the backup configuration data is outside\ + \ the scope of this\n\t\t\t\tspecification." + operationId: StartSystemRestore + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartSystemRestoreRequest' + - xml: + attribute: false + name: StartSystemRestoreRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartSystemRestoreResponse' + - xml: + attribute: false + name: StartSystemRestoreResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: StartSystemRestore + tags: + - DeviceBinding + /SystemReboot: + post: + deprecated: false + description: This operation reboots the device. + operationId: SystemReboot + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SystemRebootRequest' + - xml: + attribute: false + name: SystemRebootRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SystemRebootResponse' + - xml: + attribute: false + name: SystemRebootResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: SystemReboot + tags: + - DeviceBinding + /UpgradeSystemFirmware: + post: + deprecated: false + description: "This operation upgrades a device firmware version. After a successful\ + \ upgrade the response\n\t\t\t\tmessage is sent before the device reboots.\ + \ The device should support firmware upgrade\n\t\t\t\tthrough the UpgradeSystemFirmware\ + \ command. The exact format of the firmware data is\n\t\t\t\toutside the scope\ + \ of this standard." + operationId: UpgradeSystemFirmware + parameters: [] + requestBody: + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/UpgradeSystemFirmwareRequest' + - xml: + attribute: false + name: UpgradeSystemFirmwareRequest + wrapped: false + description: '' + required: true + responses: + '200': + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/UpgradeSystemFirmwareResponse' + - xml: + attribute: false + name: UpgradeSystemFirmwareResponse + wrapped: false + description: Successfully retrieved the response + headers: {} + summary: UpgradeSystemFirmware + tags: + - DeviceBinding +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +tags: +- description: '' + name: DeviceBinding diff --git a/doc/openapi/ref/event.yaml b/doc/openapi/ref/event.yaml new file mode 100644 index 00000000..579a81f7 --- /dev/null +++ b/doc/openapi/ref/event.yaml @@ -0,0 +1,3562 @@ +openapi: 3.0.0 +info: + title: WS-BaseNotification + contact: {} + version: '1.0' +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +paths: + /PullMessages: + post: + tags: + - PullPointSubscriptionBinding + summary: PullMessages + 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. + operationId: PullMessages + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/PullMessagesRequest' + - xml: + name: PullMessagesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/PullMessagesResponse' + - xml: + name: PullMessagesResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/PullMessagesFaultResponse' + - xml: + name: PullMessagesFaultResponse + attribute: false + wrapped: false + deprecated: false + /Seek: + post: + tags: + - PullPointSubscriptionBinding + summary: Seek + 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. + operationId: Seek + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SeekRequest' + - xml: + name: SeekRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SeekResponse' + - xml: + name: SeekResponse + attribute: false + wrapped: false + deprecated: false + /SetSynchronizationPoint: + post: + tags: + - PullPointSubscriptionBinding + summary: SetSynchronizationPoint + 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. + operationId: SetSynchronizationPoint + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSynchronizationPointRequest' + - xml: + name: SetSynchronizationPointRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSynchronizationPointResponse' + - xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + deprecated: false + /Unsubscribe: + post: + tags: + - PullPointSubscriptionBinding + summary: Unsubscribe + description: The device shall provide the following Unsubscribe command for all SubscriptionManager endpoints returned by the CreatePullPointSubscription command. + operationId: Unsubscribe + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/UnsubscribeRequest' + - xml: + name: UnsubscribeRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/UnsubscribeResponse' + - xml: + name: UnsubscribeResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /GetServiceCapabilities: + post: + tags: + - EventBinding + summary: GetServiceCapabilities + description: Returns the capabilities of the event service. The result is returned in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + name: GetServiceCapabilitiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + deprecated: false + /CreatePullPointSubscription: + post: + tags: + - EventBinding + summary: CreatePullPointSubscription + description: "This method returns a PullPointSubscription that can be polled using PullMessages. \n This message contains the same elements as the SubscriptionRequest of the WS-BaseNotification without the ConsumerReference." + operationId: CreatePullPointSubscription + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreatePullPointSubscriptionRequest' + - xml: + name: CreatePullPointSubscriptionRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreatePullPointSubscriptionResponse' + - xml: + name: CreatePullPointSubscriptionResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /GetEventProperties: + post: + tags: + - EventBinding + summary: GetEventProperties + 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. + operationId: GetEventProperties + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetEventPropertiesRequest' + - xml: + name: GetEventPropertiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetEventPropertiesResponse' + - xml: + name: GetEventPropertiesResponse + attribute: false + wrapped: false + deprecated: false + /AddEventBroker: + post: + tags: + - EventBinding + summary: AddEventBroker + 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. + operationId: AddEventBroker + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddEventBrokerRequest' + - xml: + name: AddEventBrokerRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddEventBrokerResponse' + - xml: + name: AddEventBrokerResponse + attribute: false + wrapped: false + deprecated: false + /DeleteEventBroker: + post: + tags: + - EventBinding + summary: DeleteEventBroker + description: The DeleteEventBroker allows an ONVIF client to delete an event broker configuration from an ONVIF device. + operationId: DeleteEventBroker + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteEventBrokerRequest' + - xml: + name: DeleteEventBrokerRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteEventBrokerResponse' + - xml: + name: DeleteEventBrokerResponse + attribute: false + wrapped: false + deprecated: false + /GetEventBrokers: + post: + tags: + - EventBinding + summary: GetEventBrokers + description: The GetEventBrokers command lets a client retrieve event broker configurations from the device. + operationId: GetEventBrokers + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetEventBrokersRequest' + - xml: + name: GetEventBrokersRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetEventBrokersResponse' + - xml: + name: GetEventBrokersResponse + attribute: false + wrapped: false + deprecated: false + /Renew: + post: + tags: + - SubscriptionManagerBinding + summary: Renew + operationId: Renew + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RenewRequest' + - xml: + name: RenewRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RenewResponse' + - xml: + name: RenewResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /Subscribe: + post: + tags: + - NotificationProducerBinding + summary: Subscribe + operationId: Subscribe + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SubscribeRequest' + - xml: + name: SubscribeRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SubscribeResponse' + - xml: + name: SubscribeResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /GetCurrentMessage: + post: + tags: + - NotificationProducerBinding + summary: GetCurrentMessage + operationId: GetCurrentMessage + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCurrentMessageRequest' + - xml: + name: GetCurrentMessageRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCurrentMessageResponse' + - xml: + name: GetCurrentMessageResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /Notify: + post: + tags: + - NotificationConsumerBinding + summary: Notify + operationId: Notify + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/Notify' + - xml: + name: Notify + attribute: false + wrapped: false + required: true + responses: + '200': + description: '' + headers: {} + deprecated: false + /GetMessages: + post: + tags: + - PullPointBinding + summary: GetMessages + operationId: GetMessages + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMessagesRequest' + - xml: + name: GetMessagesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMessagesResponse' + - xml: + name: GetMessagesResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /DestroyPullPoint: + post: + tags: + - PullPointBinding + summary: DestroyPullPoint + operationId: DestroyPullPoint + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DestroyPullPointRequest' + - xml: + name: DestroyPullPointRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DestroyPullPointResponse' + - xml: + name: DestroyPullPointResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /CreatePullPoint: + post: + tags: + - CreatePullPointBinding + summary: CreatePullPoint + operationId: CreatePullPoint + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreatePullPointRequest' + - xml: + name: CreatePullPointRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreatePullPointResponse' + - xml: + name: CreatePullPointResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/UnableToCreatePullPointFault' + - xml: + name: UnableToCreatePullPointFault + attribute: false + wrapped: false + deprecated: false + /PauseSubscription: + post: + tags: + - PausableSubscriptionManagerBinding + summary: PauseSubscription + operationId: PauseSubscription + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/PauseSubscriptionRequest' + - xml: + name: PauseSubscriptionRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/PauseSubscriptionResponse' + - xml: + name: PauseSubscriptionResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false + /ResumeSubscription: + post: + tags: + - PausableSubscriptionManagerBinding + summary: ResumeSubscription + operationId: ResumeSubscription + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResumeSubscriptionRequest' + - xml: + name: ResumeSubscriptionRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResumeSubscriptionResponse' + - xml: + name: ResumeSubscriptionResponse + attribute: false + wrapped: false + '500': + description: Error in retrieving response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ResourceUnknownFault' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + deprecated: false +components: + schemas: + tns_GetServiceCapabilities: + title: tns_GetServiceCapabilities + type: object + description: '' + xml: + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetServiceCapabilitiesResponse: + title: tns_GetServiceCapabilitiesResponse + required: + - Capabilities + type: object + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities' + - description: The capabilities for the event service is returned in the Capabilities element. + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Capabilities: + title: tns_Capabilities + type: object + properties: + WSSubscriptionPolicySupport: + type: boolean + description: Indicates that the WS Subscription policy is supported. + xml: + name: WSSubscriptionPolicySupport + prefix: tns + attribute: true + wrapped: false + WSPullPointSupport: + type: boolean + description: Indicates that the WS Pull Point is supported. + xml: + name: WSPullPointSupport + prefix: tns + attribute: true + wrapped: false + WSPausableSubscriptionManagerInterfaceSupport: + type: boolean + description: Indicates that the WS Pausable Subscription Manager Interface is supported. + xml: + name: WSPausableSubscriptionManagerInterfaceSupport + prefix: tns + attribute: true + wrapped: false + MaxNotificationProducers: + type: integer + description: Maximum number of supported notification producers as defined by WS-BaseNotification. + format: int32 + xml: + name: MaxNotificationProducers + prefix: tns + attribute: true + wrapped: false + MaxPullPoints: + type: integer + description: Maximum supported number of notification pull points. + format: int32 + xml: + name: MaxPullPoints + prefix: tns + attribute: true + wrapped: false + PersistentNotificationStorage: + type: boolean + description: Indication if the device supports persistent notification storage. + xml: + name: PersistentNotificationStorage + prefix: tns + attribute: true + wrapped: false + EventBrokerProtocols: + type: string + description: A space separated list of supported event broker protocols as defined by the tev:EventBrokerProtocol datatype. + xml: + name: EventBrokerProtocols + prefix: tns + attribute: true + wrapped: false + MaxEventBrokers: + type: integer + description: Maxiumum number of event broker configurations that can be added to the device. + format: int32 + xml: + name: MaxEventBrokers + prefix: tns + attribute: true + wrapped: false + MetadataOverMQTT: + type: boolean + description: Indicates that metadata streaming over MQTT is supported + xml: + name: MetadataOverMQTT + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreatePullPointSubscription: + title: tns_CreatePullPointSubscription + type: object + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - description: Optional XPATH expression to select specific topics. + xml: + name: Filter + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/tns_AbsoluteOrRelativeTimeType' + - description: Initial termination time. + xml: + name: InitialTerminationTime + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tns_SubscriptionPolicy' + - description: Refer to + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointSubscription + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreatePullPointSubscriptionResponse: + title: tns_CreatePullPointSubscriptionResponse + required: + - SubscriptionReference + - CurrentTime + - TerminationTime + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - description: Endpoint reference of the subscription to be used for pulling the messages. + xml: + name: SubscriptionReference + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + CurrentTime: + type: string + description: Current time of the server for synchronization purposes. + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + description: Date time when the PullPoint will be shut down without further pull requests. + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointSubscriptionResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_PullMessages: + title: tns_PullMessages + required: + - Timeout + - MessageLimit + type: object + properties: + Timeout: + type: string + description: Maximum time to block until this method returns. + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + MessageLimit: + type: integer + description: Upper limit for the number of messages to return at once. A server implementation may decide to return less messages. + format: int32 + xml: + name: MessageLimit + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: PullMessages + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_PullMessagesResponse: + title: tns_PullMessagesResponse + required: + - CurrentTime + - TerminationTime + type: object + properties: + CurrentTime: + type: string + description: The date and time when the messages have been delivered by the web server to the client. + format: date-time + xml: + name: CurrentTime + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + TerminationTime: + type: string + description: Date time when the PullPoint will be shut down without further pull requests. + format: date-time + xml: + name: TerminationTime + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: List of messages. This list shall be empty in case of a timeout. + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: PullMessagesResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_PullMessagesFaultResponse: + title: tns_PullMessagesFaultResponse + required: + - MaxTimeout + - MaxMessageLimit + type: object + properties: + MaxTimeout: + type: string + description: Maximum timeout supported by the device. + format: date-time + xml: + name: MaxTimeout + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + MaxMessageLimit: + type: integer + description: Maximum message limit supported by the device. + format: int32 + xml: + name: MaxMessageLimit + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: PullMessagesFaultResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Seek: + title: tns_Seek + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + description: The date and time to match against stored messages. + format: date-time + xml: + name: UtcTime + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + Reverse: + type: boolean + description: Reverse the pull direction of PullMessages. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Seek + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SeekResponse: + title: tns_SeekResponse + type: object + description: '' + xml: + name: SeekResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetSynchronizationPoint: + title: tns_SetSynchronizationPoint + type: object + description: '' + xml: + name: SetSynchronizationPoint + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetSynchronizationPointResponse: + title: tns_SetSynchronizationPointResponse + type: object + description: '' + xml: + name: SetSynchronizationPointResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetEventProperties: + title: tns_GetEventProperties + type: object + description: '' + xml: + name: GetEventProperties + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetEventPropertiesResponse: + title: tns_GetEventPropertiesResponse + required: + - TopicNamespaceLocation + - FixedTopicSet + - TopicSet + - TopicExpressionDialect + - MessageContentFilterDialect + - MessageContentSchemaLocation + type: object + properties: + TopicNamespaceLocation: + type: array + items: + type: string + xml: + name: TopicNamespaceLocation + attribute: false + wrapped: false + description: List of topic namespaces supported. + xml: + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + description: True when topicset is fixed for all times. + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - description: Set of topics supported. + xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: Defines the XPath expression syntax supported for matching topic expressions. + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MessageContentFilterDialect: + type: array + items: + type: string + xml: + name: MessageContentFilterDialect + attribute: false + wrapped: false + description: Defines the XPath function set supported for message content filtering. + xml: + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + ProducerPropertiesFilterDialect: + type: array + items: + type: string + xml: + name: ProducerPropertiesFilterDialect + attribute: false + wrapped: false + description: Optional ProducerPropertiesDialects. Refer to + xml: + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + MessageContentSchemaLocation: + type: array + items: + type: string + xml: + name: MessageContentSchemaLocation + attribute: false + wrapped: false + description: >- + The Message Content Description Language allows referencing + of vendor-specific types. In order to ease the integration of such types into a client application, + the GetEventPropertiesResponse shall list all URI locations to schema files whose types are + used in the description of notifications, with MessageContentSchemaLocation elements. + xml: + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetEventPropertiesResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddEventBroker: + title: tns_AddEventBroker + required: + - EventBroker + type: object + properties: + EventBroker: + allOf: + - $ref: '#/components/schemas/tns_EventBrokerConfig' + - xml: + name: EventBroker + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddEventBroker + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddEventBrokerResponse: + title: tns_AddEventBrokerResponse + type: object + description: '' + xml: + name: AddEventBrokerResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteEventBroker: + title: tns_DeleteEventBroker + required: + - Address + type: object + properties: + Address: + type: string + xml: + name: Address + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteEventBroker + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteEventBrokerResponse: + title: tns_DeleteEventBrokerResponse + type: object + description: '' + xml: + name: DeleteEventBrokerResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetEventBrokers: + title: tns_GetEventBrokers + type: object + properties: + Address: + type: string + xml: + name: Address + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetEventBrokers + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetEventBrokersResponse: + title: tns_GetEventBrokersResponse + type: object + properties: + EventBroker: + type: array + items: + $ref: '#/components/schemas/tns_EventBrokerConfig' + description: '' + xml: + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetEventBrokersResponse + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_EventBrokerConfig: + title: tns_EventBrokerConfig + required: + - Address + - TopicPrefix + type: object + properties: + Address: + type: string + 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. + xml: + name: Address + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + TopicPrefix: + type: string + 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. + xml: + name: TopicPrefix + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + UserName: + type: string + description: User name for the event broker. + xml: + name: UserName + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + Password: + type: string + description: Password for the event broker. Password shall not be included when returned with GetEventBrokers. + xml: + name: Password + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + CertificateID: + type: string + description: Optional certificate ID in the key store pointing to a client certificate to be used for authenticating the device at the message broker. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + PublishFilter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - description: Concrete Topic Expression to select specific event topics to publish. + xml: + name: PublishFilter + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + QoS: + type: integer + 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.' + format: int32 + xml: + name: QoS + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + Status: + type: string + description: Current connection status (see tev:ConnectionStatus for possible values). + xml: + name: Status + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + CertPathValidationPolicyID: + type: string + 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. + xml: + name: CertPathValidationPolicyID + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + MetadataFilter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - description: Concrete Topic Expression to select specific metadata topics to publish. + xml: + name: MetadataFilter + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: EventBrokerConfig + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_EventBrokerProtocol: + title: tns_EventBrokerProtocol + enum: + - mqtt + - mqtts + - ws + - wss + type: string + description: '' + xml: + name: EventBrokerProtocol + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ConnectionStatus: + title: tns_ConnectionStatus + enum: + - Offline + - Connecting + - Connected + type: string + description: '' + xml: + name: ConnectionStatus + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + wsa_EndpointReferenceType: + title: wsa_EndpointReferenceType + required: + - Address + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ReferenceParametersType: + title: wsa_ReferenceParametersType + type: object + description: '' + xml: + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_MetadataType: + title: wsa_MetadataType + type: object + description: '' + xml: + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedURIType: + title: wsa_AttributedURIType + type: object + description: '' + xml: + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelatesToType: + title: wsa_RelatesToType + type: object + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + name: RelationshipType + attribute: true + wrapped: false + description: '' + xml: + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelationshipTypeOpenEnum: + title: wsa_RelationshipTypeOpenEnum + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + description: '' + xml: + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_FaultCodesOpenEnumType: + title: wsa_FaultCodesOpenEnumType + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + description: '' + xml: + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedQNameType: + title: wsa_AttributedQNameType + type: object + description: '' + xml: + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedAnyType: + title: wsa_AttributedAnyType + type: object + description: '' + xml: + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ProblemActionType: + title: wsa_ProblemActionType + type: object + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + SoapAction: + type: string + xml: + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wstop_Documentation: + title: wstop_Documentation + type: object + description: '' + xml: + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_ExtensibleDocumented: + title: wstop_ExtensibleDocumented + type: object + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_QueryExpressionType: + title: wstop_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_TopicNamespaceType: + title: wstop_TopicNamespaceType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - targetNamespace + type: object + properties: + Topic: + type: array + items: + $ref: '#/components/schemas/wstop_Topic' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + name: + type: string + xml: + name: name + attribute: true + wrapped: false + targetNamespace: + type: string + xml: + name: targetNamespace + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + name: final + attribute: true + wrapped: false + xml: + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicType: + title: wstop_TopicType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - name + type: object + properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - {} + name: + type: string + xml: + attribute: true + wrapped: false + messageTypes: + type: array + items: + type: string + description: '' + xml: + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + attribute: true + wrapped: false + xml: + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicSetType: + title: wstop_TopicSetType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wsnt_QueryExpressionType: + title: wsnt_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_TopicExpressionType: + title: wsnt_TopicExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_FilterType: + title: wsnt_FilterType + type: object + description: '' + xml: + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicyType: + title: wsnt_SubscriptionPolicyType + type: object + description: '' + xml: + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationProducerRP: + title: wsnt_NotificationProducerRP + type: object + properties: + TopicExpression: + type: array + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + default: true + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionManagerRP: + title: wsnt_SubscriptionManagerRP + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CreationTime: + type: string + format: date-time + xml: + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationMessageHolderType: + title: wsnt_NotificationMessageHolderType + required: + - Message + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Notify: + title: wsnt_Notify + required: + - NotificationMessage + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UseRaw: + title: wsnt_UseRaw + type: object + description: '' + xml: + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Subscribe: + title: wsnt_Subscribe + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeResponse: + title: wsnt_SubscribeResponse + required: + - SubscriptionReference + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessage: + title: wsnt_GetCurrentMessage + required: + - Topic + type: object + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessageResponse: + title: wsnt_GetCurrentMessageResponse + type: object + description: '' + xml: + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + title: wsnt_SubscribeCreationFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidFilterFaultType: + title: wsnt_InvalidFilterFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - UnknownFilter + type: object + properties: + UnknownFilter: + type: array + items: + type: string + xml: + name: UnknownFilter + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicExpressionDialectUnknownFaultType: + title: wsnt_TopicExpressionDialectUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidTopicExpressionFaultType: + title: wsnt_InvalidTopicExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicNotSupportedFaultType: + title: wsnt_TopicNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_MultipleTopicsSpecifiedFaultType: + title: wsnt_MultipleTopicsSpecifiedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidProducerPropertiesExpressionFaultType: + title: wsnt_InvalidProducerPropertiesExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidMessageContentExpressionFaultType: + title: wsnt_InvalidMessageContentExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnrecognizedPolicyRequestFaultType: + title: wsnt_UnrecognizedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnrecognizedPolicy: + type: array + items: + type: string + xml: + name: UnrecognizedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnsupportedPolicyRequestFaultType: + title: wsnt_UnsupportedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnsupportedPolicy: + type: array + items: + type: string + xml: + name: UnsupportedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NotifyMessageNotSupportedFaultType: + title: wsnt_NotifyMessageNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnacceptableInitialTerminationTimeFaultType: + title: wsnt_UnacceptableInitialTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NoCurrentMessageOnTopicFaultType: + title: wsnt_NoCurrentMessageOnTopicFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_GetMessages: + title: wsnt_GetMessages + type: object + properties: + MaximumNumber: + type: integer + format: int32 + xml: + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetMessagesResponse: + title: wsnt_GetMessagesResponse + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPoint: + title: wsnt_DestroyPullPoint + type: object + description: '' + xml: + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPointResponse: + title: wsnt_DestroyPullPointResponse + type: object + description: '' + xml: + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToGetMessagesFaultType: + title: wsnt_UnableToGetMessagesFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnableToDestroyPullPointFaultType: + title: wsnt_UnableToDestroyPullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_CreatePullPoint: + title: wsnt_CreatePullPoint + type: object + description: '' + xml: + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_CreatePullPointResponse: + title: wsnt_CreatePullPointResponse + required: + - PullPoint + type: object + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToCreatePullPointFaultType: + title: wsnt_UnableToCreatePullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Renew: + title: wsnt_Renew + required: + - TerminationTime + type: object + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_RenewResponse: + title: wsnt_RenewResponse + required: + - TerminationTime + type: object + properties: + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnacceptableTerminationTimeFaultType: + title: wsnt_UnacceptableTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Unsubscribe: + title: wsnt_Unsubscribe + type: object + description: '' + xml: + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnsubscribeResponse: + title: wsnt_UnsubscribeResponse + type: object + description: '' + xml: + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToDestroySubscriptionFaultType: + title: wsnt_UnableToDestroySubscriptionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_PauseSubscription: + title: wsnt_PauseSubscription + type: object + description: '' + xml: + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseSubscriptionResponse: + title: wsnt_PauseSubscriptionResponse + type: object + description: '' + xml: + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscription: + title: wsnt_ResumeSubscription + type: object + description: '' + xml: + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscriptionResponse: + title: wsnt_ResumeSubscriptionResponse + type: object + description: '' + xml: + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseFailedFaultType: + title: wsnt_PauseFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_ResumeFailedFaultType: + title: wsnt_ResumeFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsrf-r_ResourceUnknownFaultType: + title: wsrf-r_ResourceUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResourceUnknownFaultType + namespace: http://docs.oasis-open.org/wsrf/r-2 + prefix: wsrf-r + attribute: false + wrapped: false + description: '' + wsrf-r_ResourceUnavailableFaultType: + title: wsrf-r_ResourceUnavailableFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResourceUnavailableFaultType + namespace: http://docs.oasis-open.org/wsrf/r-2 + prefix: wsrf-r + attribute: false + wrapped: false + description: '' + wsrf-bf_BaseFaultType: + title: wsrf-bf_BaseFaultType + required: + - Timestamp + type: object + properties: + Timestamp: + type: string + format: date-time + xml: + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Description: + type: array + items: + $ref: '#/components/schemas/wsrf-bf_Description' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + description: '' + xml: + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + AddEventBrokerRequest: + title: AddEventBrokerRequest + required: + - AddEventBroker + type: object + properties: + AddEventBroker: + allOf: + - $ref: '#/components/schemas/tns_AddEventBroker' + - {} + AddEventBrokerResponse: + title: AddEventBrokerResponse + required: + - AddEventBrokerResponse + type: object + properties: + AddEventBrokerResponse: + allOf: + - $ref: '#/components/schemas/tns_AddEventBrokerResponse' + - xml: + name: AddEventBrokerResponse + attribute: false + wrapped: false + xml: + name: AddEventBrokerResponse + attribute: false + wrapped: false + CreatePullPointRequest: + title: CreatePullPointRequest + required: + - CreatePullPoint + type: object + properties: + CreatePullPoint: + allOf: + - $ref: '#/components/schemas/wsnt_CreatePullPoint' + - {} + CreatePullPointResponse: + title: CreatePullPointResponse + required: + - CreatePullPointResponse + type: object + properties: + CreatePullPointResponse: + allOf: + - $ref: '#/components/schemas/wsnt_CreatePullPointResponse' + - xml: + name: CreatePullPointResponse + attribute: false + wrapped: false + xml: + name: CreatePullPointResponse + attribute: false + wrapped: false + CreatePullPointSubscriptionRequest: + title: CreatePullPointSubscriptionRequest + required: + - CreatePullPointSubscription + type: object + properties: + CreatePullPointSubscription: + allOf: + - $ref: '#/components/schemas/tns_CreatePullPointSubscription' + - {} + CreatePullPointSubscriptionResponse: + title: CreatePullPointSubscriptionResponse + required: + - CreatePullPointSubscriptionResponse + type: object + properties: + CreatePullPointSubscriptionResponse: + allOf: + - $ref: '#/components/schemas/tns_CreatePullPointSubscriptionResponse' + - xml: + name: CreatePullPointSubscriptionResponse + attribute: false + wrapped: false + xml: + name: CreatePullPointSubscriptionResponse + attribute: false + wrapped: false + DeleteEventBrokerRequest: + title: DeleteEventBrokerRequest + required: + - DeleteEventBroker + type: object + properties: + DeleteEventBroker: + allOf: + - $ref: '#/components/schemas/tns_DeleteEventBroker' + - {} + DeleteEventBrokerResponse: + title: DeleteEventBrokerResponse + required: + - DeleteEventBrokerResponse + type: object + properties: + DeleteEventBrokerResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteEventBrokerResponse' + - xml: + name: DeleteEventBrokerResponse + attribute: false + wrapped: false + xml: + name: DeleteEventBrokerResponse + attribute: false + wrapped: false + DestroyPullPointRequest: + title: DestroyPullPointRequest + required: + - DestroyPullPoint + type: object + properties: + DestroyPullPoint: + allOf: + - $ref: '#/components/schemas/wsnt_DestroyPullPoint' + - {} + DestroyPullPointResponse: + title: DestroyPullPointResponse + required: + - DestroyPullPointResponse + type: object + properties: + DestroyPullPointResponse: + allOf: + - $ref: '#/components/schemas/wsnt_DestroyPullPointResponse' + - xml: + name: DestroyPullPointResponse + attribute: false + wrapped: false + xml: + name: DestroyPullPointResponse + attribute: false + wrapped: false + GetCurrentMessageRequest: + title: GetCurrentMessageRequest + required: + - GetCurrentMessage + type: object + properties: + GetCurrentMessage: + allOf: + - $ref: '#/components/schemas/wsnt_GetCurrentMessage' + - {} + GetCurrentMessageResponse: + title: GetCurrentMessageResponse + required: + - GetCurrentMessageResponse + type: object + properties: + GetCurrentMessageResponse: + allOf: + - $ref: '#/components/schemas/wsnt_GetCurrentMessageResponse' + - xml: + name: GetCurrentMessageResponse + attribute: false + wrapped: false + xml: + name: GetCurrentMessageResponse + attribute: false + wrapped: false + GetEventBrokersRequest: + title: GetEventBrokersRequest + required: + - GetEventBrokers + type: object + properties: + GetEventBrokers: + allOf: + - $ref: '#/components/schemas/tns_GetEventBrokers' + - {} + GetEventBrokersResponse: + title: GetEventBrokersResponse + required: + - GetEventBrokersResponse + type: object + properties: + GetEventBrokersResponse: + allOf: + - $ref: '#/components/schemas/tns_GetEventBrokersResponse' + - xml: + name: GetEventBrokersResponse + attribute: false + wrapped: false + xml: + name: GetEventBrokersResponse + attribute: false + wrapped: false + GetEventPropertiesRequest: + title: GetEventPropertiesRequest + required: + - GetEventProperties + type: object + properties: + GetEventProperties: + allOf: + - $ref: '#/components/schemas/tns_GetEventProperties' + - {} + GetEventPropertiesResponse: + title: GetEventPropertiesResponse + required: + - GetEventPropertiesResponse + type: object + properties: + GetEventPropertiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetEventPropertiesResponse' + - xml: + name: GetEventPropertiesResponse + attribute: false + wrapped: false + xml: + name: GetEventPropertiesResponse + attribute: false + wrapped: false + GetMessagesRequest: + title: GetMessagesRequest + required: + - GetMessages + type: object + properties: + GetMessages: + allOf: + - $ref: '#/components/schemas/wsnt_GetMessages' + - {} + GetMessagesResponse: + title: GetMessagesResponse + required: + - GetMessagesResponse + type: object + properties: + GetMessagesResponse: + allOf: + - $ref: '#/components/schemas/wsnt_GetMessagesResponse' + - xml: + name: GetMessagesResponse + attribute: false + wrapped: false + xml: + name: GetMessagesResponse + attribute: false + wrapped: false + GetServiceCapabilitiesRequest: + title: GetServiceCapabilitiesRequest + required: + - GetServiceCapabilities + type: object + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + GetServiceCapabilitiesResponse: + title: GetServiceCapabilitiesResponse + required: + - GetServiceCapabilitiesResponse + type: object + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + Notify: + title: Notify + required: + - Notify + type: object + properties: + Notify: + allOf: + - $ref: '#/components/schemas/wsnt_Notify' + - {} + PauseSubscriptionRequest: + title: PauseSubscriptionRequest + required: + - PauseSubscription + type: object + properties: + PauseSubscription: + allOf: + - $ref: '#/components/schemas/wsnt_PauseSubscription' + - {} + PauseSubscriptionResponse: + title: PauseSubscriptionResponse + required: + - PauseSubscriptionResponse + type: object + properties: + PauseSubscriptionResponse: + allOf: + - $ref: '#/components/schemas/wsnt_PauseSubscriptionResponse' + - xml: + name: PauseSubscriptionResponse + attribute: false + wrapped: false + xml: + name: PauseSubscriptionResponse + attribute: false + wrapped: false + PullMessagesFaultResponse: + title: PullMessagesFaultResponse + required: + - PullMessagesFaultResponse + type: object + properties: + PullMessagesFaultResponse: + allOf: + - $ref: '#/components/schemas/tns_PullMessagesFaultResponse' + - xml: + name: PullMessagesFaultResponse + attribute: false + wrapped: false + xml: + name: PullMessagesFaultResponse + attribute: false + wrapped: false + PullMessagesFaultResponse_Error: + title: PullMessagesFaultResponse_Error + required: + - PullMessagesFaultResponse + type: object + properties: + PullMessagesFaultResponse: + allOf: + - $ref: '#/components/schemas/tns_PullMessagesFaultResponse' + - {} + PullMessagesRequest: + title: PullMessagesRequest + required: + - PullMessages + type: object + properties: + PullMessages: + allOf: + - $ref: '#/components/schemas/tns_PullMessages' + - {} + PullMessagesResponse: + title: PullMessagesResponse + required: + - PullMessagesResponse + type: object + properties: + PullMessagesResponse: + allOf: + - $ref: '#/components/schemas/tns_PullMessagesResponse' + - xml: + name: PullMessagesResponse + attribute: false + wrapped: false + xml: + name: PullMessagesResponse + attribute: false + wrapped: false + RenewRequest: + title: RenewRequest + required: + - Renew + type: object + properties: + Renew: + allOf: + - $ref: '#/components/schemas/wsnt_Renew' + - {} + RenewResponse: + title: RenewResponse + required: + - RenewResponse + type: object + properties: + RenewResponse: + allOf: + - $ref: '#/components/schemas/wsnt_RenewResponse' + - xml: + name: RenewResponse + attribute: false + wrapped: false + xml: + name: RenewResponse + attribute: false + wrapped: false + ResourceUnknownFault: + title: ResourceUnknownFault + required: + - ResourceUnknownFault + type: object + properties: + ResourceUnknownFault: + allOf: + - $ref: '#/components/schemas/wsrf-r_ResourceUnknownFaultType' + - xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + xml: + name: ResourceUnknownFault + attribute: false + wrapped: false + ResourceUnknownFault_Error: + title: ResourceUnknownFault_Error + required: + - ResourceUnknownFault + type: object + properties: + ResourceUnknownFault: + allOf: + - $ref: '#/components/schemas/wsrf-r_ResourceUnknownFaultType' + - {} + ResumeSubscriptionRequest: + title: ResumeSubscriptionRequest + required: + - ResumeSubscription + type: object + properties: + ResumeSubscription: + allOf: + - $ref: '#/components/schemas/wsnt_ResumeSubscription' + - {} + ResumeSubscriptionResponse: + title: ResumeSubscriptionResponse + required: + - ResumeSubscriptionResponse + type: object + properties: + ResumeSubscriptionResponse: + allOf: + - $ref: '#/components/schemas/wsnt_ResumeSubscriptionResponse' + - xml: + name: ResumeSubscriptionResponse + attribute: false + wrapped: false + xml: + name: ResumeSubscriptionResponse + attribute: false + wrapped: false + SeekRequest: + title: SeekRequest + required: + - Seek + type: object + properties: + Seek: + allOf: + - $ref: '#/components/schemas/tns_Seek' + - {} + SeekResponse: + title: SeekResponse + required: + - SeekResponse + type: object + properties: + SeekResponse: + allOf: + - $ref: '#/components/schemas/tns_SeekResponse' + - xml: + name: SeekResponse + attribute: false + wrapped: false + xml: + name: SeekResponse + attribute: false + wrapped: false + SetSynchronizationPointRequest: + title: SetSynchronizationPointRequest + required: + - SetSynchronizationPoint + type: object + properties: + SetSynchronizationPoint: + allOf: + - $ref: '#/components/schemas/tns_SetSynchronizationPoint' + - {} + SetSynchronizationPointResponse: + title: SetSynchronizationPointResponse + required: + - SetSynchronizationPointResponse + type: object + properties: + SetSynchronizationPointResponse: + allOf: + - $ref: '#/components/schemas/tns_SetSynchronizationPointResponse' + - xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + SubscribeRequest: + title: SubscribeRequest + required: + - Subscribe + type: object + properties: + Subscribe: + allOf: + - $ref: '#/components/schemas/wsnt_Subscribe' + - {} + SubscribeResponse: + title: SubscribeResponse + required: + - SubscribeResponse + type: object + properties: + SubscribeResponse: + allOf: + - $ref: '#/components/schemas/wsnt_SubscribeResponse' + - xml: + name: SubscribeResponse + attribute: false + wrapped: false + xml: + name: SubscribeResponse + attribute: false + wrapped: false + tns_SubscriptionPolicy: + title: tns_SubscriptionPolicy + type: object + description: Refer to + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/events/wsdl + prefix: tns + attribute: false + wrapped: false + tns1_space: + title: tns1_space + enum: + - default + - preserve + type: string + description: '' + xml: + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + attribute: false + wrapped: false + UnableToCreatePullPointFault: + title: UnableToCreatePullPointFault + required: + - UnableToCreatePullPointFault + type: object + properties: + UnableToCreatePullPointFault: + allOf: + - $ref: '#/components/schemas/wsnt_UnableToCreatePullPointFaultType' + - xml: + name: UnableToCreatePullPointFault + attribute: false + wrapped: false + xml: + name: UnableToCreatePullPointFault + attribute: false + wrapped: false + UnableToCreatePullPointFault_Error: + title: UnableToCreatePullPointFault_Error + required: + - UnableToCreatePullPointFault + type: object + properties: + UnableToCreatePullPointFault: + allOf: + - $ref: '#/components/schemas/wsnt_UnableToCreatePullPointFaultType' + - {} + UnsubscribeRequest: + title: UnsubscribeRequest + required: + - Unsubscribe + type: object + properties: + Unsubscribe: + allOf: + - $ref: '#/components/schemas/wsnt_Unsubscribe' + - {} + UnsubscribeResponse: + title: UnsubscribeResponse + required: + - UnsubscribeResponse + type: object + properties: + UnsubscribeResponse: + allOf: + - $ref: '#/components/schemas/wsnt_UnsubscribeResponse' + - xml: + name: UnsubscribeResponse + attribute: false + wrapped: false + xml: + name: UnsubscribeResponse + attribute: false + wrapped: false + wsnt_Message: + title: wsnt_Message + type: object + description: '' + xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicy: + title: wsnt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsrf-bf_Description: + title: wsrf-bf_Description + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_ErrorCode: + title: wsrf-bf_ErrorCode + required: + - dialect + type: object + properties: + dialect: + type: string + xml: + name: dialect + attribute: true + wrapped: false + description: '' + xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_FaultCause: + title: wsrf-bf_FaultCause + type: object + description: '' + xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Topic: + title: wstop_Topic + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - type: object + properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + name: parent + attribute: true + wrapped: false + xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + tns_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object + wsnt_AbsoluteOrRelativeTimeType: + $ref: '#/components/schemas/tns_AbsoluteOrRelativeTimeType' +tags: +- name: PullPointSubscriptionBinding + description: '' +- name: EventBinding + description: '' +- name: SubscriptionManagerBinding + description: '' +- name: NotificationProducerBinding + description: '' +- name: NotificationConsumerBinding + description: '' +- name: PullPointBinding + description: '' +- name: CreatePullPointBinding + description: '' +- name: PausableSubscriptionManagerBinding + description: '' diff --git a/doc/openapi/ref/imaging.yaml b/doc/openapi/ref/imaging.yaml new file mode 100644 index 00000000..94bc7ce6 --- /dev/null +++ b/doc/openapi/ref/imaging.yaml @@ -0,0 +1,21663 @@ +openapi: 3.0.0 +info: + title: ImagingService + contact: {} + version: '1.0' +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +paths: + /GetServiceCapabilities: + post: + tags: + - ImagingBinding + summary: GetServiceCapabilities + description: Returns the capabilities of the imaging service. The result is returned in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + name: GetServiceCapabilitiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + deprecated: false + /GetImagingSettings: + post: + tags: + - ImagingBinding + summary: GetImagingSettings + description: Get the ImagingConfiguration for the requested VideoSource. + operationId: GetImagingSettings + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetImagingSettingsRequest' + - xml: + name: GetImagingSettingsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetImagingSettingsResponse' + - xml: + name: GetImagingSettingsResponse + attribute: false + wrapped: false + deprecated: false + /SetImagingSettings: + post: + tags: + - ImagingBinding + summary: SetImagingSettings + description: Set the ImagingConfiguration for the requested VideoSource. + operationId: SetImagingSettings + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetImagingSettingsRequest' + - xml: + name: SetImagingSettingsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetImagingSettingsResponse' + - xml: + name: SetImagingSettingsResponse + attribute: false + wrapped: false + deprecated: false + /GetOptions: + post: + tags: + - ImagingBinding + summary: GetOptions + description: "This operation gets the valid ranges for the imaging parameters that have device specific ranges. \n This command is mandatory for all device implementing the imaging service. The command returns all supported parameters and their ranges \n such that these can be applied to the SetImagingSettings command." + operationId: GetOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOptionsRequest' + - xml: + name: GetOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOptionsResponse' + - xml: + name: GetOptionsResponse + attribute: false + wrapped: false + deprecated: false + /Move: + post: + tags: + - ImagingBinding + summary: Move + description: "The Move command moves the focus lens in an absolute, a relative or in a continuous manner from its current position. \n 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. \n Focus adjustments through this operation will turn off the autofocus. A device with support for remote focus control should support absolute, \n relative or continuous control through the Move operation. The supported MoveOpions are signalled via the GetMoveOptions command.\n At least one focus control capability is required for this operation to be functional." + operationId: Move + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/MoveRequest' + - xml: + name: MoveRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/MoveResponse' + - xml: + name: MoveResponse + attribute: false + wrapped: false + deprecated: false + /GetMoveOptions: + post: + tags: + - ImagingBinding + summary: GetMoveOptions + description: Imaging move operation options supported for the Video source. + operationId: GetMoveOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMoveOptionsRequest' + - xml: + name: GetMoveOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMoveOptionsResponse' + - xml: + name: GetMoveOptionsResponse + attribute: false + wrapped: false + deprecated: false + /Stop: + post: + tags: + - ImagingBinding + summary: Stop + description: "The Stop command stops all ongoing focus movements of the lense. A device with support for remote focus control as signalled via \n the GetMoveOptions supports this command." + operationId: Stop + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopRequest' + - xml: + name: StopRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopResponse' + - xml: + name: StopResponse + attribute: false + wrapped: false + deprecated: false + /GetStatus: + post: + tags: + - ImagingBinding + summary: GetStatus + 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. + operationId: GetStatus + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStatusRequest' + - xml: + name: GetStatusRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStatusResponse' + - xml: + name: GetStatusResponse + attribute: false + wrapped: false + deprecated: false + /GetPresets: + post: + tags: + - ImagingBinding + summary: GetPresets + description: Via this command the list of available Imaging Presets can be requested. + operationId: GetPresets + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetsRequest' + - xml: + name: GetPresetsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetsResponse' + - xml: + name: GetPresetsResponse + attribute: false + wrapped: false + deprecated: false + /GetCurrentPreset: + post: + tags: + - ImagingBinding + summary: GetCurrentPreset + description: "Via this command the last Imaging Preset applied can be requested. \n If the camera configuration does not match any of the existing Imaging Presets, the output of GetCurrentPreset shall be Empty.\n GetCurrentPreset shall return 0 if Imaging Presets are not supported by the Video Source." + operationId: GetCurrentPreset + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCurrentPresetRequest' + - xml: + name: GetCurrentPresetRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCurrentPresetResponse' + - xml: + name: GetCurrentPresetResponse + attribute: false + wrapped: false + deprecated: false + /SetCurrentPreset: + post: + tags: + - ImagingBinding + summary: SetCurrentPreset + description: "The SetCurrentPreset command shall request a given Imaging Preset to be applied to the specified Video Source.\n SetCurrentPreset shall only be available for Video Sources with Imaging Presets Capability. \n Imaging Presets are defined by the Manufacturer, and offered as a tool to simplify Imaging Settings adjustments for specific scene content.\n 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." + operationId: SetCurrentPreset + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetCurrentPresetRequest' + - xml: + name: SetCurrentPresetRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetCurrentPresetResponse' + - xml: + name: SetCurrentPresetResponse + attribute: false + wrapped: false + deprecated: false +components: + schemas: + tns_GetServiceCapabilities: + title: tns_GetServiceCapabilities + type: object + description: '' + xml: + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetServiceCapabilitiesResponse: + title: tns_GetServiceCapabilitiesResponse + required: + - Capabilities + type: object + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities' + - description: The capabilities for the imaging service is returned in the Capabilities element. + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Capabilities: + title: tns_Capabilities + type: object + properties: + ImageStabilization: + type: boolean + description: >- + Indicates whether or not Image Stabilization feature is supported. + The use of this capability is deprecated, a client should use GetOption to find out if image stabilization is supported. + xml: + name: ImageStabilization + prefix: tns + attribute: true + wrapped: false + Presets: + type: boolean + description: Indicates whether or not Imaging Presets feature is supported. + xml: + name: Presets + prefix: tns + attribute: true + wrapped: false + AdaptablePreset: + type: boolean + description: Indicates whether or not imaging preset settings can be updated. + xml: + name: AdaptablePreset + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetImagingSettings: + title: tns_GetImagingSettings + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource for which the ImagingSettings. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetImagingSettings + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetImagingSettingsResponse: + title: tns_GetImagingSettingsResponse + required: + - ImagingSettings + type: object + properties: + ImagingSettings: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: ImagingSettings for the VideoSource that was requested. + xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetImagingSettingsResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetImagingSettings: + title: tns_SetImagingSettings + required: + - VideoSourceToken + - ImagingSettings + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + ImagingSettings: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetImagingSettings + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetImagingSettingsResponse: + title: tns_SetImagingSettingsResponse + type: object + description: '' + xml: + name: SetImagingSettingsResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOptions: + title: tns_GetOptions + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource for which the imaging parameter options are requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOptions + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOptionsResponse: + title: tns_GetOptionsResponse + required: + - ImagingOptions + type: object + properties: + ImagingOptions: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20' + - description: Valid ranges for the imaging parameters that are categorized as device specific. + xml: + name: ImagingOptions + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOptionsResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Move: + title: tns_Move + required: + - VideoSourceToken + - Focus + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference to the VideoSource for the requested move (focus) operation. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusMove' + - description: Content of the requested move (focus) operation. + xml: + name: Focus + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Move + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MoveResponse: + title: tns_MoveResponse + type: object + description: '' + xml: + name: MoveResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMoveOptions: + title: tns_GetMoveOptions + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource for the requested move options. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMoveOptions + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMoveOptionsResponse: + title: tns_GetMoveOptionsResponse + required: + - MoveOptions + type: object + properties: + MoveOptions: + allOf: + - $ref: '#/components/schemas/tt_MoveOptions20' + - description: Valid ranges for the focus lens move options. + xml: + name: MoveOptions + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMoveOptionsResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Stop: + title: tns_Stop + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource where the focus movement should be stopped. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Stop + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StopResponse: + title: tns_StopResponse + type: object + description: '' + xml: + name: StopResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStatus: + title: tns_GetStatus + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource where the imaging status should be requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStatus + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStatusResponse: + title: tns_GetStatusResponse + required: + - Status + type: object + properties: + Status: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20' + - description: Requested imaging status. + xml: + name: Status + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStatusResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ImagingPresetType: + title: tns_ImagingPresetType + enum: + - Custom + - ClearWeather + - Cloudy + - Fog + - Rain + - Snowing + - Snow + - WDR + - Shade + - Night + - Indoor + - Fluorescent + - Incandescent + - Sodium(Natrium) + - Sunrise(Horizon) + - Sunset(Rear) + - ExtremeHot + - ExtremeCold + - Underwater + - CloseUp + - Motion + - FlickerFree50 + - FlickerFree60 + type: string + description: >- + Describes standard Imaging Preset types, used to facilitate Multi-language support and client display. + "Custom" Type shall be used when Imaging Preset Name does not match any of the types included in the standard classification. + xml: + name: ImagingPresetType + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ImagingPreset: + title: tns_ImagingPreset + required: + - token + - type + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of this Imaging Preset. + xml: + name: token + prefix: tns + attribute: true + wrapped: false + type: + type: string + description: "Indicates Imaging Preset Type. Use timg:ImagingPresetType. \n Used for multi-language support and display." + xml: + name: type + prefix: tns + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: Human readable name of the Imaging Preset. + xml: + name: Name + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: Type describing the Imaging Preset settings. + xml: + name: ImagingPreset + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresets: + title: tns_GetPresets + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: A reference to the VideoSource where the operation should take place. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresets + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetsResponse: + title: tns_GetPresetsResponse + required: + - Preset + type: object + properties: + Preset: + type: array + items: + $ref: '#/components/schemas/tns_ImagingPreset' + description: List of Imaging Presets which are available for the requested VideoSource. + xml: + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetsResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCurrentPreset: + title: tns_GetCurrentPreset + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource where the current Imaging Preset should be requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentPreset + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCurrentPresetResponse: + title: tns_GetCurrentPresetResponse + type: object + properties: + Preset: + allOf: + - $ref: '#/components/schemas/tns_ImagingPreset' + - description: Current Imaging Preset in use for the specified Video Source. + xml: + name: Preset + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentPresetResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetCurrentPreset: + title: tns_SetCurrentPreset + required: + - VideoSourceToken + - PresetToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Reference token to the VideoSource to which the specified Imaging Preset should be applied. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + PresetToken: + maxLength: 64 + type: string + description: Reference token to the Imaging Preset to be applied to the specified Video Source. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetCurrentPreset + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetCurrentPresetResponse: + title: tns_SetCurrentPresetResponse + type: object + description: '' + xml: + name: SetCurrentPresetResponse + namespace: http://www.onvif.org/ver20/imaging/wsdl + prefix: tns + attribute: false + wrapped: false + tt_IntRange: + title: tt_IntRange + required: + - Min + - Max + type: object + properties: + Min: + type: integer + format: int32 + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: integer + format: int32 + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: IntRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector2D: + title: tt_Vector2D + required: + - x + - y + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Pan/tilt coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector2D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector1D: + title: tt_Vector1D + required: + - x + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Zoom coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector1D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZVector: + title: tt_PTZVector + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan and the y component to tilt. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom position. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZVector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatus: + title: tt_PTZStatus + required: + - UtcTime + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - 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. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: States a current PTZ error. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UtcTime: + type: string + description: Specifies the UTC time when this status was generated. + format: date-time + xml: + name: UtcTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZMoveStatus: + title: tt_PTZMoveStatus + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZMoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveStatus: + title: tt_MoveStatus + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + description: '' + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector: + title: tt_Vector + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rectangle: + title: tt_Rectangle + type: object + properties: + bottom: + type: number + xml: + name: bottom + prefix: tt + attribute: true + wrapped: false + top: + type: number + xml: + name: top + prefix: tt + attribute: true + wrapped: false + right: + type: number + xml: + name: right + prefix: tt + attribute: true + wrapped: false + left: + type: number + xml: + name: left + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Rectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polygon: + title: tt_Polygon + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polygon + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Color: + title: tt_Color + required: + - X + - Y + - Z + type: object + properties: + X: + type: number + xml: + name: X + prefix: tt + attribute: true + wrapped: false + Y: + type: number + xml: + name: Y + prefix: tt + attribute: true + wrapped: false + Z: + type: number + xml: + name: Z + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: 'Acceptable values:' + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorCovariance: + title: tt_ColorCovariance + required: + - XX + - YY + - ZZ + type: object + properties: + XX: + type: number + xml: + name: XX + prefix: tt + attribute: true + wrapped: false + YY: + type: number + xml: + name: YY + prefix: tt + attribute: true + wrapped: false + ZZ: + type: number + xml: + name: ZZ + prefix: tt + attribute: true + wrapped: false + XY: + type: number + xml: + name: XY + prefix: tt + attribute: true + wrapped: false + XZ: + type: number + xml: + name: XZ + prefix: tt + attribute: true + wrapped: false + YZ: + type: number + xml: + name: YZ + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: ColorCovariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorDescriptor: + title: tt_ColorDescriptor + type: object + properties: + ColorCluster: + type: array + items: + $ref: '#/components/schemas/tt_ColorCluster' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transformation: + title: tt_Transformation + type: object + properties: + Translate: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Translate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Scale: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Scale + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TransformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransformationExtension: + title: tt_TransformationExtension + type: object + description: '' + xml: + name: TransformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoLocation: + title: tt_GeoLocation + type: object + properties: + lon: + type: number + description: East west location as angle. + xml: + name: lon + prefix: tt + attribute: true + wrapped: false + lat: + type: number + description: North south location as angle. + xml: + name: lat + prefix: tt + attribute: true + wrapped: false + elevation: + type: number + description: Hight in meters above sea level. + xml: + name: elevation + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoOrientation: + title: tt_GeoOrientation + type: object + properties: + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + pitch: + type: number + description: Rotation around the y axis. + xml: + name: pitch + prefix: tt + attribute: true + wrapped: false + yaw: + type: number + description: Rotation around the z axis. + xml: + name: yaw + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalLocation: + title: tt_LocalLocation + type: object + properties: + x: + type: number + description: East west location as angle. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: North south location as angle. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + z: + type: number + description: Offset in meters from the sea level. + xml: + name: z + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalOrientation: + title: tt_LocalOrientation + type: object + properties: + pan: + type: number + description: Rotation around the y axis. + xml: + name: pan + prefix: tt + attribute: true + wrapped: false + tilt: + type: number + description: Rotation around the z axis. + xml: + name: tilt + prefix: tt + attribute: true + wrapped: false + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Entity: + title: tt_Entity + enum: + - Device + - VideoSource + - AudioSource + type: string + description: '' + xml: + name: Entity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocationEntity: + title: tt_LocationEntity + type: object + properties: + Entity: + type: string + description: Entity type the entry refers to, use a value from the tt:Entity enumeration. + xml: + name: Entity + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + description: Optional entity token. + xml: + name: Token + prefix: tt + attribute: true + wrapped: false + Fixed: + type: boolean + description: If this value is true the entity cannot be deleted. + xml: + name: Fixed + prefix: tt + attribute: true + wrapped: false + GeoSource: + type: string + description: Optional reference to the XAddr of another devices DeviceManagement service. + xml: + name: GeoSource + prefix: tt + attribute: true + wrapped: false + AutoGeo: + type: boolean + description: If set the geo location is obtained internally. + xml: + name: AutoGeo + prefix: tt + attribute: true + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: Location on earth. + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GeoOrientation: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Orientation relative to earth. + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalLocation: + allOf: + - $ref: '#/components/schemas/tt_LocalLocation' + - description: Indoor location offset. + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalOrientation: + allOf: + - $ref: '#/components/schemas/tt_LocalOrientation' + - description: Indoor orientation offset. + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LocationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceEntity: + title: tt_DeviceEntity + required: + - token + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier referencing the physical entity. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + description: Base class for physical entities like inputs and outputs. + xml: + name: DeviceEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangle: + title: tt_IntRectangle + required: + - x + - y + - width + - height + type: object + properties: + x: + type: integer + format: int32 + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: integer + format: int32 + xml: + name: y + prefix: tt + attribute: true + wrapped: false + width: + type: integer + format: int32 + xml: + name: width + prefix: tt + attribute: true + wrapped: false + height: + type: integer + format: int32 + xml: + name: height + prefix: tt + attribute: true + wrapped: false + description: Rectangle defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangleRange: + title: tt_IntRectangleRange + required: + - XRange + - YRange + - WidthRange + - HeightRange + type: object + properties: + XRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of X-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of Y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WidthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of width. + xml: + name: WidthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HeightRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of height. + xml: + name: HeightRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangleRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatRange: + title: tt_FloatRange + required: + - Min + - Max + type: object + properties: + Min: + type: number + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: number + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: FloatRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DurationRange: + title: tt_DurationRange + required: + - Min + - Max + type: object + properties: + Min: + type: string + format: date-time + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: string + format: date-time + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of duration greater equal Min duration and less equal Max duration. + xml: + name: DurationRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntItems: + title: tt_IntItems + type: object + properties: + Items: + type: array + items: + type: integer + format: int32 + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: List of values. + xml: + name: IntItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatItems: + title: tt_FloatItems + type: object + properties: + Items: + type: array + items: + type: number + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FloatItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StringItems: + title: tt_StringItems + required: + - Item + type: object + properties: + Item: + type: array + items: + type: string + xml: + name: Item + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StringItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnyHolder: + title: tt_AnyHolder + type: object + description: '' + xml: + name: AnyHolder + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSource: + title: tt_VideoSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Framerate + - Resolution + type: object + properties: + Framerate: + type: number + description: Frame rate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Horizontal and vertical resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings' + - description: Optional configuration of the image sensor. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video input. + tt_VideoSourceExtension: + title: tt_VideoSourceExtension + type: object + properties: + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if imaging service 2.00 is supported. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceExtension2: + title: tt_VideoSourceExtension2 + type: object + description: '' + xml: + name: VideoSourceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSource: + title: tt_AudioSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Channels + type: object + properties: + Channels: + type: integer + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + xml: + name: Channels + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio input. + tt_Profile: + title: tt_Profile + required: + - token + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of the profile. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: A value of true signals that the profile cannot be deleted. Default is false. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and rule engine. + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + A media profile consists of a set of media configurations. Media profiles are used by a client + to configure properties of a media stream from an NVT. + xml: + name: Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension: + title: tt_ProfileExtension + type: object + properties: + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension2: + title: tt_ProfileExtension2 + type: object + description: '' + xml: + name: ProfileExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfiguration: + title: tt_VideoSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + - Bounds + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Reference to the physical input. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bounds: + allOf: + - $ref: '#/components/schemas/tt_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area. + xml: + name: Bounds + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ViewMode: + type: string + description: Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes. + xml: + name: ViewMode + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioSourceConfiguration: + title: tt_AudioSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Token of the Audio Source the configuration applies to + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncoderConfiguration: + title: tt_VideoEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Configuration' + - description: Optional element to configure H.264 related parameters. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related video stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoderConfiguration: + title: tt_AudioEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoAnalyticsConfiguration: + title: tt_VideoAnalyticsConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfiguration' + - xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZConfiguration: + title: tt_PTZConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - NodeToken + type: object + properties: + NodeToken: + maxLength: 64 + type: string + description: A mandatory reference to the PTZ Node that the PTZ Configuration belongs to. + xml: + name: NodeToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsolutePantTiltPositionSpace: + type: string + description: If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default. + xml: + name: DefaultAbsolutePantTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsoluteZoomPositionSpace: + type: string + description: If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default. + xml: + name: DefaultAbsoluteZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativePanTiltTranslationSpace: + type: string + description: If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default. + xml: + name: DefaultRelativePanTiltTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativeZoomTranslationSpace: + type: string + description: If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default. + xml: + name: DefaultRelativeZoomTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousPanTiltVelocitySpace: + type: string + description: If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default. + xml: + name: DefaultContinuousPanTiltVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousZoomVelocitySpace: + type: string + description: If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default. + xml: + name: DefaultContinuousZoomVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds. + xml: + name: DefaultPTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZTimeout: + type: string + description: If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops. + format: date-time + xml: + name: DefaultPTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/tt_PanTiltLimits' + - 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. + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomLimits: + allOf: + - $ref: '#/components/schemas/tt_ZoomLimits' + - 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. + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveRamp: + type: integer + description: The optional acceleration ramp used by the device when moving. + format: int32 + xml: + name: MoveRamp + prefix: tt + attribute: true + wrapped: false + PresetRamp: + type: integer + description: The optional acceleration ramp used by the device when recalling presets. + format: int32 + xml: + name: PresetRamp + prefix: tt + attribute: true + wrapped: false + PresetTourRamp: + type: integer + description: The optional acceleration ramp used by the device when executing PresetTours. + format: int32 + xml: + name: PresetTourRamp + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_MetadataConfiguration: + title: tt_MetadataConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Multicast + - SessionTimeout + type: object + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZFilter' + - description: optional element to configure which PTZ related data is to include in the metadata stream + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventSubscription' + - description: "Optional element to configure the streaming of events. A client might be interested in receiving all, \n none or some of the events produced by the device:" + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Analytics: + type: boolean + description: Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.) + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored) + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - description: >- + Indication which AnalyticsModules shall output metadata. + Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration. + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CompressionType: + type: string + description: Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType. + xml: + name: CompressionType + prefix: tt + attribute: true + wrapped: false + GeoLocation: + type: boolean + description: Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + ShapePolygon: + type: boolean + description: Optional parameter to configure if the generated metadata stream should contain shape information as polygon. + xml: + name: ShapePolygon + prefix: tt + attribute: true + wrapped: false + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioOutputConfiguration: + title: tt_AudioOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + - OutputLevel + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the phsycial Audio output. + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacy: + type: string + description: >- + An audio channel MAY support different types of audio transmission. While for full duplex + operation no special handling is required, in half duplex operation the transmission direction + needs to be switched. + The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which + direction is currently active. An NVC can switch between different modes by setting the + AudioOutputConfiguration. + xml: + name: SendPrimacy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevel: + type: integer + description: Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange. + format: int32 + xml: + name: OutputLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioDecoderConfiguration: + title: tt_AudioDecoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - type: object + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The Audio Decoder Configuration does not contain any that parameter to configure the + + decoding .A decoder shall decode every data it receives (according to its capabilities). + tt_ConfigurationEntity: + title: tt_ConfigurationEntity + required: + - token + - Name + - UseCount + type: object + properties: + token: + maxLength: 64 + type: string + description: Token that uniquely references this configuration. Length up to 64 characters. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name. Length up to 64 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseCount: + type: integer + description: Number of internal references currently using this configuration. + format: int32 + xml: + name: UseCount + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Base type defining the common properties of a configuration. + xml: + name: ConfigurationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension: + title: tt_VideoSourceConfigurationExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_Rotate' + - description: >- + Optional element to configure rotation of captured image. + What resolutions a device supports shall be unaffected by the Rotate parameters. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension2: + title: tt_VideoSourceConfigurationExtension2 + type: object + properties: + LensDescription: + type: array + items: + $ref: '#/components/schemas/tt_LensDescription' + description: Optional element describing the geometric lens distortion. Multiple instances for future variable lens support. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneOrientation: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientation' + - description: Optional element describing the scene orientation in the camera’s field of view. + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rotate: + title: tt_Rotate + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RotateMode' + - description: Parameter to enable/disable Rotation feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Degree: + type: integer + 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. + format: int32 + xml: + name: Degree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateExtension: + title: tt_RotateExtension + type: object + description: '' + xml: + name: RotateExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateMode: + title: tt_RotateMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: RotateMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensProjection: + title: tt_LensProjection + required: + - Angle + - Radius + type: object + properties: + Angle: + type: number + description: Angle of incidence. + xml: + name: Angle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Radius: + type: number + description: Mapping radius as a consequence of the emergent angle. + xml: + name: Radius + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transmittance: + type: number + description: Optional ray absorption at the given angle due to vignetting. A value of one means no absorption. + xml: + name: Transmittance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensProjection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensOffset: + title: tt_LensOffset + type: object + properties: + x: + type: number + description: Optional horizontal offset of the lens center in normalized coordinates. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: Optional vertical offset of the lens center in normalized coordinates. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LensOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensDescription: + title: tt_LensDescription + required: + - Offset + - Projection + - XFactor + type: object + properties: + FocalLength: + type: number + description: Optional focal length of the optical system. + xml: + name: FocalLength + prefix: tt + attribute: true + wrapped: false + Offset: + allOf: + - $ref: '#/components/schemas/tt_LensOffset' + - description: Offset of the lens center to the imager center in normalized coordinates. + xml: + name: Offset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Projection: + type: array + items: + $ref: '#/components/schemas/tt_LensProjection' + description: "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation \n over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. \n Items outside the last projection Radius shall be assumed to be invisible (black)." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XFactor: + type: number + description: Compensation of the x coordinate needed for the ONVIF normalized coordinate system. + xml: + name: XFactor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptions: + title: tt_VideoSourceConfigurationOptions + required: + - BoundsRange + - VideoSourceTokensAvailable + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tt + attribute: true + wrapped: false + BoundsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRectangleRange' + - description: >- + Supported range for the capturing area. + Device that does not support cropped streaming shall express BoundsRange option as mentioned below + BoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits. + xml: + name: BoundsRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: VideoSourceTokensAvailable + attribute: false + wrapped: false + description: List of physical inputs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension: + title: tt_VideoSourceConfigurationOptionsExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_RotateOptions' + - description: Options of parameters for Rotation feature. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension2: + title: tt_VideoSourceConfigurationOptionsExtension2 + type: object + properties: + SceneOrientationMode: + type: array + items: + $ref: '#/components/schemas/tt_SceneOrientationMode' + description: Scene orientation modes supported by the device for this configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptions: + title: tt_RotateOptions + required: + - Mode + type: object + properties: + Reboot: + type: boolean + description: >- + After setting the rotation, if a device starts to reboot this value is true. + If a device can handle rotation setting without rebooting this value is false. + xml: + name: Reboot + prefix: tt + attribute: true + wrapped: false + Mode: + type: array + items: + $ref: '#/components/schemas/tt_RotateMode' + description: Supported options of Rotate mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DegreeList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported degree value for rotation. + xml: + name: DegreeList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RotateOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptionsExtension: + title: tt_RotateOptionsExtension + type: object + description: '' + xml: + name: RotateOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationMode: + title: tt_SceneOrientationMode + enum: + - MANUAL + - AUTO + type: string + description: '' + xml: + name: SceneOrientationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationOption: + title: tt_SceneOrientationOption + enum: + - Below + - Horizon + - Above + type: string + description: Defines the acceptable values for the Orientation element of the SceneOrientation type + xml: + name: SceneOrientationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientation: + title: tt_SceneOrientation + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene orientation. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Orientation: + type: string + description: "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field \n is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required \n and the device will return an InvalidArgs fault if missing." + xml: + name: Orientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ViewModes: + title: tt_ViewModes + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + type: string + description: Source view modes supported by device. + xml: + name: ViewModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoding: + title: tt_VideoEncoding + enum: + - JPEG + - MPEG4 + - H264 + type: string + description: '' + xml: + name: VideoEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Profile: + title: tt_Mpeg4Profile + enum: + - SP + - ASP + type: string + description: '' + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Profile: + title: tt_H264Profile + enum: + - Baseline + - Main + - Extended + - High + type: string + description: '' + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoResolution: + title: tt_VideoResolution + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl: + title: tt_VideoRateControl + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + type: object + properties: + FrameRateLimit: + type: integer + description: Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor. + format: int32 + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingInterval: + type: integer + 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 ...) + format: int32 + xml: + name: EncodingInterval + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Configuration: + title: tt_Mpeg4Configuration + required: + - GovLength + - Mpeg4Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP) + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Configuration: + title: tt_H264Configuration + required: + - GovLength + - H264Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264Profile: + allOf: + - $ref: '#/components/schemas/tt_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderConfigurationOptions: + title: tt_VideoEncoderConfigurationOptions + required: + - QualityRange + type: object + properties: + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension element). + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension element). + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension element). + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension: + title: tt_VideoEncoderOptionsExtension + type: object + properties: + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options2' + - description: Optional H.264 encoder settings ranges. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension2: + title: tt_VideoEncoderOptionsExtension2 + type: object + description: '' + xml: + name: VideoEncoderOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions: + title: tt_JpegOptions + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions2: + title: tt_JpegOptions2 + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: JpegOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_Mpeg4Options: + title: tt_Mpeg4Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported MPEG-4 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Options2: + title: tt_Mpeg4Options2 + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Mpeg4Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_H264Options: + title: tt_H264Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H.264 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Options2: + title: tt_H264Options2 + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: H264Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncodingMimeNames: + title: tt_VideoEncodingMimeNames + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + type: string + description: Video Media Subtypes as referenced by IANA (without the leading "video/" Video Media Type). See also + xml: + name: VideoEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncodingProfiles: + title: tt_VideoEncodingProfiles + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + type: string + description: '' + xml: + name: VideoEncodingProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2Configuration: + title: tt_VideoEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + type: object + properties: + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution2' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + prefix: tt + attribute: true + wrapped: false + Profile: + type: string + description: The encoder profile as defined in tt:VideoEncodingProfiles. + xml: + name: Profile + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoResolution2: + title: tt_VideoResolution2 + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl2: + title: tt_VideoRateControl2 + required: + - FrameRateLimit + - BitrateLimit + type: object + properties: + ConstantBitRate: + type: boolean + description: Enforce constant bitrate. + xml: + name: ConstantBitRate + prefix: tt + attribute: true + wrapped: false + FrameRateLimit: + type: number + description: Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations. + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2ConfigurationOptions: + title: tt_VideoEncoder2ConfigurationOptions + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + type: object + properties: + GovLengthRange: + type: integer + 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. + format: int32 + xml: + name: GovLengthRange + prefix: tt + attribute: true + wrapped: false + FrameRatesSupported: + type: number + description: List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first. + xml: + name: FrameRatesSupported + prefix: tt + attribute: true + wrapped: false + ProfilesSupported: + type: string + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + xml: + name: ProfilesSupported + prefix: tt + attribute: true + wrapped: false + ConstantBitRateSupported: + type: boolean + description: Signal whether enforcing constant bitrate is supported. + xml: + name: ConstantBitRateSupported + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution2' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceConfigurationOptions: + title: tt_AudioSourceConfigurationOptions + required: + - InputTokensAvailable + type: object + properties: + InputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the audio source the configuration can be used for. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceOptionsExtension: + title: tt_AudioSourceOptionsExtension + type: object + description: '' + xml: + name: AudioSourceOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoding: + title: tt_AudioEncoding + enum: + - G711 + - G726 + - AAC + type: string + description: '' + xml: + name: AudioEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOptions: + title: tt_AudioEncoderConfigurationOptions + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfigurationOption' + description: list of supported AudioEncoderConfigurations + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOption: + title: tt_AudioEncoderConfigurationOption + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncodingMimeNames: + title: tt_AudioEncodingMimeNames + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + type: string + description: Audio Media Subtypes as referenced by IANA (without the leading "audio/" Audio Media Type and except for the audio types defined in the restriction). See also + xml: + name: AudioEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoder2Configuration: + title: tt_AudioEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoder2ConfigurationOptions: + title: tt_AudioEncoder2ConfigurationOptions + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationExtension: + title: tt_MetadataConfigurationExtension + type: object + description: '' + xml: + name: MetadataConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZFilter: + title: tt_PTZFilter + required: + - Status + - Position + type: object + properties: + Status: + type: boolean + description: True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN) + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + type: boolean + description: True if the metadata stream shall contain the PTZ position + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventSubscription: + title: tt_EventSubscription + type: object + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Subcription handling in the same way as base notification subscription. + xml: + name: EventSubscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptions: + title: tt_MetadataConfigurationOptions + required: + - PTZStatusFilterOptions + type: object + properties: + GeoLocation: + type: boolean + description: True if the device is able to stream the Geo Located positions of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + MaxContentFilterSize: + type: integer + description: A device signalling support for content filtering shall support expressions with the provided expression size. + format: int32 + xml: + name: MaxContentFilterSize + prefix: tt + attribute: true + wrapped: false + PTZStatusFilterOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptions' + - xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension: + title: tt_MetadataConfigurationOptionsExtension + type: object + properties: + CompressionType: + type: array + items: + type: string + xml: + name: CompressionType + attribute: false + wrapped: false + description: List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension2: + title: tt_MetadataConfigurationOptionsExtension2 + type: object + description: '' + xml: + name: MetadataConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataCompressionType: + title: tt_MetadataCompressionType + enum: + - None + - GZIP + - EXI + type: string + description: '' + xml: + name: MetadataCompressionType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptions: + title: tt_PTZStatusFilterOptions + required: + - PanTiltStatusSupported + - ZoomStatusSupported + type: object + properties: + PanTiltStatusSupported: + type: boolean + description: True if the device is able to stream pan or tilt status information. + xml: + name: PanTiltStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomStatusSupported: + type: boolean + description: True if the device is able to stream zoom status inforamtion. + xml: + name: ZoomStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSupported: + type: boolean + description: True if the device is able to stream the pan or tilt position. + xml: + name: PanTiltPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSupported: + type: boolean + description: True if the device is able to stream zoom position information. + xml: + name: ZoomPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptionsExtension: + title: tt_PTZStatusFilterOptionsExtension + type: object + description: '' + xml: + name: PTZStatusFilterOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutput: + title: tt_VideoOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Layout + type: object + properties: + Layout: + allOf: + - $ref: '#/components/schemas/tt_Layout' + - xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Resolution of the display in Pixel. + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RefreshRate: + type: number + description: Refresh rate of the display in Hertz. + xml: + name: RefreshRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AspectRatio: + type: number + description: Aspect ratio of the display as physical extent of width divided by height. + xml: + name: AspectRatio + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoOutputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video outputs. + tt_VideoOutputExtension: + title: tt_VideoOutputExtension + type: object + description: '' + xml: + name: VideoOutputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutputConfiguration: + title: tt_VideoOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the Video Output the configuration applies to + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoOutputConfigurationOptions: + title: tt_VideoOutputConfigurationOptions + type: object + description: '' + xml: + name: VideoOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptions: + title: tt_VideoDecoderConfigurationOptions + type: object + properties: + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/tt_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element describes the supported codecs and configurations + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264DecOptions: + allOf: + - $ref: '#/components/schemas/tt_H264DecOptions' + - description: If the device is able to decode H.264 streams this element describes the supported codecs and configurations + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264DecOptions: + title: tt_H264DecOptions + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported H.264 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedH264Profiles: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H264 Profiles (either baseline, main, extended or high) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegDecOptions: + title: tt_JpegDecOptions + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Jpeg Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4DecOptions: + title: tt_Mpeg4DecOptions + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Mpeg4 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedMpeg4Profiles: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported Mpeg4 Profiles (either SP or ASP) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptionsExtension: + title: tt_VideoDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: VideoDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioOutput: + title: tt_AudioOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + xml: + name: AudioOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio outputs. + tt_AudioOutputConfigurationOptions: + title: tt_AudioOutputConfigurationOptions + required: + - OutputTokensAvailable + - OutputLevelRange + type: object + properties: + OutputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: OutputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the physical Audio outputs (typically one). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacyOptions: + type: array + items: + type: string + xml: + name: SendPrimacyOptions + attribute: false + wrapped: false + description: An + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Minimum and maximum level range supported for this Output. + xml: + name: OutputLevelRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptions: + title: tt_AudioDecoderConfigurationOptions + type: object + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/tt_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section describes the supported configurations + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G711DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section describes the supported configurations + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G726DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section describes the supported configurations + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G711DecOptions: + title: tt_G711DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AACDecOptions: + title: tt_AACDecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G726DecOptions: + title: tt_G726DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptionsExtension: + title: tt_AudioDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: AudioDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MulticastConfiguration: + title: tt_MulticastConfiguration + required: + - Address + - Port + - TTL + - AutoStart + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/tt_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast streaming is enaled) + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: integer + description: The RTP mutlicast 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. + format: int32 + xml: + name: Port + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: integer + 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. + format: int32 + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Read only property signalling that streaming is persistant. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MulticastConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamSetup: + title: tt_StreamSetup + required: + - Stream + - Transport + type: object + properties: + Stream: + allOf: + - $ref: '#/components/schemas/tt_StreamType' + - description: Defines if a multicast or unicast stream is requested + xml: + name: Stream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transport: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamType: + title: tt_StreamType + enum: + - RTP-Unicast + - RTP-Multicast + type: string + description: '' + xml: + name: StreamType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transport: + title: tt_Transport + required: + - Protocol + type: object + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/tt_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + xml: + name: Protocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tunnel: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - description: Optional element to describe further tunnel options. This element is normally not needed + xml: + name: Tunnel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransportProtocol: + title: tt_TransportProtocol + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + description: '' + xml: + name: TransportProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaUri: + title: tt_MediaUri + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting the media stream + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterConnect: + type: boolean + description: Indicates if the Uri is only valid until the connection is established. The value shall be set to "false". + xml: + name: InvalidAfterConnect + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterReboot: + type: boolean + description: Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false". + xml: + name: InvalidAfterReboot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Timeout: + type: string + 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 + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ScopeDefinition: + title: tt_ScopeDefinition + enum: + - Fixed + - Configurable + type: string + description: '' + xml: + name: ScopeDefinition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Scope: + title: tt_Scope + required: + - ScopeDef + - ScopeItem + type: object + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/tt_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + xml: + name: ScopeDef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScopeItem: + type: string + description: Scope item URI. + xml: + name: ScopeItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Scope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DiscoveryMode: + title: tt_DiscoveryMode + enum: + - Discoverable + - NonDiscoverable + type: string + description: '' + xml: + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterface: + title: tt_NetworkInterface + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Info: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceInfo' + - description: Network interface information + xml: + name: Info + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceLink' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_NetworkInterfaceExtension: + title: tt_NetworkInterfaceExtension + required: + - InterfaceType + type: object + properties: + InterfaceType: + type: integer + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: Extension point prepared for future 802.3 configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot3Configuration: + title: tt_Dot3Configuration + type: object + description: '' + xml: + name: Dot3Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceExtension2: + title: tt_NetworkInterfaceExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceLink: + title: tt_NetworkInterfaceLink + required: + - AdminSettings + - OperSettings + - InterfaceType + type: object + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + xml: + name: AdminSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OperSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + xml: + name: OperSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InterfaceType: + type: integer + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceLink + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceConnectionSetting: + title: tt_NetworkInterfaceConnectionSetting + required: + - AutoNegotiation + - Speed + - Duplex + type: object + properties: + AutoNegotiation: + type: boolean + description: Auto negotiation on/off. + xml: + name: AutoNegotiation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: integer + description: Speed. + format: int32 + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Duplex: + allOf: + - $ref: '#/components/schemas/tt_Duplex' + - description: Duplex type, Half or Full. + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceConnectionSetting + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Duplex: + title: tt_Duplex + enum: + - Full + - Half + type: string + description: '' + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceInfo: + title: tt_NetworkInterfaceInfo + required: + - HwAddress + type: object + properties: + Name: + type: string + description: Network interface name, for example eth0. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HwAddress: + type: string + description: Network interface MAC address. + xml: + name: HwAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterface: + title: tt_IPv6NetworkInterface + required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv6Configuration' + - description: IPv6 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterface: + title: tt_IPv4NetworkInterface + required: + - Enabled + - Config + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv4Configuration' + - description: IPv4 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4Configuration: + title: tt_IPv4Configuration + required: + - DHCP + type: object + properties: + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: Link local address. + xml: + name: LinkLocal + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6Configuration: + title: tt_IPv6Configuration + required: + - DHCP + type: object + properties: + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually entered IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of link local IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromRA: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using router advertisment. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPv6ConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6ConfigurationExtension: + title: tt_IPv6ConfigurationExtension + type: object + description: '' + xml: + name: IPv6ConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6DHCPConfiguration: + title: tt_IPv6DHCPConfiguration + enum: + - Auto + - Stateful + - Stateless + - Off + type: string + description: '' + xml: + name: IPv6DHCPConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocol: + title: tt_NetworkProtocol + required: + - Name + - Enabled + - Port + type: object + properties: + Name: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolType' + - description: Network protocol type string. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates if the protocol is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: array + items: + type: integer + format: int32 + xml: + name: Port + attribute: false + wrapped: false + description: The port that is used by the protocol. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolExtension: + title: tt_NetworkProtocolExtension + type: object + description: '' + xml: + name: NetworkProtocolExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolType: + title: tt_NetworkProtocolType + enum: + - HTTP + - HTTPS + - RTSP + type: string + description: '' + xml: + name: NetworkProtocolType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostType: + title: tt_NetworkHostType + enum: + - IPv4 + - IPv6 + - DNS + type: string + description: '' + xml: + name: NetworkHostType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHost: + title: tt_NetworkHost + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address. + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSname: + type: string + description: DNS name. + xml: + name: DNSname + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkHost + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostExtension: + title: tt_NetworkHostExtension + type: object + description: '' + xml: + name: NetworkHostExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddress: + title: tt_IPAddress + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv4Address: + title: tt_PrefixedIPv4Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv4 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv6Address: + title: tt_PrefixedIPv6Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv6 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPType: + title: tt_IPType + enum: + - IPv4 + - IPv6 + type: string + description: '' + xml: + name: IPType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformation: + title: tt_HostnameInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether the hostname is obtained from DHCP or not. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: Indicates the hostname. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: HostnameInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformationExtension: + title: tt_HostnameInformationExtension + type: object + description: '' + xml: + name: HostnameInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformation: + title: tt_DNSInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether or not DNS information is retrieved from DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SearchDomain: + type: array + items: + type: string + xml: + name: SearchDomain + attribute: false + wrapped: false + description: Search domain. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of DNS addresses received from DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSManual: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of manually entered DNS addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformationExtension: + title: tt_DNSInformationExtension + type: object + description: '' + xml: + name: DNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformation: + title: tt_NTPInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates if NTP information is to be retrieved by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of NTP addresses retrieved by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPManual: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of manually entered NTP addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NTPInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NTPInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformationExtension: + title: tt_NTPInformationExtension + type: object + description: '' + xml: + name: NTPInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterType: + title: tt_IPAddressFilterType + enum: + - Allow + - Deny + type: string + description: '' + xml: + name: IPAddressFilterType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformation: + title: tt_DynamicDNSInformation + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: DNS name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: string + description: Time to live. + format: date-time + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformationExtension: + title: tt_DynamicDNSInformationExtension + type: object + description: '' + xml: + name: DynamicDNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSType: + title: tt_DynamicDNSType + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + type: string + description: '' + xml: + name: DynamicDNSType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfiguration: + title: tt_NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension: + title: tt_NetworkInterfaceSetConfigurationExtension + type: object + properties: + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterfaceSetConfiguration: + title: tt_IPv6NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually added IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterfaceSetConfiguration: + title: tt_IPv4NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkGateway: + title: tt_NetworkGateway + type: object + properties: + IPv4Address: + type: array + items: + type: string + xml: + name: IPv4Address + attribute: false + wrapped: false + description: IPv4 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + type: string + xml: + name: IPv6Address + attribute: false + wrapped: false + description: IPv6 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkGateway + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfiguration: + title: tt_NetworkZeroConfiguration + required: + - InterfaceToken + - Enabled + type: object + properties: + InterfaceToken: + maxLength: 64 + type: string + description: Unique identifier of network interface. + xml: + name: InterfaceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates whether the zero-configuration is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Addresses: + type: array + items: + type: string + xml: + name: Addresses + attribute: false + wrapped: false + description: The zero-configuration IPv4 address(es) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension: + title: tt_NetworkZeroConfigurationExtension + type: object + properties: + Additional: + type: array + items: + $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + description: Optional array holding the configuration for the second and possibly further interfaces. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension2: + title: tt_NetworkZeroConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkZeroConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilter: + title: tt_IPAddressFilter + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterExtension: + title: tt_IPAddressFilterExtension + type: object + description: '' + xml: + name: IPAddressFilterExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Configuration: + title: tt_Dot11Configuration + required: + - SSID + - Mode + - Alias + - Priority + - Security + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11StationMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Alias: + maxLength: 64 + type: string + xml: + name: Alias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + maximum: 31 + minimum: 0 + type: integer + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfiguration' + - xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11StationMode: + title: tt_Dot11StationMode + enum: + - Ad-hoc + - Infrastructure + - Extended + type: string + description: '' + xml: + name: Dot11StationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfiguration: + title: tt_Dot11SecurityConfiguration + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Algorithm: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: Algorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PSK: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSet' + - xml: + name: PSK + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot1X: + maxLength: 64 + type: string + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11SecurityConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfigurationExtension: + title: tt_Dot11SecurityConfigurationExtension + type: object + description: '' + xml: + name: Dot11SecurityConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityMode: + title: tt_Dot11SecurityMode + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + type: string + description: '' + xml: + name: Dot11SecurityMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Cipher: + title: tt_Dot11Cipher + enum: + - CCMP + - TKIP + - Any + - Extended + type: string + description: '' + xml: + name: Dot11Cipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSet: + title: tt_Dot11PSKSet + type: object + properties: + Key: + type: string + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex + format: binary + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Passphrase: + pattern: '[ -~]{8,63}' + type: string + description: >- + According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and + each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. + xml: + name: Passphrase + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSetExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11PSKSet + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSetExtension: + title: tt_Dot11PSKSetExtension + type: object + description: '' + xml: + name: Dot11PSKSetExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension2: + title: tt_NetworkInterfaceSetConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Capabilities: + title: tt_Dot11Capabilities + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + type: object + properties: + TKIP: + type: boolean + xml: + name: TKIP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScanAvailableNetworks: + type: boolean + xml: + name: ScanAvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MultipleConfiguration: + type: boolean + xml: + name: MultipleConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AdHocStationMode: + type: boolean + xml: + name: AdHocStationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WEP: + type: boolean + xml: + name: WEP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SignalStrength: + title: tt_Dot11SignalStrength + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + type: string + description: '' + xml: + name: Dot11SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Status: + title: tt_Dot11Status + required: + - SSID + - ActiveConfigAlias + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: PairCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: GroupCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ActiveConfigAlias: + maxLength: 64 + type: string + xml: + name: ActiveConfigAlias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AuthAndMangementSuite: + title: tt_Dot11AuthAndMangementSuite + enum: + - None + - Dot1X + - PSK + - Extended + type: string + description: '' + xml: + name: Dot11AuthAndMangementSuite + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworks: + title: tt_Dot11AvailableNetworks + required: + - SSID + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuthAndMangementSuite: + type: array + items: + $ref: '#/components/schemas/tt_Dot11AuthAndMangementSuite' + description: See IEEE802.11 7.3.2.25.2 for details. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11AvailableNetworksExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11AvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworksExtension: + title: tt_Dot11AvailableNetworksExtension + type: object + description: '' + xml: + name: Dot11AvailableNetworksExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilityCategory: + title: tt_CapabilityCategory + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + type: string + description: '' + xml: + name: CapabilityCategory + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Capabilities: + title: tt_Capabilities + type: object + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsCapabilities' + - description: Analytics capabilities + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Device: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilities' + - description: Device capabilities + xml: + name: Device + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventCapabilities' + - description: Event capabilities + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingCapabilities' + - description: Imaging capabilities + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Media: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilities' + - description: Media capabilities + xml: + name: Media + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZCapabilities' + - description: PTZ capabilities + xml: + name: PTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension: + title: tt_CapabilitiesExtension + type: object + properties: + DeviceIO: + allOf: + - $ref: '#/components/schemas/tt_DeviceIOCapabilities' + - xml: + name: DeviceIO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Display: + allOf: + - $ref: '#/components/schemas/tt_DisplayCapabilities' + - xml: + name: Display + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Recording: + allOf: + - $ref: '#/components/schemas/tt_RecordingCapabilities' + - xml: + name: Recording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Search: + allOf: + - $ref: '#/components/schemas/tt_SearchCapabilities' + - xml: + name: Search + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Replay: + allOf: + - $ref: '#/components/schemas/tt_ReplayCapabilities' + - xml: + name: Replay + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tt_ReceiverCapabilities' + - xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsDevice: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceCapabilities' + - xml: + name: AnalyticsDevice + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extensions: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension2' + - xml: + name: Extensions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension2: + title: tt_CapabilitiesExtension2 + type: object + description: '' + xml: + name: CapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsCapabilities: + title: tt_AnalyticsCapabilities + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + type: object + properties: + XAddr: + type: string + description: Analytics service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Indicates whether or not rules are supported. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleSupport: + type: boolean + description: Indicates whether or not modules are supported. + xml: + name: AnalyticsModuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilities: + title: tt_DeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Device service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilities' + - description: Network capabilities. + xml: + name: Network + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilities' + - description: System capabilities. + xml: + name: System + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IO: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilities' + - description: I/O capabilities. + xml: + name: IO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilities' + - description: Security capabilities. + xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilitiesExtension: + title: tt_DeviceCapabilitiesExtension + type: object + description: '' + xml: + name: DeviceCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventCapabilities: + title: tt_EventCapabilities + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + type: object + properties: + XAddr: + type: string + description: Event service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSSubscriptionPolicySupport: + type: boolean + description: Indicates whether or not WS Subscription policy is supported. + xml: + name: WSSubscriptionPolicySupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPullPointSupport: + type: boolean + description: Indicates whether or not WS Pull Point is supported. + xml: + name: WSPullPointSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPausableSubscriptionManagerInterfaceSupport: + type: boolean + description: Indicates whether or not WS Pausable Subscription Manager Interface is supported. + xml: + name: WSPausableSubscriptionManagerInterfaceSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EventCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilities: + title: tt_IOCapabilities + type: object + properties: + InputConnectors: + type: integer + description: Number of input connectors. + format: int32 + xml: + name: InputConnectors + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + description: Number of relay outputs. + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension: + title: tt_IOCapabilitiesExtension + required: + - Extension + type: object + properties: + Auxiliary: + type: boolean + xml: + name: Auxiliary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension2: + title: tt_IOCapabilitiesExtension2 + type: object + description: '' + xml: + name: IOCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilities: + title: tt_MediaCapabilities + required: + - XAddr + - StreamingCapabilities + type: object + properties: + XAddr: + type: string + description: Media service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilitiesExtension: + title: tt_MediaCapabilitiesExtension + required: + - ProfileCapabilities + type: object + properties: + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tt_ProfileCapabilities' + - xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilities: + title: tt_RealTimeStreamingCapabilities + type: object + properties: + RTPMulticast: + type: boolean + description: Indicates whether or not RTP multicast is supported. + xml: + name: RTPMulticast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether or not RTP over TCP is supported. + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether or not RTP/RTSP/TCP is supported. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RealTimeStreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilitiesExtension: + title: tt_RealTimeStreamingCapabilitiesExtension + type: object + description: '' + xml: + name: RealTimeStreamingCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileCapabilities: + title: tt_ProfileCapabilities + required: + - MaximumNumberOfProfiles + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilities: + title: tt_NetworkCapabilities + type: object + properties: + IPFilter: + type: boolean + description: Indicates whether or not IP filtering is supported. + xml: + name: IPFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZeroConfiguration: + type: boolean + description: Indicates whether or not zeroconf is supported. + xml: + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPVersion6: + type: boolean + description: Indicates whether or not IPv6 is supported. + xml: + name: IPVersion6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynDNS: + type: boolean + description: Indicates whether or not is supported. + xml: + name: DynDNS + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension: + title: tt_NetworkCapabilitiesExtension + type: object + properties: + Dot11Configuration: + type: boolean + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension2: + title: tt_NetworkCapabilitiesExtension2 + type: object + description: '' + xml: + name: NetworkCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilities: + title: tt_SecurityCapabilities + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + type: object + properties: + TLS1.1: + type: boolean + description: Indicates whether or not TLS 1.1 is supported. + xml: + name: TLS1.1 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TLS1.2: + type: boolean + description: Indicates whether or not TLS 1.2 is supported. + xml: + name: TLS1.2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OnboardKeyGeneration: + type: boolean + description: Indicates whether or not onboard key generation is supported. + xml: + name: OnboardKeyGeneration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AccessPolicyConfig: + type: boolean + description: Indicates whether or not access policy configuration is supported. + xml: + name: AccessPolicyConfig + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + X.509Token: + type: boolean + description: Indicates whether or not WS-Security X.509 token is supported. + xml: + name: X.509Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SAMLToken: + type: boolean + description: Indicates whether or not WS-Security SAML token is supported. + xml: + name: SAMLToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KerberosToken: + type: boolean + description: Indicates whether or not WS-Security Kerberos token is supported. + xml: + name: KerberosToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RELToken: + type: boolean + description: Indicates whether or not WS-Security REL token is supported. + xml: + name: RELToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension: + title: tt_SecurityCapabilitiesExtension + required: + - TLS1.0 + type: object + properties: + TLS1.0: + type: boolean + xml: + name: TLS1.0 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension2: + title: tt_SecurityCapabilitiesExtension2 + required: + - Dot1X + - RemoteUserHandling + type: object + properties: + Dot1X: + type: boolean + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedEAPMethod: + type: array + items: + type: integer + format: int32 + xml: + name: SupportedEAPMethod + attribute: false + wrapped: false + description: EAP Methods supported by the device. The int values refer to the + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteUserHandling: + type: boolean + xml: + name: RemoteUserHandling + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilities: + title: tt_SystemCapabilities + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + type: object + properties: + DiscoveryResolve: + type: boolean + description: Indicates whether or not WS Discovery resolve requests are supported. + xml: + name: DiscoveryResolve + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DiscoveryBye: + type: boolean + description: Indicates whether or not WS-Discovery Bye is supported. + xml: + name: DiscoveryBye + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteDiscovery: + type: boolean + description: Indicates whether or not remote discovery is supported. + xml: + name: RemoteDiscovery + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemBackup: + type: boolean + description: Indicates whether or not system backup is supported. + xml: + name: SystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemLogging: + type: boolean + description: Indicates whether or not system logging is supported. + xml: + name: SystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FirmwareUpgrade: + type: boolean + description: Indicates whether or not firmware upgrade is supported. + xml: + name: FirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedVersions: + type: array + items: + $ref: '#/components/schemas/tt_OnvifVersion' + description: Indicates supported ONVIF version(s). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension: + title: tt_SystemCapabilitiesExtension + type: object + properties: + HttpFirmwareUpgrade: + type: boolean + xml: + name: HttpFirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemBackup: + type: boolean + xml: + name: HttpSystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemLogging: + type: boolean + xml: + name: HttpSystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSupportInformation: + type: boolean + xml: + name: HttpSupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension2: + title: tt_SystemCapabilitiesExtension2 + type: object + description: '' + xml: + name: SystemCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OnvifVersion: + title: tt_OnvifVersion + required: + - Major + - Minor + type: object + properties: + Major: + type: integer + description: Major version number. + format: int32 + xml: + name: Major + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minor: + type: integer + description: >- + Two digit minor version number. + If 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. + Otherwise, minor number is month of release, such as "06" for June. + format: int32 + xml: + name: Minor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OnvifVersion + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingCapabilities: + title: tt_ImagingCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Imaging service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZCapabilities: + title: tt_PTZCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: PTZ service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceIOCapabilities: + title: tt_DeviceIOCapabilities + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSources: + type: integer + format: int32 + xml: + name: VideoSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoOutputs: + type: integer + format: int32 + xml: + name: VideoOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSources: + type: integer + format: int32 + xml: + name: AudioSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputs: + type: integer + format: int32 + xml: + name: AudioOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceIOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DisplayCapabilities: + title: tt_DisplayCapabilities + required: + - XAddr + - FixedLayout + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedLayout: + type: boolean + description: Indication that the SetLayout command supports only predefined layouts. + xml: + name: FixedLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DisplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingCapabilities: + title: tt_RecordingCapabilities + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverSource: + type: boolean + xml: + name: ReceiverSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaProfileSource: + type: boolean + xml: + name: MediaProfileSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicRecordings: + type: boolean + xml: + name: DynamicRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicTracks: + type: boolean + xml: + name: DynamicTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxStringLength: + type: integer + format: int32 + xml: + name: MaxStringLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchCapabilities: + title: tt_SearchCapabilities + required: + - XAddr + - MetadataSearch + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataSearch: + type: boolean + xml: + name: MetadataSearch + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SearchCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayCapabilities: + title: tt_ReplayCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: The address of the replay service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverCapabilities: + title: tt_ReceiverCapabilities + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + type: object + properties: + XAddr: + type: string + description: The address of the receiver service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_Multicast: + type: boolean + description: Indicates whether the device can receive RTP multicast streams. + xml: + name: RTP_Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/TCP streams + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedReceivers: + type: integer + description: The maximum number of receivers supported by the device. + format: int32 + xml: + name: SupportedReceivers + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRTSPURILength: + type: integer + description: The maximum allowed length for RTSP URIs. + format: int32 + xml: + name: MaximumRTSPURILength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReceiverCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceCapabilities: + title: tt_AnalyticsDeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Obsolete property. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceExtension: + title: tt_AnalyticsDeviceExtension + type: object + description: '' + xml: + name: AnalyticsDeviceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogType: + title: tt_SystemLogType + enum: + - System + - Access + type: string + description: Enumeration describing the available system log modes. + xml: + name: SystemLogType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLog: + title: tt_SystemLog + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The log information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The log information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLog + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportInformation: + title: tt_SupportInformation + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The support information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The support information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BinaryData: + title: tt_BinaryData + required: + - Data + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Data: + type: string + description: base64 encoded binary data. + format: binary + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BinaryData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AttachmentData: + title: tt_AttachmentData + required: + - Include + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Include: + allOf: + - $ref: '#/components/schemas/xop_Include' + - xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + description: '' + xml: + name: AttachmentData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BackupFile: + title: tt_BackupFile + required: + - Name + - Data + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BackupFile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUriList: + title: tt_SystemLogUriList + type: object + properties: + SystemLog: + type: array + items: + $ref: '#/components/schemas/tt_SystemLogUri' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUriList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUri: + title: tt_SystemLogUri + required: + - Type + - Uri + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Uri: + type: string + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FactoryDefaultType: + title: tt_FactoryDefaultType + enum: + - Hard + - Soft + type: string + description: Enumeration describing the available factory default modes. + xml: + name: FactoryDefaultType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SetDateTimeType: + title: tt_SetDateTimeType + enum: + - Manual + - NTP + type: string + description: '' + xml: + name: SetDateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTime: + title: tt_SystemDateTime + required: + - DateTimeType + - DaylightSavings + type: object + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + xml: + name: DateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DaylightSavings: + type: boolean + description: Informative indicator whether daylight savings is currently on/off. + xml: + name: DaylightSavings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: Timezone information in Posix format. + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Current system date and time in UTC format. This field is mandatory since version 2.0. + xml: + name: UTCDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in local format. + xml: + name: LocalDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTimeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: General date time inforamtion returned by the GetSystemDateTime method. + xml: + name: SystemDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTimeExtension: + title: tt_SystemDateTimeExtension + type: object + description: '' + xml: + name: SystemDateTimeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTime: + title: tt_DateTime + required: + - Time + - Date + type: object + properties: + Time: + allOf: + - $ref: '#/components/schemas/tt_Time' + - xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Date: + allOf: + - $ref: '#/components/schemas/tt_Date' + - xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Date: + title: tt_Date + required: + - Year + - Month + - Day + type: object + properties: + Year: + type: integer + format: int32 + xml: + name: Year + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Month: + type: integer + description: Range is 1 to 12. + format: int32 + xml: + name: Month + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Day: + type: integer + description: Range is 1 to 31. + format: int32 + xml: + name: Day + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Time: + title: tt_Time + required: + - Hour + - Minute + - Second + type: object + properties: + Hour: + type: integer + description: Range is 0 to 23. + format: int32 + xml: + name: Hour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minute: + type: integer + description: Range is 0 to 59. + format: int32 + xml: + name: Minute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Second: + type: integer + description: Range is 0 to 61 (typically 59). + format: int32 + xml: + name: Second + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TimeZone: + title: tt_TimeZone + required: + - TZ + type: object + properties: + TZ: + type: string + description: Posix timezone string. + xml: + name: TZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3 + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RemoteUser: + title: tt_RemoteUser + required: + - Username + - UseDerivedPassword + type: object + properties: + Username: + type: string + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseDerivedPassword: + type: boolean + xml: + name: UseDerivedPassword + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RemoteUser + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserLevel: + title: tt_UserLevel + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + description: '' + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_User: + title: tt_User + required: + - Username + - UserLevel + type: object + properties: + Username: + type: string + description: Username string. + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password string. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UserLevel: + allOf: + - $ref: '#/components/schemas/tt_UserLevel' + - description: User level string. + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_UserExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: User + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserExtension: + title: tt_UserExtension + type: object + description: '' + xml: + name: UserExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParameters: + title: tt_CertificateGenerationParameters + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subject: + type: string + xml: + name: Subject + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotBefore: + type: string + xml: + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotAfter: + type: string + xml: + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateGenerationParametersExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateGenerationParameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParametersExtension: + title: tt_CertificateGenerationParametersExtension + type: object + description: '' + xml: + name: CertificateGenerationParametersExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Certificate: + title: tt_Certificate + required: + - CertificateID + - Certificate + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateStatus: + title: tt_CertificateStatus + required: + - CertificateID + - Status + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + type: boolean + description: Indicates whether or not a certificate is used in a HTTPS configuration. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateWithPrivateKey: + title: tt_CertificateWithPrivateKey + required: + - Certificate + - PrivateKey + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrivateKey: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: PrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformation: + title: tt_CertificateInformation + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IssuerDN: + type: string + xml: + name: IssuerDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubjectDN: + type: string + xml: + name: SubjectDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: KeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExtendedKeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: ExtendedKeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyLength: + type: integer + format: int32 + xml: + name: KeyLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Version: + type: string + xml: + name: Version + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SerialNum: + type: string + xml: + name: SerialNum + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignatureAlgorithm: + type: string + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding DateTimeRange is from "From" to "Until" + xml: + name: SignatureAlgorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Validity: + allOf: + - $ref: '#/components/schemas/tt_DateTimeRange' + - xml: + name: Validity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateUsage: + title: tt_CertificateUsage + required: + - Critical + type: object + properties: + Critical: + type: boolean + xml: + name: Critical + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: CertificateUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformationExtension: + title: tt_CertificateInformationExtension + type: object + description: '' + xml: + name: CertificateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfiguration: + title: tt_Dot1XConfiguration + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + type: object + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Identity: + type: string + xml: + name: Identity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnonymousID: + type: string + xml: + name: AnonymousID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethod: + type: integer + description: EAP Method type as defined in + format: int32 + xml: + name: EAPMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CACertificateID: + type: array + items: + type: string + xml: + name: CACertificateID + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethodConfiguration: + allOf: + - $ref: '#/components/schemas/tt_EAPMethodConfiguration' + - xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfigurationExtension: + title: tt_Dot1XConfigurationExtension + type: object + description: '' + xml: + name: Dot1XConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EAPMethodConfiguration: + title: tt_EAPMethodConfiguration + type: object + properties: + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/tt_TLSConfiguration' + - description: Confgiuration information for TLS Method. + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password for those EAP Methods that require a password. The password shall never be returned on a get method. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EapMethodExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EapMethodExtension: + title: tt_EapMethodExtension + type: object + description: '' + xml: + name: EapMethodExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TLSConfiguration: + title: tt_TLSConfiguration + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GenericEapPwdConfigurationExtension: + title: tt_GenericEapPwdConfigurationExtension + type: object + description: '' + xml: + name: GenericEapPwdConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayLogicalState: + title: tt_RelayLogicalState + enum: + - active + - inactive + type: string + description: '' + xml: + name: RelayLogicalState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayIdleState: + title: tt_RelayIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: RelayIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutputSettings: + title: tt_RelayOutputSettings + required: + - Mode + - DelayTime + - IdleState + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RelayMode' + - description: "'Bistable' or 'Monostable'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DelayTime: + type: string + 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. + format: date-time + xml: + name: DelayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IdleState: + allOf: + - $ref: '#/components/schemas/tt_RelayIdleState' + - description: "'open' or 'closed'" + xml: + name: IdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelayOutputSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayMode: + title: tt_RelayMode + enum: + - Monostable + - Bistable + type: string + description: '' + xml: + name: RelayMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutput: + title: tt_RelayOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Properties + type: object + properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + name: Properties + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: RelayOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_DigitalIdleState: + title: tt_DigitalIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: DigitalIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DigitalInput: + title: tt_DigitalInput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + properties: + IdleState: + allOf: + - $ref: '#/components/schemas/tt_DigitalIdleState' + - description: Indicate the Digital IdleState status. + xml: + name: IdleState + prefix: tt + attribute: true + wrapped: false + xml: + name: DigitalInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNode: + title: tt_PTZNode + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + properties: + Name: + maxLength: 64 + type: string + description: A unique identifier that is used to reference PTZ Nodes. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range. + xml: + name: SupportedPTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumNumberOfPresets: + type: integer + description: All preset operations MUST be available for this PTZ Node if one preset is supported. + format: int32 + xml: + name: MaximumNumberOfPresets + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HomeSupported: + type: boolean + 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. + xml: + name: HomeSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedHomePosition: + type: boolean + description: Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command. + xml: + name: FixedHomePosition + prefix: tt + attribute: true + wrapped: false + GeoMove: + type: boolean + description: Indication whether the Node supports the geo-referenced move command. + xml: + name: GeoMove + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZNode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNodeExtension: + title: tt_PTZNodeExtension + type: object + properties: + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + xml: + name: SupportedPresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZNodeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZNodeExtension2: + title: tt_PTZNodeExtension2 + type: object + description: '' + xml: + name: PTZNodeExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupported: + title: tt_PTZPresetTourSupported + required: + - MaximumNumberOfPresetTours + type: object + properties: + MaximumNumberOfPresetTours: + type: integer + 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. + format: int32 + xml: + name: MaximumNumberOfPresetTours + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPresetTourOperation: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourOperation' + description: Indicates which preset tour operations are available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupportedExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupportedExtension: + title: tt_PTZPresetTourSupportedExtension + type: object + description: '' + xml: + name: PTZPresetTourSupportedExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension: + title: tt_PTZConfigurationExtension + type: object + properties: + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirection' + - description: Optional element to configure PT Control Direction related features. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension2: + title: tt_PTZConfigurationExtension2 + type: object + description: '' + xml: + name: PTZConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirection: + title: tt_PTControlDirection + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlip' + - description: Optional element to configure related parameters for E-Flip. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_Reverse' + - description: Optional element to configure related parameters for reversing of PT Control Direction. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionExtension: + title: tt_PTControlDirectionExtension + type: object + description: '' + xml: + name: PTControlDirectionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlip: + title: tt_EFlip + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Reverse: + title: tt_Reverse + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipMode: + title: tt_EFlipMode + enum: + - OFF + - ON + - Extended + type: string + description: '' + xml: + name: EFlipMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseMode: + title: tt_ReverseMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ReverseMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions: + title: tt_PTZConfigurationOptions + required: + - Spaces + - PTZTimeout + type: object + properties: + PTZRamps: + type: integer + description: >- + The list of acceleration ramps supported by the device. The + smallest acceleration value corresponds to the minimal index, the + highest acceleration corresponds to the maximum index. + format: int32 + xml: + name: PTZRamps + prefix: tt + attribute: true + wrapped: false + Spaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of supported coordinate systems including their range limitations. + xml: + name: Spaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZTimeout: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the PTZ Node. + xml: + name: PTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions2: + title: tt_PTZConfigurationOptions2 + type: object + description: '' + xml: + name: PTZConfigurationOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptions: + title: tt_PTControlDirectionOptions + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptions' + - description: Supported options for EFlip feature. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptions' + - description: Supported options for Reverse feature. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirectionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptionsExtension: + title: tt_PTControlDirectionOptionsExtension + type: object + description: '' + xml: + name: PTControlDirectionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptions: + title: tt_EFlipOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_EFlipMode' + description: Options of EFlip mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlipOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptionsExtension: + title: tt_EFlipOptionsExtension + type: object + description: '' + xml: + name: EFlipOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptions: + title: tt_ReverseOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ReverseMode' + description: Options of Reverse mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReverseOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptionsExtension: + title: tt_ReverseOptionsExtension + type: object + description: '' + xml: + name: ReverseOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PanTiltLimits: + title: tt_PanTiltLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: A range of pan tilt limits. + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ZoomLimits: + title: tt_ZoomLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: A range of zoom limit + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpaces: + title: tt_PTZSpaces + type: object + properties: + AbsolutePanTiltPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AbsoluteZoomPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). \n There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePanTiltTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativeZoomTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, 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 where 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 There 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousPanTiltVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 rotation 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousZoomVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt \n movement is represented by a single non-negative scalar value." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZSpacesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpacesExtension: + title: tt_PTZSpacesExtension + type: object + description: '' + xml: + name: PTZSpacesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space2DDescription: + title: tt_Space2DDescription + required: + - URI + - XRange + - YRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space2DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space1DDescription: + title: tt_Space1DDescription + required: + - URI + - XRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space1DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpeed: + title: tt_PTZSpeed + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - 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. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPreset: + title: tt_PTZPreset + type: object + properties: + token: + maxLength: 64 + type: string + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: A list of preset position name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A list of preset position. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPreset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourState: + title: tt_PTZPresetTourState + enum: + - Idle + - Touring + - Paused + - Extended + type: string + description: '' + xml: + name: PTZPresetTourState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourDirection: + title: tt_PTZPresetTourDirection + enum: + - Forward + - Backward + - Extended + type: string + description: '' + xml: + name: PTZPresetTourDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOperation: + title: tt_PTZPresetTourOperation + enum: + - Start + - Stop + - Pause + - Extended + type: string + description: '' + xml: + name: PTZPresetTourOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PresetTour: + title: tt_PresetTour + required: + - Status + - AutoStart + - StartingCondition + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of this preset tour. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: Readable name of the preset tour. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset tour. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Auto Start flag of the preset tour. True allows the preset tour to be activated always. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourSpot' + description: A list of detail of touring spots including preset positions. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourExtension: + title: tt_PTZPresetTourExtension + type: object + description: '' + xml: + name: PTZPresetTourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpot: + title: tt_PTZPresetTourSpot + required: + - PresetDetail + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + type: string + description: Optional parameter to specify time duration of staying on this tour sport. + format: date-time + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotExtension: + title: tt_PTZPresetTourSpotExtension + type: object + description: '' + xml: + name: PTZPresetTourSpotExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetail: + title: tt_PTZPresetTourPresetDetail + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourTypeExtension: + title: tt_PTZPresetTourTypeExtension + type: object + description: '' + xml: + name: PTZPresetTourTypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatus: + title: tt_PTZPresetTourStatus + required: + - State + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + xml: + name: CurrentTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatusExtension: + title: tt_PTZPresetTourStatusExtension + type: object + description: '' + xml: + name: PTZPresetTourStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingCondition: + title: tt_PTZPresetTourStartingCondition + type: object + properties: + RandomPresetOrder: + type: 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. + xml: + name: RandomPresetOrder + prefix: tt + attribute: true + wrapped: false + RecurringTime: + type: integer + description: Optional parameter to specify how many times the preset tour is recurred. + format: int32 + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + type: string + description: Optional parameter to specify how long time duration the preset tour is recurred. + format: date-time + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted. + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionExtension: + title: tt_PTZPresetTourStartingConditionExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOptions: + title: tt_PTZPresetTourOptions + required: + - AutoStart + - StartingCondition + - TourSpot + type: object + properties: + AutoStart: + type: boolean + description: Indicates whether or not the AutoStart is supported. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + xml: + name: TourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotOptions: + title: tt_PTZPresetTourSpotOptions + required: + - PresetDetail + - StayTime + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of stay time for a tour spot. + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpotOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptions: + title: tt_PTZPresetTourPresetDetailOptions + type: object + properties: + PresetToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: PresetToken + attribute: false + wrapped: false + description: A list of available Preset Tokens for tour spots. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + description: An option to indicate Home postion for tour spots. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + xml: + name: PanTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + xml: + name: ZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetailOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptionsExtension: + title: tt_PTZPresetTourPresetDetailOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourPresetDetailOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptions: + title: tt_PTZPresetTourStartingConditionOptions + type: object + properties: + RecurringTime: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of Recurring Time. + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of Recurring Duration. + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourDirection' + description: Supported options for Direction of Preset Tour. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingConditionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptionsExtension: + title: tt_PTZPresetTourStartingConditionOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveAndTrackMethod: + title: tt_MoveAndTrackMethod + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + type: string + description: '' + xml: + name: MoveAndTrackMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus: + title: tt_ImagingStatus + required: + - FocusStatus + type: object + properties: + FocusStatus: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus' + - xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus: + title: tt_FocusStatus + required: + - Position + - MoveStatus + - Error + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration: + title: tt_FocusConfiguration + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: >- + Parameter to set autofocus far limit (unit: meter). + + If set to 0.0, infinity will be used. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AutoFocusMode: + title: tt_AutoFocusMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AFModes: + title: tt_AFModes + enum: + - OnceAfterMove + type: string + description: '' + xml: + name: AFModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings: + title: tt_ImagingSettings + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension: + title: tt_ImagingSettingsExtension + type: object + description: '' + xml: + name: ImagingSettingsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure: + title: tt_Exposure + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + description: Minimum value of the iris range allowed to be used by the algorithm. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + description: Maximum value of the iris range allowed to be used by the algorithm. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + description: The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicMode: + title: tt_WideDynamicMode + enum: + - OFF + - ON + type: string + description: '' + xml: + name: WideDynamicMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange: + title: tt_WideDynamicRange + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: White dynamic range (on/off) + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unitless) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationMode: + title: tt_BacklightCompensationMode + enum: + - OFF + - ON + type: string + description: Enumeration describing the available backlight compenstation modes. + xml: + name: BacklightCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation: + title: tt_BacklightCompensation + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposurePriority: + title: tt_ExposurePriority + enum: + - LowNoise + - FrameRate + type: string + description: '' + xml: + name: ExposurePriority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions: + title: tt_ImagingOptions + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions' + - xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions' + - xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions' + - xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions' + - xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions' + - xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions: + title: tt_WideDynamicRangeOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions: + title: tt_BacklightCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions: + title: tt_FocusOptions + required: + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions: + title: tt_ExposureOptions + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions: + title: tt_WhiteBalanceOptions + required: + - Mode + - YrGain + - YbGain + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusMove: + title: tt_FocusMove + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocus' + - description: Parameters for the absolute focus control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocus' + - description: Parameters for the relative focus control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocus' + - description: Parameter for the continuous focus control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusMove + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocus: + title: tt_AbsoluteFocus + required: + - Position + type: object + properties: + Position: + type: number + description: Position parameter for the absolute focus control. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the absolute focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocus: + title: tt_RelativeFocus + required: + - Distance + type: object + properties: + Distance: + type: number + description: Distance parameter for the relative focus control. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the relative focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocus: + title: tt_ContinuousFocus + required: + - Speed + type: object + properties: + Speed: + type: number + description: Speed parameter for the Continuous focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions: + title: tt_MoveOptions + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions' + - xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocusOptions: + title: tt_AbsoluteFocusOptions + required: + - Position + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions: + title: tt_RelativeFocusOptions + required: + - Distance + - Speed + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocusOptions: + title: tt_ContinuousFocusOptions + required: + - Speed + type: object + properties: + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureMode: + title: tt_ExposureMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: ExposureMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Enabled: + title: tt_Enabled + enum: + - ENABLED + - DISABLED + type: string + description: '' + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceMode: + title: tt_WhiteBalanceMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: WhiteBalanceMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterMode: + title: tt_IrCutFilterMode + enum: + - ON + - OFF + - AUTO + type: string + description: '' + xml: + name: IrCutFilterMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance: + title: tt_WhiteBalance + required: + - Mode + - CrGain + - CbGain + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20: + title: tt_ImagingStatus20 + type: object + properties: + FocusStatus20: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20' + - description: Status of focus. + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20Extension: + title: tt_ImagingStatus20Extension + type: object + description: '' + xml: + name: ImagingStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20: + title: tt_FocusStatus20 + required: + - Position + - MoveStatus + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20Extension: + title: tt_FocusStatus20Extension + type: object + description: '' + xml: + name: FocusStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings20: + title: tt_ImagingSettings20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure20' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange20' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension20' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command. + xml: + name: ImagingSettings20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension20: + title: tt_ImagingSettingsExtension20 + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension202' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension202: + title: tt_ImagingSettingsExtension202 + type: object + properties: + IrCutFilterAutoAdjustment: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustment' + description: An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension203' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension202 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension203: + title: tt_ImagingSettingsExtension203 + type: object + properties: + ToneCompensation: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Defogging: + allOf: + - $ref: '#/components/schemas/tt_Defogging' + - description: Optional element to configure Image Defogging. + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReduction: + allOf: + - $ref: '#/components/schemas/tt_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension204' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension203 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension204: + title: tt_ImagingSettingsExtension204 + type: object + description: '' + xml: + name: ImagingSettingsExtension204 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilization: + title: tt_ImageStabilization + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationExtension: + title: tt_ImageStabilizationExtension + type: object + description: '' + xml: + name: ImageStabilizationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationMode: + title: tt_ImageStabilizationMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ImageStabilizationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustment: + title: tt_IrCutFilterAutoAdjustment + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: string + description: Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + name: BoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: number + 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). + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTime: + type: string + description: Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels. + format: date-time + xml: + name: ResponseTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentExtension: + title: tt_IrCutFilterAutoAdjustmentExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoBoundaryType: + title: tt_IrCutFilterAutoBoundaryType + enum: + - Common + - ToOn + - ToOff + - Extended + type: string + description: '' + xml: + name: IrCutFilterAutoBoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange20: + title: tt_WideDynamicRange20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether WDR mode is enabled or disabled (on/off). + xml: + name: WideDynamicRange20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation20: + title: tt_BacklightCompensation20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether BLC mode is enabled or disabled (on/off). + xml: + name: BacklightCompensation20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure20: + title: tt_Exposure20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + 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. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + 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. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + 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. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the exposure settings. + xml: + name: Exposure20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensation: + title: tt_ToneCompensation + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationExtension: + title: tt_ToneCompensationExtension + type: object + description: '' + xml: + name: ToneCompensationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationMode: + title: tt_ToneCompensationMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: ToneCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Defogging: + title: tt_Defogging + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DefoggingExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingExtension: + title: tt_DefoggingExtension + type: object + description: '' + xml: + name: DefoggingExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingMode: + title: tt_DefoggingMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: DefoggingMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReduction: + title: tt_NoiseReduction + required: + - Level + type: object + properties: + Level: + type: number + description: Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20: + title: tt_ImagingOptions20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Brightness. + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Color Saturation. + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Contrast. + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions20' + - description: Valid range of Exposure. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20' + - description: Valid range of Focus. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: Valid range of IrCutFilterModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Sharpness. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension: + title: tt_ImagingOptions20Extension + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension2: + title: tt_ImagingOptions20Extension2 + type: object + properties: + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto mode. + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension3' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension3: + title: tt_ImagingOptions20Extension3 + type: object + properties: + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/tt_DefoggingOptions' + - description: Options of parameters for Defogging feature. + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/tt_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension4' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension3 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension4: + title: tt_ImagingOptions20Extension4 + type: object + description: '' + xml: + name: ImagingOptions20Extension4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptions: + title: tt_ImageStabilizationOptions + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ImageStabilizationMode' + description: Supported options of Image Stabilization mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Image Stabilization. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilizationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptionsExtension: + title: tt_ImageStabilizationOptionsExtension + type: object + description: '' + xml: + name: ImageStabilizationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptions: + title: tt_IrCutFilterAutoAdjustmentOptions + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: array + items: + type: string + xml: + name: BoundaryType + attribute: false + wrapped: false + description: Supported options of boundary types for adjustment of Ir cut filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: boolean + description: Indicates whether or not boundary offset for toggling Ir cut filter is supported. + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + xml: + name: ResponseTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptionsExtension: + title: tt_IrCutFilterAutoAdjustmentOptionsExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions20: + title: tt_WideDynamicRangeOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions20: + title: tt_BacklightCompensationOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_BacklightCompensationMode' + description: "'ON' or 'OFF'" + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Level range of BacklightCompensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions20: + title: tt_ExposureOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: Exposure Mode + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: The exposure priority mode (low noise/framerate). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum ExposureTime. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum ExposureTime. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Gain. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Gain. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Iris. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Iris. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the ExposureTime. + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Gain. + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions20: + title: tt_MoveOptions20 + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions20: + title: tt_RelativeFocusOptions20 + required: + - Distance + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20: + title: tt_WhiteBalance20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: "'AUTO' or 'MANUAL'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20Extension: + title: tt_WhiteBalance20Extension + type: object + description: '' + xml: + name: WhiteBalance20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20: + title: tt_FocusConfiguration20 + required: + - AutoFocusMode + type: object + properties: + AFMode: + type: string + description: Zero or more modes as defined in enumeration tt:AFModes. + xml: + name: AFMode + prefix: tt + attribute: true + wrapped: false + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - description: Mode of auto focus. + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: 'Parameter to set autofocus far limit (unit: meter).' + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20Extension: + title: tt_FocusConfiguration20Extension + type: object + description: '' + xml: + name: FocusConfiguration20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20: + title: tt_WhiteBalanceOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: Mode of WhiteBalance. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20Extension: + title: tt_WhiteBalanceOptions20Extension + type: object + description: '' + xml: + name: WhiteBalanceOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20: + title: tt_FocusOptions20 + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: Supported modes for auto focus. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of DefaultSpeed. + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of NearLimit. + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of FarLimit. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20Extension: + title: tt_FocusOptions20Extension + type: object + properties: + AFModes: + type: array + items: + type: string + xml: + name: AFModes + attribute: false + wrapped: false + description: Supported options for auto focus. Options shall be chosen from tt:AFModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationOptions: + title: tt_ToneCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Tone Compensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingOptions: + title: tt_DefoggingOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Defogging. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReductionOptions: + title: tt_NoiseReductionOptions + required: + - Level + type: object + properties: + Level: + type: boolean + description: Indicates whether or not support Level parameter for NoiseReduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageSendingType: + title: tt_ImageSendingType + enum: + - Embedded + - LocalStorage + - RemoteStorage + type: string + description: '' + xml: + name: ImageSendingType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PropertyOperation: + title: tt_PropertyOperation + enum: + - Initialized + - Deleted + - Changed + type: string + description: '' + xml: + name: PropertyOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Message: + title: tt_Message + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + PropertyOperation: + allOf: + - $ref: '#/components/schemas/tt_PropertyOperation' + - xml: + name: PropertyOperation + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: Token value pairs that triggered this message. Typically only one item is present. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Message + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageExtension: + title: tt_MessageExtension + type: object + description: '' + xml: + name: MessageExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemList: + title: tt_ItemList + type: object + properties: + SimpleItem: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItem' + description: Value name pair as defined by the corresponding description. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItem: + type: array + items: + $ref: '#/components/schemas/tt_ElementItem' + description: Complex value structure. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ItemList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListExtension: + title: tt_ItemListExtension + type: object + description: '' + xml: + name: ItemListExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescription: + title: tt_MessageDescription + type: object + properties: + IsProperty: + type: 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. + xml: + name: IsProperty + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + Set of tokens producing this message. The list may only contain SimpleItemDescription items. + The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key. + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes the payload of the message. + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MessageDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescriptionExtension: + title: tt_MessageDescriptionExtension + type: object + description: '' + xml: + name: MessageDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescription: + title: tt_ItemListDescription + type: object + properties: + SimpleItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItemDescription' + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_ElementItemDescription' + description: Description of a complex type. The Type must reference a defined type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + Describes a list of items. Each item in the list shall have a unique name. + The list is designed as linear structure without optional or unbounded elements. + Use ElementItems only when complex structures are inevitable. + xml: + name: ItemListDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescriptionExtension: + title: tt_ItemListDescriptionExtension + type: object + description: '' + xml: + name: ItemListDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polyline: + title: tt_Polyline + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polyline + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Direction: + title: tt_Direction + enum: + - Left + - Right + - Any + type: string + description: '' + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfiguration: + title: tt_AnalyticsEngineConfiguration + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfigurationExtension: + title: tt_AnalyticsEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfiguration: + title: tt_RuleEngineConfiguration + type: object + properties: + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfigurationExtension: + title: tt_RuleEngineConfigurationExtension + type: object + description: '' + xml: + name: RuleEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Config: + title: tt_Config + required: + - Name + - Type + - Parameters + type: object + properties: + Name: + type: string + description: Name of the configuration. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + 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. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: List of configuration parameters as defined in the corresponding description. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescription: + title: tt_ConfigDescription + required: + - Name + - Parameters + type: object + properties: + Name: + type: string + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies the type of rule, not a type definition in a schema. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: The fixed attribute signals that it is not allowed to add or remove this type of configuration. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + maxInstances: + type: integer + description: The maxInstances attribute signals the maximum number of instances per configuration. + format: int32 + xml: + name: maxInstances + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems + should be used to transport the information to ease parsing of dynamically defined messages by a client + application. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Messages: + type: array + items: + $ref: '#/components/schemas/tt_Messages' + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ConfigDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ConfigDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescriptionExtension: + title: tt_ConfigDescriptionExtension + type: object + description: '' + xml: + name: ConfigDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRules: + title: tt_SupportedRules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + RuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: RuleContentSchemaLocation + attribute: false + wrapped: false + description: Lists the location of all schemas that are referenced in the rules. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: List of rules supported by the Video Analytics configuration.. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedRulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedRules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRulesExtension: + title: tt_SupportedRulesExtension + type: object + description: '' + xml: + name: SupportedRulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModules: + title: tt_SupportedAnalyticsModules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + AnalyticsModuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: AnalyticsModuleContentSchemaLocation + attribute: false + wrapped: false + description: >- + It optionally contains a list of URLs that provide the location of schema files. + These schema files describe the types and elements used in the analytics module descriptions. + Analytics module descriptions that reference types or elements imported from any ONVIF defined schema files + need not explicitly list those schema files. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModulesExtension: + title: tt_SupportedAnalyticsModulesExtension + type: object + description: '' + xml: + name: SupportedAnalyticsModulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArray: + title: tt_PolylineArray + required: + - Segment + type: object + properties: + Segment: + type: array + items: + $ref: '#/components/schemas/tt_Polyline' + description: Contains array of Polyline + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PolylineArrayExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayExtension: + title: tt_PolylineArrayExtension + type: object + description: '' + xml: + name: PolylineArrayExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayConfiguration: + title: tt_PolylineArrayConfiguration + required: + - PolylineArray + type: object + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/tt_PolylineArray' + - description: Contains PolylineArray configuration data + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArrayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpression: + title: tt_MotionExpression + required: + - Expression + type: object + properties: + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Expression: + type: string + description: Motion Expression data structure contains motion expression which is based on Scene Descriptor schema with XPATH syntax. The Type argument could allow introduction of different dialects + xml: + name: Expression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpressionConfiguration: + title: tt_MotionExpressionConfiguration + required: + - MotionExpression + type: object + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/tt_MotionExpression' + - description: Contains Rule MotionExpression configuration + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpressionConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CellLayout: + title: tt_CellLayout + required: + - Columns + - Rows + - Transformation + type: object + properties: + Columns: + type: integer + description: Number of columns of the cell grid (x dimension) + format: int32 + xml: + name: Columns + prefix: tt + attribute: true + wrapped: false + Rows: + type: integer + description: Number of rows of the cell grid (y dimension) + format: int32 + xml: + name: Rows + prefix: tt + attribute: true + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid is starting from the upper left corner and x dimension is going from left to right and the y dimension from up to down. + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CellLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneConfiguration: + title: tt_PaneConfiguration + required: + - Token + type: object + properties: + PaneName: + type: string + description: Optional name of the pane configuration. + xml: + name: PaneName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputToken: + maxLength: 64 + type: string + description: >- + If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client + + can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. + xml: + name: AudioOutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceToken: + maxLength: 64 + type: string + description: >- + If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. + + The 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 + + DeviceIO service. + xml: + name: AudioSourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: >- + The configuration of the audio encoder including codec, bitrate + + and sample rate. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + maxLength: 64 + type: string + description: >- + A pointer to a Receiver that has the necessary information to receive + data 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 + GetReceivers command of the Receiver Service. + xml: + name: ReceiverToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: A unique identifier in the display device. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration of the streaming and coding settings of a Video window. + xml: + name: PaneConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayout: + title: tt_PaneLayout + required: + - Pane + - Area + type: object + properties: + Pane: + maxLength: 64 + type: string + description: Reference to the configuration of the streaming and coding parameters. + xml: + name: Pane + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Area: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Describes the location and size of the area on the monitor. The area coordinate values are espressed in normalized units [-1.0, 1.0]. + xml: + name: Area + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen. + xml: + name: PaneLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Layout: + title: tt_Layout + required: + - PaneLayout + type: object + properties: + PaneLayout: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayout' + description: List of panes assembling the display layout. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A layout describes a set of Video windows that are displayed simultaniously on a display. + xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutExtension: + title: tt_LayoutExtension + type: object + description: '' + xml: + name: LayoutExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CodingCapabilities: + title: tt_CodingCapabilities + required: + - VideoDecodingCapabilities + type: object + properties: + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes the supported codecs and their configuration. + xml: + name: AudioEncodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes the supported codecs and their settings. + xml: + name: AudioDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their configuration. + xml: + name: VideoDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: This type contains the Audio and Video coding capabilities of a display service. + xml: + name: CodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptions: + title: tt_LayoutOptions + required: + - PaneLayoutOptions + type: object + properties: + PaneLayoutOptions: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayoutOptions' + description: Lists the possible Pane Layouts of the Video Output + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The options supported for a display layout. + xml: + name: LayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptionsExtension: + title: tt_LayoutOptionsExtension + type: object + description: '' + xml: + name: LayoutOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayoutOptions: + title: tt_PaneLayoutOptions + required: + - Area + type: object + properties: + Area: + type: array + items: + $ref: '#/components/schemas/tt_Rectangle' + description: List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PaneOptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a pane layout describing a complete display layout. + xml: + name: PaneLayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneOptionExtension: + title: tt_PaneOptionExtension + type: object + description: '' + xml: + name: PaneOptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Receiver: + title: tt_Receiver + required: + - Token + - Configuration + type: object + properties: + Token: + maxLength: 64 + type: string + description: Unique identifier of the receiver. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a receiver, including its token and configuration. + xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverConfiguration: + title: tt_ReceiverConfiguration + required: + - Mode + - MediaUri + - StreamSetup + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReceiverMode' + - description: 'The following connection modes are defined:' + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaUri: + type: string + description: Details of the URI to which the receiver should connect. + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream connection parameters. + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describes the configuration of a receiver. + xml: + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverMode: + title: tt_ReceiverMode + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + description: Specifies a receiver connection mode. + xml: + name: ReceiverMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverState: + title: tt_ReceiverState + enum: + - NotConnected + - Connecting + - Connected + - Unknown + type: string + description: Specifies the current connection state of the receiver. + xml: + name: ReceiverState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverStateInformation: + title: tt_ReceiverStateInformation + required: + - State + - AutoCreated + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_ReceiverState' + - description: 'The connection state of the receiver may have one of the following states:' + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreated: + type: boolean + description: Indicates whether or not the receiver was created automatically. + xml: + name: AutoCreated + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Contains information about a receiver's current state. + xml: + name: ReceiverStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceReference: + title: tt_SourceReference + required: + - Token + type: object + properties: + Type: + type: string + default: http://www.onvif.org/ver10/schema/Receiver + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTimeRange: + title: tt_DateTimeRange + required: + - From + - Until + type: object + properties: + From: + type: string + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSummary: + title: tt_RecordingSummary + required: + - DataFrom + - DataUntil + - NumberRecordings + type: object + properties: + DataFrom: + type: string + description: The earliest point in time where there is recorded data on the device. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataUntil: + type: string + description: The most recent point in time where there is recorded data on the device. + format: date-time + xml: + name: DataUntil + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NumberRecordings: + type: integer + description: The device contains this many recordings. + format: int32 + xml: + name: NumberRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingSummary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScope: + title: tt_SearchScope + type: object + properties: + IncludedSources: + type: array + items: + $ref: '#/components/schemas/tt_SourceReference' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IncludedRecordings: + type: array + items: + maxLength: 64 + type: string + xml: + name: IncludedRecordings + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformationFilter: + type: string + 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. + xml: + name: RecordingInformationFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SearchScopeExtension' + - description: Extension point + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A structure for defining a limited scope when searching in recorded data. + xml: + name: SearchScope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScopeExtension: + title: tt_SearchScopeExtension + type: object + description: '' + xml: + name: SearchScopeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventFilter: + title: tt_EventFilter + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + xml: + name: EventFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZPositionFilter: + title: tt_PTZPositionFilter + required: + - MinPosition + - MaxPosition + - EnterOrExit + type: object + properties: + MinPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + xml: + name: MinPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + xml: + name: MaxPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EnterOrExit: + type: boolean + description: If true, search for when entering the specified PTZ volume. + xml: + name: EnterOrExit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPositionFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataFilter: + title: tt_MetadataFilter + required: + - MetadataStreamFilter + type: object + properties: + MetadataStreamFilter: + type: string + xml: + name: MetadataStreamFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindRecordingResultList: + title: tt_FindRecordingResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformation: + type: array + items: + $ref: '#/components/schemas/tt_RecordingInformation' + description: A RecordingInformation structure for each found recording matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindRecordingResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResultList: + title: tt_FindEventResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindEventResult' + description: A FindEventResult structure for each found event matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResult: + title: tt_FindEventResult + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: The recording where this event was found. Empty string if no recording is associated with this event. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the track where this event was found. Empty string if no track is associated with this event. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the event occured. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + xml: + name: Event + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartStateEvent: + type: boolean + 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. + xml: + name: StartStateEvent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResultList: + title: tt_FindPTZPositionResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindPTZPositionResult' + description: A FindPTZPositionResult structure for each found PTZ position matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResult: + title: tt_FindPTZPositionResult + required: + - RecordingToken + - TrackToken + - Time + - Position + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the PTZ position. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the PTZ position. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the PTZ position was valid. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The PTZ position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResultList: + title: tt_FindMetadataResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindMetadataResult' + description: A FindMetadataResult structure for each found set of Metadata matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResult: + title: tt_FindMetadataResult + required: + - RecordingToken + - TrackToken + - Time + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the metadata. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the matching metadata. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The point in time when the matching metadata occurs in the metadata track. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchState: + title: tt_SearchState + enum: + - Queued + - Searching + - Completed + - Unknown + type: string + description: '' + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingInformation: + title: tt_RecordingInformation + required: + - RecordingToken + - Source + - Content + - RecordingStatus + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: >- + Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single + recording is intended to record related material, there is just one source. It is indicates the physical location or the + major data source for the recording. Currently the recordingconfiguration cannot describe each individual data source. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EarliestRecording: + type: string + format: date-time + xml: + name: EarliestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LatestRecording: + type: string + format: date-time + xml: + name: LatestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Track: + type: array + items: + $ref: '#/components/schemas/tt_TrackInformation' + description: Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingStatus: + allOf: + - $ref: '#/components/schemas/tt_RecordingStatus' + - xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSourceInformation: + title: tt_RecordingSourceInformation + required: + - SourceId + - Name + - Location + - Description + - Address + type: object + properties: + SourceId: + type: string + description: >- + Identifier for the source chosen by the client that creates the structure. + This identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters. + xml: + name: SourceId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + maxLength: 64 + type: string + description: Informative user readable name of the source, e.g. "Camera23". A device shall support at least 20 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Location: + type: string + description: Informative description of the physical location of the source, e.g. the coordinates on a map. + xml: + name: Location + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the source. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Address: + type: string + description: URI provided by the service supplying data to be recorded. A device shall support at least 128 characters. + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of informative desciptions of a data source. The Search searvice allows a client to filter on recordings based on information in this structure. + xml: + name: RecordingSourceInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingStatus: + title: tt_RecordingStatus + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + type: string + description: '' + xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackInformation: + title: tt_TrackInformation + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + type: object + properties: + TrackToken: + maxLength: 64 + type: string + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track: "Video", "Audio" or "Metadata". + The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the contents of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataFrom: + type: string + description: The start date and time of the oldest recorded data in the track. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataTo: + type: string + description: The stop date and time of the newest recorded data in the track. + format: date-time + xml: + name: DataTo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackType: + title: tt_TrackType + enum: + - Video + - Audio + - Metadata + - Extended + type: string + description: '' + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaAttributes: + title: tt_MediaAttributes + required: + - RecordingToken + - From + - Until + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording that has these attributes. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackAttributes: + type: array + items: + $ref: '#/components/schemas/tt_TrackAttributes' + description: A set of attributes for each track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + From: + type: string + description: The attributes are valid from this point in time in the recording. + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + 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. + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of media attributes valid for a recording at a point in time or for a time interval. + xml: + name: MediaAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributes: + title: tt_TrackAttributes + required: + - TrackInformation + type: object + properties: + TrackInformation: + allOf: + - $ref: '#/components/schemas/tt_TrackInformation' + - description: The basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAttributes: + allOf: + - $ref: '#/components/schemas/tt_VideoAttributes' + - description: If the track is a video track, exactly one of this structure shall be present and contain the video attributes. + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioAttributes: + allOf: + - $ref: '#/components/schemas/tt_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure shall be present and contain the audio attributes. + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/tt_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure shall be present and contain the metadata attributes. + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TrackAttributesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributesExtension: + title: tt_TrackAttributesExtension + type: object + description: '' + xml: + name: TrackAttributesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAttributes: + title: tt_VideoAttributes + required: + - Width + - Height + - Encoding + - Framerate + type: object + properties: + Bitrate: + type: integer + description: Average bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Width: + type: integer + description: The width of the video in pixels. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: The height of the video in pixels. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Video encoding of the track. Use value from tt:VideoEncoding for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Framerate: + type: number + description: Average framerate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAttributes: + title: tt_AudioAttributes + required: + - Encoding + - Samplerate + type: object + properties: + Bitrate: + type: integer + description: The bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Audio encoding of the track. Use values from tt:AudioEncoding for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Samplerate: + type: integer + description: The sample rate in kHz. + format: int32 + xml: + name: Samplerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataAttributes: + title: tt_MetadataAttributes + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + type: object + properties: + PtzSpaces: + type: 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. + xml: + name: PtzSpaces + prefix: tt + attribute: true + wrapped: false + CanContainPTZ: + type: boolean + description: Indicates that there can be PTZ data in the metadata track in the specified time interval. + xml: + name: CanContainPTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainAnalytics: + type: boolean + description: Indicates that there can be analytics data in the metadata track in the specified time interval. + xml: + name: CanContainAnalytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainNotifications: + type: boolean + description: Indicates that there can be notifications in the metadata track in the specified time interval. + xml: + name: CanContainNotifications + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingConfiguration: + title: tt_RecordingConfiguration + required: + - Source + - Content + - MaximumRetentionTime + type: object + properties: + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: Information about the source of the recording. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + description: Informative description of the source. + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRetentionTime: + type: string + description: >- + Sspecifies the maximum time that data in any track within the + recording shall be stored. The device shall delete any data older than the maximum retention + time. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0, + the device shall not limit the retention time of stored data, except by resource constraints. + Whatever the value of MaximumRetentionTime, the device may automatically delete + recordings to free up storage space for new recordings. + format: date-time + xml: + name: MaximumRetentionTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackConfiguration: + title: tt_TrackConfiguration + required: + - TrackType + - Description + type: object + properties: + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track. It shall be equal to the strings “Video”, + “Audio” or “Metadata”. The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingsResponseItem: + title: tt_GetRecordingsResponseItem + required: + - RecordingToken + - Configuration + - Tracks + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Token of the recording. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_RecordingConfiguration' + - description: Configuration of the recording. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_GetTracksResponseList' + - description: List of tracks. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseList: + title: tt_GetTracksResponseList + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_GetTracksResponseItem' + description: Configuration of a track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseItem: + title: tt_GetTracksResponseItem + required: + - TrackToken + - Configuration + type: object + properties: + TrackToken: + maxLength: 64 + type: string + description: Token of the track. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_TrackConfiguration' + - description: Configuration of the track. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfiguration: + title: tt_RecordingJobConfiguration + required: + - RecordingToken + - Mode + - Priority + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identifies the recording to which this job shall store the received data. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + type: string + description: >- + The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try + to obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: integer + description: >- + This shall be a non-negative number. If there are multiple recording jobs that store data to + the same track, the device will only store the data for the recording job with the highest + priority. The priority is specified per recording job, but the device shall determine the priority + of each track individually. If there are two recording jobs with the same priority, the device + shall record the data corresponding to the recording job that was activated the latest. + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobSource' + description: Source of the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfigurationExtension: + title: tt_RecordingJobConfigurationExtension + type: object + description: '' + xml: + name: RecordingJobConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSource: + title: tt_RecordingJobSource + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: >- + This field shall be a reference to the source of the data. The type of the source + is determined by the attribute Type in the SourceToken structure. If Type is + http://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case + the device shall receive the data over the network. If Type is + http://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, instructing the + device to obtain data from a profile that exists on the local device. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreateReceiver: + type: boolean + description: >- + If this field is TRUE, and if the SourceToken is omitted, the device + shall create a receiver object (through the receiver service) and assign the + ReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration + from the device, the AutoCreateReceiver field shall never be present. + xml: + name: AutoCreateReceiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobTrack' + description: List of tracks associated with the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSourceExtension: + title: tt_RecordingJobSourceExtension + type: object + description: '' + xml: + name: RecordingJobSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobTrack: + title: tt_RecordingJobTrack + required: + - SourceTag + - Destination + type: object + properties: + SourceTag: + type: string + description: >- + If the received RTSP stream contains multiple tracks of the same type, the + SourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: >- + The destination is the tracktoken of the track to which the device shall store the + received data. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformation: + title: tt_RecordingJobStateInformation + required: + - RecordingToken + - State + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identification of the recording that the recording job records to. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over the whole RecordingJobInformation structure. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sources: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateSource' + description: Identifies the data source of the recording job. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformationExtension: + title: tt_RecordingJobStateInformationExtension + type: object + description: '' + xml: + name: RecordingJobStateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateSource: + title: tt_RecordingJobStateSource + required: + - SourceToken + - State + - Tracks + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: Identifies the data source of the recording job. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateTracks' + - description: List of track items. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTracks: + title: tt_RecordingJobStateTracks + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateTrack' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTrack: + title: tt_RecordingJobStateTrack + required: + - SourceTag + - Destination + - State + type: object + properties: + SourceTag: + type: string + description: Identifies the track of the data source that provides the data. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: Indicates the destination track. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: >- + Optionally holds an implementation defined string value that describes the error. + The string should be in the English language. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: >- + Provides the job state of the track. The valid + values of state shall be “Idle”, “Active” and “Error”. If state equals “Error”, the Error field may be filled in with an implementation defined value. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingJobsResponseItem: + title: tt_GetRecordingJobsResponseItem + required: + - JobToken + - JobConfiguration + type: object + properties: + JobToken: + maxLength: 64 + type: string + xml: + name: JobToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JobConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfiguration' + - xml: + name: JobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingJobsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayConfiguration: + title: tt_ReplayConfiguration + required: + - SessionTimeout + type: object + properties: + SessionTimeout: + type: string + description: The RTSP session timeout. + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration parameters for the replay service. + xml: + name: ReplayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngine: + title: tt_AnalyticsEngine + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngine + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AnalyticsDeviceEngineConfiguration: + title: tt_AnalyticsDeviceEngineConfiguration + required: + - EngineConfiguration + type: object + properties: + EngineConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_EngineConfiguration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceEngineConfigurationExtension: + title: tt_AnalyticsDeviceEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsDeviceEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EngineConfiguration: + title: tt_EngineConfiguration + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + type: object + properties: + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineInputInfo: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfo' + - xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfo: + title: tt_AnalyticsEngineInputInfo + type: object + properties: + InputInfo: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: InputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfoExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfoExtension: + title: tt_AnalyticsEngineInputInfoExtension + type: object + description: '' + xml: + name: AnalyticsEngineInputInfoExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInput: + title: tt_AnalyticsEngineInput + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + properties: + SourceIdentification: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentification' + - xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoInput: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - xml: + name: VideoInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataInput: + allOf: + - $ref: '#/components/schemas/tt_MetadataInput' + - xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_SourceIdentification: + title: tt_SourceIdentification + required: + - Name + - Token + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + type: array + items: + maxLength: 64 + type: string + xml: + name: Token + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentificationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceIdentificationExtension: + title: tt_SourceIdentificationExtension + type: object + description: '' + xml: + name: SourceIdentificationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInput: + title: tt_MetadataInput + type: object + properties: + MetadataConfig: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataInputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInputExtension: + title: tt_MetadataInputExtension + type: object + description: '' + xml: + name: MetadataInputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineControl: + title: tt_AnalyticsEngineControl + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + properties: + EngineToken: + maxLength: 64 + type: string + description: Token of the analytics engine (AnalyticsEngine) being controlled. + xml: + name: EngineToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EngineConfigToken: + maxLength: 64 + type: string + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect. + xml: + name: EngineConfigToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InputToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputToken + attribute: false + wrapped: false + description: Tokens of the input (AnalyticsEngineInput) configuration applied. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: ReceiverToken + attribute: false + wrapped: false + description: Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subscription: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: Subscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ModeOfOperation' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_ModeOfOperation: + title: tt_ModeOfOperation + enum: + - Idle + - Active + - Unknown + type: string + description: '' + xml: + name: ModeOfOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsStateInformation: + title: tt_AnalyticsStateInformation + required: + - AnalyticsEngineControlToken + - State + type: object + properties: + AnalyticsEngineControlToken: + maxLength: 64 + type: string + description: Token of the control object whose status is requested. + xml: + name: AnalyticsEngineControlToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsState' + - xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsState: + title: tt_AnalyticsState + required: + - State + type: object + properties: + Error: + type: string + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayload: + title: tt_ActionEngineEventPayload + type: object + properties: + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + xml: + name: RequestInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + xml: + name: ResponseInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + xml: + name: Fault + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ActionEngineEventPayloadExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Action Engine Event Payload data structure contains the information about the ONVIF command invocations. Since this event could be generated by other or proprietary actions, the command invocation specific fields are defined as optional and additional extension mechanism is provided for future or additional action definitions. + xml: + name: ActionEngineEventPayload + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayloadExtension: + title: tt_ActionEngineEventPayloadExtension + type: object + description: '' + xml: + name: ActionEngineEventPayloadExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassType: + title: tt_AudioClassType + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + type: string + description: >- + AudioClassType acceptable values are; + gun_shot, scream, glass_breaking, tire_screech + xml: + name: AudioClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassCandidate: + title: tt_AudioClassCandidate + required: + - Type + - Likelihood + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_AudioClassType' + - description: Indicates audio class label + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + description: A likelihood/probability that the corresponding audio event belongs to this class. The sum of the likelihoods shall NOT exceed 1 + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptor: + title: tt_AudioClassDescriptor + type: object + properties: + ClassCandidate: + type: array + items: + $ref: '#/components/schemas/tt_AudioClassCandidate' + description: Array of audio class label and class probability + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioClassDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptorExtension: + title: tt_AudioClassDescriptorExtension + type: object + description: '' + xml: + name: AudioClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActiveConnection: + title: tt_ActiveConnection + required: + - CurrentBitrate + - CurrentFps + type: object + properties: + CurrentBitrate: + type: number + xml: + name: CurrentBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentFps: + type: number + xml: + name: CurrentFps + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ActiveConnection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatus: + title: tt_ProfileStatus + type: object + properties: + ActiveConnections: + type: array + items: + $ref: '#/components/schemas/tt_ActiveConnection' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatusExtension: + title: tt_ProfileStatusExtension + type: object + description: '' + xml: + name: ProfileStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDReference: + title: tt_OSDReference + type: object + description: '' + xml: + name: OSDReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDType: + title: tt_OSDType + enum: + - Text + - Image + - Extended + type: string + description: '' + xml: + name: OSDType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfiguration: + title: tt_OSDPosConfiguration + required: + - Type + type: object + properties: + Type: + type: string + description: 'For OSD position type, following are the pre-defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Pos: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Pos + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDPosConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfigurationExtension: + title: tt_OSDPosConfigurationExtension + type: object + description: '' + xml: + name: OSDPosConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColor: + title: tt_OSDColor + required: + - Color + type: object + properties: + Transparent: + type: integer + format: int32 + xml: + name: Transparent + prefix: tt + attribute: true + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: 'The value range of "Transparent" could be defined by vendors only should follow this rule: the minimum value means non-transparent and the maximum value maens fully transparent.' + xml: + name: OSDColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfiguration: + title: tt_OSDTextConfiguration + required: + - Type + type: object + properties: + IsPersistentText: + type: 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. + xml: + name: IsPersistentText + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: 'The following OSD Text Type are defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: string + 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:' + xml: + name: DateFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: string + 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:' + xml: + name: TimeFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSize: + type: integer + description: Font size of the text in pt. + format: int32 + xml: + name: FontSize + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Font color of the text. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Background color of the text. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PlainText: + type: string + description: The content of text to be displayed. + xml: + name: PlainText + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfigurationExtension: + title: tt_OSDTextConfigurationExtension + type: object + description: '' + xml: + name: OSDTextConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfiguration: + title: tt_OSDImgConfiguration + required: + - ImgPath + type: object + properties: + ImgPath: + type: string + description: The URI of the image which to be displayed. + xml: + name: ImgPath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfigurationExtension: + title: tt_OSDImgConfigurationExtension + type: object + description: '' + xml: + name: OSDImgConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorspaceRange: + title: tt_ColorspaceRange + required: + - X + - Y + - Z + - Colorspace + type: object + properties: + X: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Y: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Y + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Z: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Z + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorspaceRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptions: + title: tt_ColorOptions + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the colors supported. Either list each color or define the range of color values. + xml: + name: ColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptions: + title: tt_OSDColorOptions + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorOptions' + - description: Optional list of supported colors. + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transparent: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + xml: + name: Transparent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the option of the color and its transparency. + xml: + name: OSDColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptionsExtension: + title: tt_OSDColorOptionsExtension + type: object + description: '' + xml: + name: OSDColorOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptions: + title: tt_OSDTextOptions + required: + - Type + type: object + properties: + Type: + type: array + items: + type: string + xml: + name: Type + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSizeRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the font size value. + xml: + name: FontSizeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: array + items: + type: string + xml: + name: DateFormat + attribute: false + wrapped: false + description: List of supported date format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: array + items: + type: string + xml: + name: TimeFormat + attribute: false + wrapped: false + description: List of supported time format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported font color. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported background color. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptionsExtension: + title: tt_OSDTextOptionsExtension + type: object + description: '' + xml: + name: OSDTextOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptions: + title: tt_OSDImgOptions + required: + - ImagePath + type: object + properties: + FormatsSupported: + type: string + description: List of supported image MIME types, such as "image/png". + xml: + name: FormatsSupported + prefix: tt + attribute: true + wrapped: false + MaxSize: + type: integer + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + xml: + name: MaxSize + prefix: tt + attribute: true + wrapped: false + MaxWidth: + type: integer + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxWidth + prefix: tt + attribute: true + wrapped: false + MaxHeight: + type: integer + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxHeight + prefix: tt + attribute: true + wrapped: false + ImagePath: + type: array + items: + type: string + xml: + name: ImagePath + attribute: false + wrapped: false + description: List of available image URIs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptionsExtension: + title: tt_OSDImgOptionsExtension + type: object + description: '' + xml: + name: OSDImgOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfiguration: + title: tt_OSDConfiguration + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + properties: + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/tt_OSDReference' + - description: Reference to the video source configuration. + xml: + name: VideoSourceConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_OSDType' + - description: Type of OSD. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfiguration' + - description: Position configuration of OSD. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextString: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the value of Type field is Text. + xml: + name: TextString + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Image: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the value of Type field is Image + xml: + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: OSDConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_OSDConfigurationExtension: + title: tt_OSDConfigurationExtension + type: object + description: '' + xml: + name: OSDConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MaximumNumberOfOSDs: + title: tt_MaximumNumberOfOSDs + required: + - Total + type: object + properties: + Total: + type: integer + format: int32 + xml: + name: Total + prefix: tt + attribute: true + wrapped: false + Image: + type: integer + format: int32 + xml: + name: Image + prefix: tt + attribute: true + wrapped: false + PlainText: + type: integer + format: int32 + xml: + name: PlainText + prefix: tt + attribute: true + wrapped: false + Date: + type: integer + format: int32 + xml: + name: Date + prefix: tt + attribute: true + wrapped: false + Time: + type: integer + format: int32 + xml: + name: Time + prefix: tt + attribute: true + wrapped: false + DateAndTime: + type: integer + format: int32 + xml: + name: DateAndTime + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptions: + title: tt_OSDConfigurationOptions + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + type: object + properties: + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/tt_MaximumNumberOfOSDs' + - 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. + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + type: array + items: + $ref: '#/components/schemas/tt_OSDType' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PositionOption: + type: array + items: + type: string + xml: + name: PositionOption + attribute: false + wrapped: false + description: 'List available OSD position type. Following are the pre-defined:' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextOption: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text. + xml: + name: TextOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ImageOption: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image. + xml: + name: ImageOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptionsExtension: + title: tt_OSDConfigurationOptionsExtension + type: object + description: '' + xml: + name: OSDConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FileProgress: + title: tt_FileProgress + required: + - FileName + - Progress + type: object + properties: + FileName: + type: string + description: Exported file name + xml: + name: FileName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Progress: + type: number + description: Normalized percentage completion for uploading the exported file + xml: + name: Progress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgress: + title: tt_ArrayOfFileProgress + type: object + properties: + FileProgress: + type: array + items: + $ref: '#/components/schemas/tt_FileProgress' + description: Exported file name and export progress information + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ArrayOfFileProgressExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ArrayOfFileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgressExtension: + title: tt_ArrayOfFileProgressExtension + type: object + description: '' + xml: + name: ArrayOfFileProgressExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePath: + title: tt_StorageReferencePath + required: + - StorageToken + type: object + properties: + StorageToken: + maxLength: 64 + type: string + description: identifier of an existing Storage Configuration. + xml: + name: StorageToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePath: + type: string + description: gives the relative directory path on the storage + xml: + name: RelativePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_StorageReferencePathExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StorageReferencePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePathExtension: + title: tt_StorageReferencePathExtension + type: object + description: '' + xml: + name: StorageReferencePathExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolygonOptions: + title: tt_PolygonOptions + type: object + properties: + RectangleOnly: + type: boolean + description: >- + True if the device supports defining a region only using Rectangle. + + The rectangle points are still passed using a Polygon element if the device does not support polygon regions. In this case, the points provided in the Polygon element shall represent a rectangle. + xml: + name: RectangleOnly + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VertexLimits: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: >- + Provides the minimum and maximum number of points that can be defined in the Polygon. + + If RectangleOnly is not set to true, this parameter is required. + xml: + name: VertexLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolygonOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xmime_base64Binary: + title: xmime_base64Binary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: base64Binary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + xmime_hexBinary: + title: xmime_hexBinary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: hexBinary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + soapenv_Envelope: + title: soapenv_Envelope + required: + - Body + type: object + properties: + Header: + allOf: + - $ref: '#/components/schemas/soapenv_Header' + - xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Body: + allOf: + - $ref: '#/components/schemas/soapenv_Body' + - xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: Envelope + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Header: + title: soapenv_Header + type: object + description: Elements replacing the wildcard MUST be namespace qualified, but can be in the targetNamespace + xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Body: + title: soapenv_Body + type: object + description: '' + xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Fault: + title: soapenv_Fault + required: + - Code + - Reason + type: object + properties: + Code: + allOf: + - $ref: '#/components/schemas/soapenv_faultcode' + - xml: + name: Code + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Reason: + allOf: + - $ref: '#/components/schemas/soapenv_faultreason' + - xml: + name: Reason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Node: + type: string + xml: + name: Node + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Role: + type: string + xml: + name: Role + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Detail: + allOf: + - $ref: '#/components/schemas/soapenv_detail' + - xml: + name: Detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: Fault reporting structure + xml: + name: Fault + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultreason: + title: soapenv_faultreason + required: + - Text + type: object + properties: + Text: + type: array + items: + $ref: '#/components/schemas/soapenv_reasontext' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultreason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_reasontext: + title: soapenv_reasontext + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: reasontext + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcode: + title: soapenv_faultcode + required: + - Value + type: object + properties: + Value: + allOf: + - $ref: '#/components/schemas/soapenv_faultcodeEnum' + - xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcodeEnum: + title: soapenv_faultcodeEnum + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + type: string + description: '' + xml: + name: faultcodeEnum + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_subcode: + title: soapenv_subcode + required: + - Value + type: object + properties: + Value: + type: string + xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_detail: + title: soapenv_detail + type: object + description: '' + xml: + name: detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_NotUnderstoodType: + title: soapenv_NotUnderstoodType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: NotUnderstoodType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_SupportedEnvType: + title: soapenv_SupportedEnvType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: SupportedEnvType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_UpgradeType: + title: soapenv_UpgradeType + required: + - SupportedEnvelope + type: object + properties: + SupportedEnvelope: + type: array + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: UpgradeType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + wsnt_QueryExpressionType: + title: wsnt_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_TopicExpressionType: + title: wsnt_TopicExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_FilterType: + title: wsnt_FilterType + type: object + description: '' + xml: + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicyType: + title: wsnt_SubscriptionPolicyType + type: object + description: '' + xml: + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationProducerRP: + title: wsnt_NotificationProducerRP + type: object + properties: + TopicExpression: + type: array + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + default: true + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsa_EndpointReferenceType: + title: wsa_EndpointReferenceType + required: + - Address + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsnt_SubscriptionManagerRP: + title: wsnt_SubscriptionManagerRP + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CreationTime: + type: string + format: date-time + xml: + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationMessageHolderType: + title: wsnt_NotificationMessageHolderType + required: + - Message + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Notify: + title: wsnt_Notify + required: + - NotificationMessage + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UseRaw: + title: wsnt_UseRaw + type: object + description: '' + xml: + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Subscribe: + title: wsnt_Subscribe + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeResponse: + title: wsnt_SubscribeResponse + required: + - SubscriptionReference + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessage: + title: wsnt_GetCurrentMessage + required: + - Topic + type: object + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessageResponse: + title: wsnt_GetCurrentMessageResponse + type: object + description: '' + xml: + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + title: wsnt_SubscribeCreationFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidFilterFaultType: + title: wsnt_InvalidFilterFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - UnknownFilter + type: object + properties: + UnknownFilter: + type: array + items: + type: string + xml: + name: UnknownFilter + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicExpressionDialectUnknownFaultType: + title: wsnt_TopicExpressionDialectUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidTopicExpressionFaultType: + title: wsnt_InvalidTopicExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicNotSupportedFaultType: + title: wsnt_TopicNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_MultipleTopicsSpecifiedFaultType: + title: wsnt_MultipleTopicsSpecifiedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidProducerPropertiesExpressionFaultType: + title: wsnt_InvalidProducerPropertiesExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidMessageContentExpressionFaultType: + title: wsnt_InvalidMessageContentExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnrecognizedPolicyRequestFaultType: + title: wsnt_UnrecognizedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnrecognizedPolicy: + type: array + items: + type: string + xml: + name: UnrecognizedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnsupportedPolicyRequestFaultType: + title: wsnt_UnsupportedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnsupportedPolicy: + type: array + items: + type: string + xml: + name: UnsupportedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NotifyMessageNotSupportedFaultType: + title: wsnt_NotifyMessageNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnacceptableInitialTerminationTimeFaultType: + title: wsnt_UnacceptableInitialTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NoCurrentMessageOnTopicFaultType: + title: wsnt_NoCurrentMessageOnTopicFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_GetMessages: + title: wsnt_GetMessages + type: object + properties: + MaximumNumber: + type: integer + format: int32 + xml: + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetMessagesResponse: + title: wsnt_GetMessagesResponse + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPoint: + title: wsnt_DestroyPullPoint + type: object + description: '' + xml: + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPointResponse: + title: wsnt_DestroyPullPointResponse + type: object + description: '' + xml: + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToGetMessagesFaultType: + title: wsnt_UnableToGetMessagesFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnableToDestroyPullPointFaultType: + title: wsnt_UnableToDestroyPullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_CreatePullPoint: + title: wsnt_CreatePullPoint + type: object + description: '' + xml: + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_CreatePullPointResponse: + title: wsnt_CreatePullPointResponse + required: + - PullPoint + type: object + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToCreatePullPointFaultType: + title: wsnt_UnableToCreatePullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Renew: + title: wsnt_Renew + required: + - TerminationTime + type: object + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_RenewResponse: + title: wsnt_RenewResponse + required: + - TerminationTime + type: object + properties: + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnacceptableTerminationTimeFaultType: + title: wsnt_UnacceptableTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Unsubscribe: + title: wsnt_Unsubscribe + type: object + description: '' + xml: + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnsubscribeResponse: + title: wsnt_UnsubscribeResponse + type: object + description: '' + xml: + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToDestroySubscriptionFaultType: + title: wsnt_UnableToDestroySubscriptionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_PauseSubscription: + title: wsnt_PauseSubscription + type: object + description: '' + xml: + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseSubscriptionResponse: + title: wsnt_PauseSubscriptionResponse + type: object + description: '' + xml: + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscription: + title: wsnt_ResumeSubscription + type: object + description: '' + xml: + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscriptionResponse: + title: wsnt_ResumeSubscriptionResponse + type: object + description: '' + xml: + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseFailedFaultType: + title: wsnt_PauseFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_ResumeFailedFaultType: + title: wsnt_ResumeFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xop_Include: + title: xop_Include + required: + - href + type: object + properties: + href: + type: string + xml: + name: href + prefix: xop + attribute: true + wrapped: false + description: '' + xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + wsa_ReferenceParametersType: + title: wsa_ReferenceParametersType + type: object + description: '' + xml: + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_MetadataType: + title: wsa_MetadataType + type: object + description: '' + xml: + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedURIType: + title: wsa_AttributedURIType + type: object + description: '' + xml: + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelatesToType: + title: wsa_RelatesToType + type: object + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + name: RelationshipType + attribute: true + wrapped: false + description: '' + xml: + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelationshipTypeOpenEnum: + title: wsa_RelationshipTypeOpenEnum + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + description: '' + xml: + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_FaultCodesOpenEnumType: + title: wsa_FaultCodesOpenEnumType + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + description: '' + xml: + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedQNameType: + title: wsa_AttributedQNameType + type: object + description: '' + xml: + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedAnyType: + title: wsa_AttributedAnyType + type: object + description: '' + xml: + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ProblemActionType: + title: wsa_ProblemActionType + type: object + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + SoapAction: + type: string + xml: + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsrf-bf_BaseFaultType: + title: wsrf-bf_BaseFaultType + required: + - Timestamp + type: object + properties: + Timestamp: + type: string + format: date-time + xml: + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Description: + type: array + items: + $ref: '#/components/schemas/wsrf-bf_Description' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + description: '' + xml: + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Documentation: + title: wstop_Documentation + type: object + description: '' + xml: + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_ExtensibleDocumented: + title: wstop_ExtensibleDocumented + type: object + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_QueryExpressionType: + title: wstop_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_TopicNamespaceType: + title: wstop_TopicNamespaceType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - targetNamespace + type: object + properties: + Topic: + type: array + items: + $ref: '#/components/schemas/wstop_Topic' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + name: + type: string + xml: + name: name + attribute: true + wrapped: false + targetNamespace: + type: string + xml: + name: targetNamespace + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + name: final + attribute: true + wrapped: false + xml: + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicType: + title: wstop_TopicType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - name + type: object + properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - {} + name: + type: string + xml: + attribute: true + wrapped: false + messageTypes: + type: array + items: + type: string + description: '' + xml: + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + attribute: true + wrapped: false + xml: + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicSetType: + title: wstop_TopicSetType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + Choice0: + title: Choice0 + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice1: + title: Choice1 + type: object + properties: + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice2: + title: Choice2 + type: object + properties: + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice3: + title: Choice3 + type: object + properties: + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GetCurrentPresetRequest: + title: GetCurrentPresetRequest + required: + - GetCurrentPreset + type: object + properties: + GetCurrentPreset: + allOf: + - $ref: '#/components/schemas/tns_GetCurrentPreset' + - {} + GetCurrentPresetResponse: + title: GetCurrentPresetResponse + required: + - GetCurrentPresetResponse + type: object + properties: + GetCurrentPresetResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCurrentPresetResponse' + - xml: + name: GetCurrentPresetResponse + attribute: false + wrapped: false + xml: + name: GetCurrentPresetResponse + attribute: false + wrapped: false + GetImagingSettingsRequest: + title: GetImagingSettingsRequest + required: + - GetImagingSettings + type: object + properties: + GetImagingSettings: + allOf: + - $ref: '#/components/schemas/tns_GetImagingSettings' + - {} + GetImagingSettingsResponse: + title: GetImagingSettingsResponse + required: + - GetImagingSettingsResponse + type: object + properties: + GetImagingSettingsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetImagingSettingsResponse' + - xml: + name: GetImagingSettingsResponse + attribute: false + wrapped: false + xml: + name: GetImagingSettingsResponse + attribute: false + wrapped: false + GetMoveOptionsRequest: + title: GetMoveOptionsRequest + required: + - GetMoveOptions + type: object + properties: + GetMoveOptions: + allOf: + - $ref: '#/components/schemas/tns_GetMoveOptions' + - {} + GetMoveOptionsResponse: + title: GetMoveOptionsResponse + required: + - GetMoveOptionsResponse + type: object + properties: + GetMoveOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMoveOptionsResponse' + - xml: + name: GetMoveOptionsResponse + attribute: false + wrapped: false + xml: + name: GetMoveOptionsResponse + attribute: false + wrapped: false + GetOptionsRequest: + title: GetOptionsRequest + required: + - GetOptions + type: object + properties: + GetOptions: + allOf: + - $ref: '#/components/schemas/tns_GetOptions' + - {} + GetOptionsResponse: + title: GetOptionsResponse + required: + - GetOptionsResponse + type: object + properties: + GetOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetOptionsResponse' + - xml: + name: GetOptionsResponse + attribute: false + wrapped: false + xml: + name: GetOptionsResponse + attribute: false + wrapped: false + GetPresetsRequest: + title: GetPresetsRequest + required: + - GetPresets + type: object + properties: + GetPresets: + allOf: + - $ref: '#/components/schemas/tns_GetPresets' + - {} + GetPresetsResponse: + title: GetPresetsResponse + required: + - GetPresetsResponse + type: object + properties: + GetPresetsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPresetsResponse' + - xml: + name: GetPresetsResponse + attribute: false + wrapped: false + xml: + name: GetPresetsResponse + attribute: false + wrapped: false + GetServiceCapabilitiesRequest: + title: GetServiceCapabilitiesRequest + required: + - GetServiceCapabilities + type: object + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + GetServiceCapabilitiesResponse: + title: GetServiceCapabilitiesResponse + required: + - GetServiceCapabilitiesResponse + type: object + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + GetStatusRequest: + title: GetStatusRequest + required: + - GetStatus + type: object + properties: + GetStatus: + allOf: + - $ref: '#/components/schemas/tns_GetStatus' + - {} + GetStatusResponse: + title: GetStatusResponse + required: + - GetStatusResponse + type: object + properties: + GetStatusResponse: + allOf: + - $ref: '#/components/schemas/tns_GetStatusResponse' + - xml: + name: GetStatusResponse + attribute: false + wrapped: false + xml: + name: GetStatusResponse + attribute: false + wrapped: false + MoveRequest: + title: MoveRequest + required: + - Move + type: object + properties: + Move: + allOf: + - $ref: '#/components/schemas/tns_Move' + - {} + MoveResponse: + title: MoveResponse + required: + - MoveResponse + type: object + properties: + MoveResponse: + allOf: + - $ref: '#/components/schemas/tns_MoveResponse' + - xml: + name: MoveResponse + attribute: false + wrapped: false + xml: + name: MoveResponse + attribute: false + wrapped: false + SetCurrentPresetRequest: + title: SetCurrentPresetRequest + required: + - SetCurrentPreset + type: object + properties: + SetCurrentPreset: + allOf: + - $ref: '#/components/schemas/tns_SetCurrentPreset' + - {} + SetCurrentPresetResponse: + title: SetCurrentPresetResponse + required: + - SetCurrentPresetResponse + type: object + properties: + SetCurrentPresetResponse: + allOf: + - $ref: '#/components/schemas/tns_SetCurrentPresetResponse' + - xml: + name: SetCurrentPresetResponse + attribute: false + wrapped: false + xml: + name: SetCurrentPresetResponse + attribute: false + wrapped: false + SetImagingSettingsRequest: + title: SetImagingSettingsRequest + required: + - SetImagingSettings + type: object + properties: + SetImagingSettings: + allOf: + - $ref: '#/components/schemas/tns_SetImagingSettings' + - {} + SetImagingSettingsResponse: + title: SetImagingSettingsResponse + required: + - SetImagingSettingsResponse + type: object + properties: + SetImagingSettingsResponse: + allOf: + - $ref: '#/components/schemas/tns_SetImagingSettingsResponse' + - xml: + name: SetImagingSettingsResponse + attribute: false + wrapped: false + xml: + name: SetImagingSettingsResponse + attribute: false + wrapped: false + StopRequest: + title: StopRequest + required: + - Stop + type: object + properties: + Stop: + allOf: + - $ref: '#/components/schemas/tns_Stop' + - {} + StopResponse: + title: StopResponse + required: + - StopResponse + type: object + properties: + StopResponse: + allOf: + - $ref: '#/components/schemas/tns_StopResponse' + - xml: + name: StopResponse + attribute: false + wrapped: false + xml: + name: StopResponse + attribute: false + wrapped: false + tns1_space: + title: tns1_space + enum: + - default + - preserve + type: string + description: '' + xml: + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + attribute: false + wrapped: false + tt_ColorCluster: + title: tt_ColorCluster + required: + - Color + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Weight: + type: number + xml: + name: Weight + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Covariance: + allOf: + - $ref: '#/components/schemas/tt_ColorCovariance' + - xml: + name: Covariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorCluster + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice0: + title: tt_ColorOptionsChoice0 + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice1: + title: tt_ColorOptionsChoice1 + type: object + properties: + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItem: + title: tt_ElementItem + required: + - Name + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + description: Complex value structure. + xml: + name: ElementItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItemDescription: + title: tt_ElementItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: The type of the item. The Type must reference a defined type. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a complex type. The Type must reference a defined type. + xml: + name: ElementItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Messages: + title: tt_Messages + allOf: + - $ref: '#/components/schemas/tt_MessageDescription' + - required: + - ParentTopic + type: object + properties: + ParentTopic: + type: string + description: The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected. + xml: + name: ParentTopic + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Messages + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + tt_SimpleItem: + title: tt_SimpleItem + required: + - Name + - Value + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Value: + type: string + description: Item value. The type is defined in the corresponding description. + xml: + name: Value + prefix: tt + attribute: true + wrapped: false + description: Value name pair as defined by the corresponding description. + xml: + name: SimpleItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SimpleItemDescription: + title: tt_SimpleItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + name: SimpleItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SubscriptionPolicy: + title: tt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + wsnt_Message: + title: wsnt_Message + type: object + description: '' + xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicy: + title: wsnt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsrf-bf_Description: + title: wsrf-bf_Description + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_ErrorCode: + title: wsrf-bf_ErrorCode + required: + - dialect + type: object + properties: + dialect: + type: string + xml: + name: dialect + attribute: true + wrapped: false + description: '' + xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_FaultCause: + title: wsrf-bf_FaultCause + type: object + description: '' + xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Topic: + title: wstop_Topic + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - type: object + properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + name: parent + attribute: true + wrapped: false + xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object +tags: +- name: ImagingBinding + description: '' diff --git a/doc/openapi/ref/media.yaml b/doc/openapi/ref/media.yaml new file mode 100644 index 00000000..51f9d26d --- /dev/null +++ b/doc/openapi/ref/media.yaml @@ -0,0 +1,28997 @@ +openapi: 3.0.0 +info: + title: Untitled API + contact: {} + version: '1.0' +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +paths: + /GetServiceCapabilities: + post: + tags: + - MediaBinding + summary: GetServiceCapabilities + description: Returns the capabilities of the media service. The result is returned in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + name: GetServiceCapabilitiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSources: + post: + tags: + - MediaBinding + summary: GetVideoSources + description: This command lists all available physical video inputs of the device. + operationId: GetVideoSources + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourcesRequest' + - xml: + name: GetVideoSourcesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourcesResponse' + - xml: + name: GetVideoSourcesResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioSources: + post: + tags: + - MediaBinding + summary: GetAudioSources + description: This command lists all available physical audio inputs of the device. + operationId: GetAudioSources + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourcesRequest' + - xml: + name: GetAudioSourcesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourcesResponse' + - xml: + name: GetAudioSourcesResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioOutputs: + post: + tags: + - MediaBinding + summary: GetAudioOutputs + description: This command lists all available physical audio outputs of the device. + operationId: GetAudioOutputs + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputsRequest' + - xml: + name: GetAudioOutputsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputsResponse' + - xml: + name: GetAudioOutputsResponse + attribute: false + wrapped: false + deprecated: false + /CreateProfile: + post: + tags: + - MediaBinding + summary: CreateProfile + 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. + operationId: CreateProfile + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateProfileRequest' + - xml: + name: CreateProfileRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateProfileResponse' + - xml: + name: CreateProfileResponse + attribute: false + wrapped: false + deprecated: false + /GetProfile: + post: + tags: + - MediaBinding + summary: GetProfile + description: If the profile token is already known, a profile can be fetched through the GetProfile command. + operationId: GetProfile + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetProfileRequest' + - xml: + name: GetProfileRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetProfileResponse' + - xml: + name: GetProfileResponse + attribute: false + wrapped: false + deprecated: false + /GetProfiles: + post: + tags: + - MediaBinding + summary: GetProfiles + 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. + operationId: GetProfiles + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetProfilesRequest' + - xml: + name: GetProfilesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetProfilesResponse' + - xml: + name: GetProfilesResponse + attribute: false + wrapped: false + deprecated: false + /AddVideoEncoderConfiguration: + post: + tags: + - MediaBinding + summary: AddVideoEncoderConfiguration + 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. + operationId: AddVideoEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddVideoEncoderConfigurationRequest' + - xml: + name: AddVideoEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddVideoEncoderConfigurationResponse' + - xml: + name: AddVideoEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveVideoEncoderConfiguration: + post: + tags: + - MediaBinding + summary: RemoveVideoEncoderConfiguration + 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. + operationId: RemoveVideoEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveVideoEncoderConfigurationRequest' + - xml: + name: RemoveVideoEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveVideoEncoderConfigurationResponse' + - xml: + name: RemoveVideoEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddVideoSourceConfiguration: + post: + tags: + - MediaBinding + summary: AddVideoSourceConfiguration + 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. + operationId: AddVideoSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddVideoSourceConfigurationRequest' + - xml: + name: AddVideoSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddVideoSourceConfigurationResponse' + - xml: + name: AddVideoSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveVideoSourceConfiguration: + post: + tags: + - MediaBinding + summary: RemoveVideoSourceConfiguration + 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. + operationId: RemoveVideoSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveVideoSourceConfigurationRequest' + - xml: + name: RemoveVideoSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveVideoSourceConfigurationResponse' + - xml: + name: RemoveVideoSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddAudioEncoderConfiguration: + post: + tags: + - MediaBinding + summary: AddAudioEncoderConfiguration + description: "This operation adds an AudioEncoderConfiguration to an existing media profile. If a \nconfiguration exists in the media profile, it will be replaced. The change shall be persistent. A device shall\nsupport adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall\nsupport streaming audio data of such a profile." + operationId: AddAudioEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioEncoderConfigurationRequest' + - xml: + name: AddAudioEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioEncoderConfigurationResponse' + - xml: + name: AddAudioEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveAudioEncoderConfiguration: + post: + tags: + - MediaBinding + summary: RemoveAudioEncoderConfiguration + 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. + operationId: RemoveAudioEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioEncoderConfigurationRequest' + - xml: + name: RemoveAudioEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioEncoderConfigurationResponse' + - xml: + name: RemoveAudioEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddAudioSourceConfiguration: + post: + tags: + - MediaBinding + summary: AddAudioSourceConfiguration + 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. + operationId: AddAudioSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioSourceConfigurationRequest' + - xml: + name: AddAudioSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioSourceConfigurationResponse' + - xml: + name: AddAudioSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveAudioSourceConfiguration: + post: + tags: + - MediaBinding + summary: RemoveAudioSourceConfiguration + 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. + operationId: RemoveAudioSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioSourceConfigurationRequest' + - xml: + name: RemoveAudioSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioSourceConfigurationResponse' + - xml: + name: RemoveAudioSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddPTZConfiguration: + post: + tags: + - MediaBinding + summary: AddPTZConfiguration + 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. + operationId: AddPTZConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddPTZConfigurationRequest' + - xml: + name: AddPTZConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddPTZConfigurationResponse' + - xml: + name: AddPTZConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemovePTZConfiguration: + post: + tags: + - MediaBinding + summary: RemovePTZConfiguration + 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. + operationId: RemovePTZConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemovePTZConfigurationRequest' + - xml: + name: RemovePTZConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemovePTZConfigurationResponse' + - xml: + name: RemovePTZConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddVideoAnalyticsConfiguration: + post: + tags: + - MediaBinding + summary: AddVideoAnalyticsConfiguration + 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. + operationId: AddVideoAnalyticsConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddVideoAnalyticsConfigurationRequest' + - xml: + name: AddVideoAnalyticsConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddVideoAnalyticsConfigurationResponse' + - xml: + name: AddVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveVideoAnalyticsConfiguration: + post: + tags: + - MediaBinding + summary: RemoveVideoAnalyticsConfiguration + 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. + operationId: RemoveVideoAnalyticsConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveVideoAnalyticsConfigurationRequest' + - xml: + name: RemoveVideoAnalyticsConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveVideoAnalyticsConfigurationResponse' + - xml: + name: RemoveVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddMetadataConfiguration: + post: + tags: + - MediaBinding + summary: AddMetadataConfiguration + 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. + operationId: AddMetadataConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddMetadataConfigurationRequest' + - xml: + name: AddMetadataConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddMetadataConfigurationResponse' + - xml: + name: AddMetadataConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveMetadataConfiguration: + post: + tags: + - MediaBinding + summary: RemoveMetadataConfiguration + 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. + operationId: RemoveMetadataConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveMetadataConfigurationRequest' + - xml: + name: RemoveMetadataConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveMetadataConfigurationResponse' + - xml: + name: RemoveMetadataConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddAudioOutputConfiguration: + post: + tags: + - MediaBinding + summary: AddAudioOutputConfiguration + 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. + operationId: AddAudioOutputConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioOutputConfigurationRequest' + - xml: + name: AddAudioOutputConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioOutputConfigurationResponse' + - xml: + name: AddAudioOutputConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveAudioOutputConfiguration: + post: + tags: + - MediaBinding + summary: RemoveAudioOutputConfiguration + 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. + operationId: RemoveAudioOutputConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioOutputConfigurationRequest' + - xml: + name: RemoveAudioOutputConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioOutputConfigurationResponse' + - xml: + name: RemoveAudioOutputConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /AddAudioDecoderConfiguration: + post: + tags: + - MediaBinding + summary: AddAudioDecoderConfiguration + 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. + operationId: AddAudioDecoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioDecoderConfigurationRequest' + - xml: + name: AddAudioDecoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddAudioDecoderConfigurationResponse' + - xml: + name: AddAudioDecoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveAudioDecoderConfiguration: + post: + tags: + - MediaBinding + summary: RemoveAudioDecoderConfiguration + 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. + operationId: RemoveAudioDecoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioDecoderConfigurationRequest' + - xml: + name: RemoveAudioDecoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveAudioDecoderConfigurationResponse' + - xml: + name: RemoveAudioDecoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /DeleteProfile: + post: + tags: + - MediaBinding + summary: DeleteProfile + description: This operation deletes a profile. This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles + operationId: DeleteProfile + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteProfileRequest' + - xml: + name: DeleteProfileRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteProfileResponse' + - xml: + name: DeleteProfileResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceConfigurations: + post: + tags: + - MediaBinding + summary: GetVideoSourceConfigurations + 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. + operationId: GetVideoSourceConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationsRequest' + - xml: + name: GetVideoSourceConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationsResponse' + - xml: + name: GetVideoSourceConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoEncoderConfigurations: + post: + tags: + - MediaBinding + summary: GetVideoEncoderConfigurations + 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. + operationId: GetVideoEncoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationsRequest' + - xml: + name: GetVideoEncoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationsResponse' + - xml: + name: GetVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioSourceConfigurations: + post: + tags: + - MediaBinding + summary: GetAudioSourceConfigurations + 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. + operationId: GetAudioSourceConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationsRequest' + - xml: + name: GetAudioSourceConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationsResponse' + - xml: + name: GetAudioSourceConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioEncoderConfigurations: + post: + tags: + - MediaBinding + summary: GetAudioEncoderConfigurations + 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. + operationId: GetAudioEncoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationsRequest' + - xml: + name: GetAudioEncoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationsResponse' + - xml: + name: GetAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoAnalyticsConfigurations: + post: + tags: + - MediaBinding + summary: GetVideoAnalyticsConfigurations + 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. + operationId: GetVideoAnalyticsConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoAnalyticsConfigurationsRequest' + - xml: + name: GetVideoAnalyticsConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoAnalyticsConfigurationsResponse' + - xml: + name: GetVideoAnalyticsConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetMetadataConfigurations: + post: + tags: + - MediaBinding + summary: GetMetadataConfigurations + description: This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command. + operationId: GetMetadataConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationsRequest' + - xml: + name: GetMetadataConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationsResponse' + - xml: + name: GetMetadataConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioOutputConfigurations: + post: + tags: + - MediaBinding + summary: GetAudioOutputConfigurations + 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. + operationId: GetAudioOutputConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationsRequest' + - xml: + name: GetAudioOutputConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationsResponse' + - xml: + name: GetAudioOutputConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioDecoderConfigurations: + post: + tags: + - MediaBinding + summary: GetAudioDecoderConfigurations + 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. + operationId: GetAudioDecoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationsRequest' + - xml: + name: GetAudioDecoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationsResponse' + - xml: + name: GetAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceConfiguration: + post: + tags: + - MediaBinding + summary: GetVideoSourceConfiguration + description: If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command. + operationId: GetVideoSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationRequest' + - xml: + name: GetVideoSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationResponse' + - xml: + name: GetVideoSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoEncoderConfiguration: + post: + tags: + - MediaBinding + summary: GetVideoEncoderConfiguration + description: If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. + operationId: GetVideoEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationRequest' + - xml: + name: GetVideoEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationResponse' + - xml: + name: GetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioSourceConfiguration: + post: + tags: + - MediaBinding + summary: GetAudioSourceConfiguration + description: The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known. An + operationId: GetAudioSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationRequest' + - xml: + name: GetAudioSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationResponse' + - xml: + name: GetAudioSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioEncoderConfiguration: + post: + tags: + - MediaBinding + summary: GetAudioEncoderConfiguration + description: The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known. + operationId: GetAudioEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationRequest' + - xml: + name: GetAudioEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationResponse' + - xml: + name: GetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoAnalyticsConfiguration: + post: + tags: + - MediaBinding + summary: GetVideoAnalyticsConfiguration + description: The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known. + operationId: GetVideoAnalyticsConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoAnalyticsConfigurationRequest' + - xml: + name: GetVideoAnalyticsConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoAnalyticsConfigurationResponse' + - xml: + name: GetVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetMetadataConfiguration: + post: + tags: + - MediaBinding + summary: GetMetadataConfiguration + description: The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. + operationId: GetMetadataConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationRequest' + - xml: + name: GetMetadataConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationResponse' + - xml: + name: GetMetadataConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioOutputConfiguration: + post: + tags: + - MediaBinding + summary: GetAudioOutputConfiguration + description: If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command. + operationId: GetAudioOutputConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationRequest' + - xml: + name: GetAudioOutputConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationResponse' + - xml: + name: GetAudioOutputConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioDecoderConfiguration: + post: + tags: + - MediaBinding + summary: GetAudioDecoderConfiguration + description: If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command. + operationId: GetAudioDecoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationRequest' + - xml: + name: GetAudioDecoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationResponse' + - xml: + name: GetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleVideoEncoderConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleVideoEncoderConfigurations + 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. + operationId: GetCompatibleVideoEncoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleVideoEncoderConfigurationsRequest' + - xml: + name: GetCompatibleVideoEncoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleVideoEncoderConfigurationsResponse' + - xml: + name: GetCompatibleVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleVideoSourceConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleVideoSourceConfigurations + 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. + operationId: GetCompatibleVideoSourceConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleVideoSourceConfigurationsRequest' + - xml: + name: GetCompatibleVideoSourceConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleVideoSourceConfigurationsResponse' + - xml: + name: GetCompatibleVideoSourceConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleAudioEncoderConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleAudioEncoderConfigurations + 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. + operationId: GetCompatibleAudioEncoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioEncoderConfigurationsRequest' + - xml: + name: GetCompatibleAudioEncoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioEncoderConfigurationsResponse' + - xml: + name: GetCompatibleAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleAudioSourceConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleAudioSourceConfigurations + 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. + operationId: GetCompatibleAudioSourceConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioSourceConfigurationsRequest' + - xml: + name: GetCompatibleAudioSourceConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioSourceConfigurationsResponse' + - xml: + name: GetCompatibleAudioSourceConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleVideoAnalyticsConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleVideoAnalyticsConfigurations + 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. + operationId: GetCompatibleVideoAnalyticsConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleVideoAnalyticsConfigurationsRequest' + - xml: + name: GetCompatibleVideoAnalyticsConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleVideoAnalyticsConfigurationsResponse' + - xml: + name: GetCompatibleVideoAnalyticsConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleMetadataConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleMetadataConfigurations + 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. + operationId: GetCompatibleMetadataConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleMetadataConfigurationsRequest' + - xml: + name: GetCompatibleMetadataConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleMetadataConfigurationsResponse' + - xml: + name: GetCompatibleMetadataConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleAudioOutputConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleAudioOutputConfigurations + 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 \nAddAudioOutputConfiguration command." + operationId: GetCompatibleAudioOutputConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioOutputConfigurationsRequest' + - xml: + name: GetCompatibleAudioOutputConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioOutputConfigurationsResponse' + - xml: + name: GetCompatibleAudioOutputConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleAudioDecoderConfigurations: + post: + tags: + - MediaBinding + summary: GetCompatibleAudioDecoderConfigurations + 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. + operationId: GetCompatibleAudioDecoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioDecoderConfigurationsRequest' + - xml: + name: GetCompatibleAudioDecoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleAudioDecoderConfigurationsResponse' + - xml: + name: GetCompatibleAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoSourceConfiguration: + post: + tags: + - MediaBinding + summary: SetVideoSourceConfiguration + 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. + operationId: SetVideoSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceConfigurationRequest' + - xml: + name: SetVideoSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceConfigurationResponse' + - xml: + name: SetVideoSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoEncoderConfiguration: + post: + tags: + - MediaBinding + summary: SetVideoEncoderConfiguration + 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. + operationId: SetVideoEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoEncoderConfigurationRequest' + - xml: + name: SetVideoEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoEncoderConfigurationResponse' + - xml: + name: SetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioSourceConfiguration: + post: + tags: + - MediaBinding + summary: SetAudioSourceConfiguration + 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. + operationId: SetAudioSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioSourceConfigurationRequest' + - xml: + name: SetAudioSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioSourceConfigurationResponse' + - xml: + name: SetAudioSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioEncoderConfiguration: + post: + tags: + - MediaBinding + summary: SetAudioEncoderConfiguration + 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. + operationId: SetAudioEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioEncoderConfigurationRequest' + - xml: + name: SetAudioEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioEncoderConfigurationResponse' + - xml: + name: SetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoAnalyticsConfiguration: + post: + tags: + - MediaBinding + summary: SetVideoAnalyticsConfiguration + 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. + operationId: SetVideoAnalyticsConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoAnalyticsConfigurationRequest' + - xml: + name: SetVideoAnalyticsConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoAnalyticsConfigurationResponse' + - xml: + name: SetVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetMetadataConfiguration: + post: + tags: + - MediaBinding + summary: SetMetadataConfiguration + 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. + operationId: SetMetadataConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetMetadataConfigurationRequest' + - xml: + name: SetMetadataConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetMetadataConfigurationResponse' + - xml: + name: SetMetadataConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioOutputConfiguration: + post: + tags: + - MediaBinding + summary: SetAudioOutputConfiguration + description: >- + This operation modifies an audio output configuration. The ForcePersistence flag indicates if + + the changes shall remain after reboot of the device. + operationId: SetAudioOutputConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioOutputConfigurationRequest' + - xml: + name: SetAudioOutputConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioOutputConfigurationResponse' + - xml: + name: SetAudioOutputConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioDecoderConfiguration: + post: + tags: + - MediaBinding + summary: SetAudioDecoderConfiguration + description: >- + This operation modifies an audio decoder configuration. The ForcePersistence flag indicates if + + the changes shall remain after reboot of the device. + operationId: SetAudioDecoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioDecoderConfigurationRequest' + - xml: + name: SetAudioDecoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioDecoderConfigurationResponse' + - xml: + name: SetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetVideoSourceConfigurationOptions + 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. + operationId: GetVideoSourceConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationOptionsRequest' + - xml: + name: GetVideoSourceConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationOptionsResponse' + - xml: + name: GetVideoSourceConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoEncoderConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetVideoEncoderConfigurationOptions + description: "This operation returns the available options (supported values and ranges for video encoder \n configuration parameters) when the video encoder parameters are reconfigured." + operationId: GetVideoEncoderConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationOptionsRequest' + - xml: + name: GetVideoEncoderConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationOptionsResponse' + - xml: + name: GetVideoEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioSourceConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetAudioSourceConfigurationOptions + 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. + operationId: GetAudioSourceConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationOptionsRequest' + - xml: + name: GetAudioSourceConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationOptionsResponse' + - xml: + name: GetAudioSourceConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioEncoderConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetAudioEncoderConfigurationOptions + description: >- + This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are + + reconfigured. + operationId: GetAudioEncoderConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationOptionsRequest' + - xml: + name: GetAudioEncoderConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationOptionsResponse' + - xml: + name: GetAudioEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetMetadataConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetMetadataConfigurationOptions + description: This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. + operationId: GetMetadataConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationOptionsRequest' + - xml: + name: GetMetadataConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationOptionsResponse' + - xml: + name: GetMetadataConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioOutputConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetAudioOutputConfigurationOptions + description: This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. + operationId: GetAudioOutputConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationOptionsRequest' + - xml: + name: GetAudioOutputConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationOptionsResponse' + - xml: + name: GetAudioOutputConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioDecoderConfigurationOptions: + post: + tags: + - MediaBinding + summary: GetAudioDecoderConfigurationOptions + description: >- + This command list the audio decoding capabilities for a given profile and configuration of a + + device. + operationId: GetAudioDecoderConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationOptionsRequest' + - xml: + name: GetAudioDecoderConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationOptionsResponse' + - xml: + name: GetAudioDecoderConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetGuaranteedNumberOfVideoEncoderInstances: + post: + tags: + - MediaBinding + summary: GetGuaranteedNumberOfVideoEncoderInstances + description: >- + The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the + + minimum number of guaranteed video encoder instances (applications) per Video Source + + Configuration. + operationId: GetGuaranteedNumberOfVideoEncoderInstances + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetGuaranteedNumberOfVideoEncoderInstancesRequest' + - xml: + name: GetGuaranteedNumberOfVideoEncoderInstancesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetGuaranteedNumberOfVideoEncoderInstancesResponse' + - xml: + name: GetGuaranteedNumberOfVideoEncoderInstancesResponse + attribute: false + wrapped: false + deprecated: false + /GetStreamUri: + post: + tags: + - MediaBinding + summary: GetStreamUri + 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). + operationId: GetStreamUri + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStreamUriRequest' + - xml: + name: GetStreamUriRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStreamUriResponse' + - xml: + name: GetStreamUriResponse + attribute: false + wrapped: false + deprecated: false + /StartMulticastStreaming: + post: + tags: + - MediaBinding + summary: StartMulticastStreaming + 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. + operationId: StartMulticastStreaming + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartMulticastStreamingRequest' + - xml: + name: StartMulticastStreamingRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartMulticastStreamingResponse' + - xml: + name: StartMulticastStreamingResponse + attribute: false + wrapped: false + deprecated: false + /StopMulticastStreaming: + post: + tags: + - MediaBinding + summary: StopMulticastStreaming + description: This command stop multicast streaming using a specified media profile of a device + operationId: StopMulticastStreaming + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopMulticastStreamingRequest' + - xml: + name: StopMulticastStreamingRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopMulticastStreamingResponse' + - xml: + name: StopMulticastStreamingResponse + attribute: false + wrapped: false + deprecated: false + /SetSynchronizationPoint: + post: + tags: + - MediaBinding + summary: SetSynchronizationPoint + 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. + operationId: SetSynchronizationPoint + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSynchronizationPointRequest' + - xml: + name: SetSynchronizationPointRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSynchronizationPointResponse' + - xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + deprecated: false + /GetSnapshotUri: + post: + tags: + - MediaBinding + summary: GetSnapshotUri + 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 a 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. + operationId: GetSnapshotUri + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSnapshotUriRequest' + - xml: + name: GetSnapshotUriRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSnapshotUriResponse' + - xml: + name: GetSnapshotUriResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceModes: + post: + tags: + - MediaBinding + summary: GetVideoSourceModes + 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. + operationId: GetVideoSourceModes + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceModesRequest' + - xml: + name: GetVideoSourceModesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceModesResponse' + - xml: + name: GetVideoSourceModesResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoSourceMode: + post: + tags: + - MediaBinding + summary: SetVideoSourceMode + 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. + operationId: SetVideoSourceMode + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceModeRequest' + - xml: + name: SetVideoSourceModeRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceModeResponse' + - xml: + name: SetVideoSourceModeResponse + attribute: false + wrapped: false + deprecated: false + /GetOSDs: + post: + tags: + - MediaBinding + summary: GetOSDs + description: Get the OSDs. + operationId: GetOSDs + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDsRequest' + - xml: + name: GetOSDsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDsResponse' + - xml: + name: GetOSDsResponse + attribute: false + wrapped: false + deprecated: false + /GetOSD: + post: + tags: + - MediaBinding + summary: GetOSD + description: Get the OSD. + operationId: GetOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDRequest' + - xml: + name: GetOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDResponse' + - xml: + name: GetOSDResponse + attribute: false + wrapped: false + deprecated: false + /GetOSDOptions: + post: + tags: + - MediaBinding + summary: GetOSDOptions + description: Get the OSD Options. + operationId: GetOSDOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDOptionsRequest' + - xml: + name: GetOSDOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDOptionsResponse' + - xml: + name: GetOSDOptionsResponse + attribute: false + wrapped: false + deprecated: false + /SetOSD: + post: + tags: + - MediaBinding + summary: SetOSD + description: Set the OSD + operationId: SetOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetOSDRequest' + - xml: + name: SetOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetOSDResponse' + - xml: + name: SetOSDResponse + attribute: false + wrapped: false + deprecated: false + /CreateOSD: + post: + tags: + - MediaBinding + summary: CreateOSD + description: Create the OSD. + operationId: CreateOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateOSDRequest' + - xml: + name: CreateOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateOSDResponse' + - xml: + name: CreateOSDResponse + attribute: false + wrapped: false + deprecated: false + /DeleteOSD: + post: + tags: + - MediaBinding + summary: DeleteOSD + description: Delete the OSD. + operationId: DeleteOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteOSDRequest' + - xml: + name: DeleteOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteOSDResponse' + - xml: + name: DeleteOSDResponse + attribute: false + wrapped: false + deprecated: false +components: + schemas: + tns_GetServiceCapabilities: + title: tns_GetServiceCapabilities + type: object + description: '' + xml: + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetServiceCapabilitiesResponse: + title: tns_GetServiceCapabilitiesResponse + required: + - Capabilities + type: object + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities' + - description: The capabilities for the media service is returned in the Capabilities element. + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Capabilities: + title: tns_Capabilities + required: + - ProfileCapabilities + - StreamingCapabilities + type: object + properties: + SnapshotUri: + type: boolean + description: Indicates if GetSnapshotUri is supported. + xml: + name: SnapshotUri + prefix: tns + attribute: true + wrapped: false + Rotation: + type: boolean + description: Indicates whether or not Rotation feature is supported. + xml: + name: Rotation + prefix: tns + attribute: true + wrapped: false + VideoSourceMode: + type: boolean + description: Indicates the support for changing video source mode. + xml: + name: VideoSourceMode + prefix: tns + attribute: true + wrapped: false + OSD: + type: boolean + description: Indicates if OSD is supported. + xml: + name: OSD + prefix: tns + attribute: true + wrapped: false + TemporaryOSDText: + type: boolean + description: Indicates the support for temporary osd text configuration. + xml: + name: TemporaryOSDText + prefix: tns + attribute: true + wrapped: false + EXICompression: + type: boolean + description: Indicates the support for the Efficient XML Interchange (EXI) binary XML format. + xml: + name: EXICompression + prefix: tns + attribute: true + wrapped: false + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tns_ProfileCapabilities' + - description: Media profile capabilities. + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tns_StreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ProfileCapabilities: + title: tns_ProfileCapabilities + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles supported. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StreamingCapabilities: + title: tns_StreamingCapabilities + type: object + properties: + RTPMulticast: + type: boolean + description: Indicates support for RTP multicast. + xml: + name: RTPMulticast + prefix: tns + attribute: true + wrapped: false + RTP_TCP: + type: boolean + description: Indicates support for RTP over TCP. + xml: + name: RTP_TCP + prefix: tns + attribute: true + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates support for RTP/RTSP/TCP. + xml: + name: RTP_RTSP_TCP + prefix: tns + attribute: true + wrapped: false + NonAggregateControl: + type: boolean + description: Indicates support for non aggregate RTSP control. + xml: + name: NonAggregateControl + prefix: tns + attribute: true + wrapped: false + NoRTSPStreaming: + type: boolean + description: Indicates the device does not support live media streaming via RTSP. + xml: + name: NoRTSPStreaming + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSources: + title: tns_GetVideoSources + type: object + description: '' + xml: + name: GetVideoSources + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourcesResponse: + title: tns_GetVideoSourcesResponse + type: object + properties: + VideoSources: + type: array + items: + $ref: '#/components/schemas/tt_VideoSource' + description: List of existing Video Sources + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourcesResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSources: + title: tns_GetAudioSources + type: object + description: '' + xml: + name: GetAudioSources + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourcesResponse: + title: tns_GetAudioSourcesResponse + type: object + properties: + AudioSources: + type: array + items: + $ref: '#/components/schemas/tt_AudioSource' + description: List of existing Audio Sources + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourcesResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputs: + title: tns_GetAudioOutputs + type: object + description: '' + xml: + name: GetAudioOutputs + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputsResponse: + title: tns_GetAudioOutputsResponse + type: object + properties: + AudioOutputs: + type: array + items: + $ref: '#/components/schemas/tt_AudioOutput' + description: List of existing Audio Outputs + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateProfile: + title: tns_CreateProfile + required: + - Name + type: object + properties: + Name: + maxLength: 64 + type: string + description: friendly name of the profile to be created + xml: + name: Name + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: Optional token, specifying the unique identifier of the new profile. + xml: + name: Token + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateProfile + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateProfileResponse: + title: tns_CreateProfileResponse + required: + - Profile + type: object + properties: + Profile: + allOf: + - $ref: '#/components/schemas/tt_Profile' + - description: returns the new created profile + xml: + name: Profile + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateProfileResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetProfile: + title: tns_GetProfile + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: this command requests a specific profile + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetProfile + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetProfileResponse: + title: tns_GetProfileResponse + required: + - Profile + type: object + properties: + Profile: + allOf: + - $ref: '#/components/schemas/tt_Profile' + - description: returns the requested media profile + xml: + name: Profile + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetProfileResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetProfiles: + title: tns_GetProfiles + type: object + description: '' + xml: + name: GetProfiles + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetProfilesResponse: + title: tns_GetProfilesResponse + type: object + properties: + Profiles: + type: array + items: + $ref: '#/components/schemas/tt_Profile' + description: lists all profiles that exist in the media service + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetProfilesResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddVideoEncoderConfiguration: + title: tns_AddVideoEncoderConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the VideoEncoderConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddVideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddVideoEncoderConfigurationResponse: + title: tns_AddVideoEncoderConfigurationResponse + type: object + description: '' + xml: + name: AddVideoEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveVideoEncoderConfiguration: + title: tns_RemoveVideoEncoderConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + VideoEncoderConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveVideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveVideoEncoderConfigurationResponse: + title: tns_RemoveVideoEncoderConfigurationResponse + type: object + description: '' + xml: + name: RemoveVideoEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddVideoSourceConfiguration: + title: tns_AddVideoSourceConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the VideoSourceConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddVideoSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddVideoSourceConfigurationResponse: + title: tns_AddVideoSourceConfigurationResponse + type: object + description: '' + xml: + name: AddVideoSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveVideoSourceConfiguration: + title: tns_RemoveVideoSourceConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + VideoSourceConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveVideoSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveVideoSourceConfigurationResponse: + title: tns_RemoveVideoSourceConfigurationResponse + type: object + description: '' + xml: + name: RemoveVideoSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioEncoderConfiguration: + title: tns_AddAudioEncoderConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the AudioEncoderConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddAudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioEncoderConfigurationResponse: + title: tns_AddAudioEncoderConfigurationResponse + type: object + description: '' + xml: + name: AddAudioEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioEncoderConfiguration: + title: tns_RemoveAudioEncoderConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + AudioEncoderConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveAudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioEncoderConfigurationResponse: + title: tns_RemoveAudioEncoderConfigurationResponse + type: object + description: '' + xml: + name: RemoveAudioEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioSourceConfiguration: + title: tns_AddAudioSourceConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the AudioSourceConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddAudioSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioSourceConfigurationResponse: + title: tns_AddAudioSourceConfigurationResponse + type: object + description: '' + xml: + name: AddAudioSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioSourceConfiguration: + title: tns_RemoveAudioSourceConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + AudioSourceConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveAudioSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioSourceConfigurationResponse: + title: tns_RemoveAudioSourceConfigurationResponse + type: object + description: '' + xml: + name: RemoveAudioSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddPTZConfiguration: + title: tns_AddPTZConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the PTZConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddPTZConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddPTZConfigurationResponse: + title: tns_AddPTZConfigurationResponse + type: object + description: '' + xml: + name: AddPTZConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemovePTZConfiguration: + title: tns_RemovePTZConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + PTZConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemovePTZConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemovePTZConfigurationResponse: + title: tns_RemovePTZConfigurationResponse + type: object + description: '' + xml: + name: RemovePTZConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddVideoAnalyticsConfiguration: + title: tns_AddVideoAnalyticsConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the VideoAnalyticsConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddVideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddVideoAnalyticsConfigurationResponse: + title: tns_AddVideoAnalyticsConfigurationResponse + type: object + description: '' + xml: + name: AddVideoAnalyticsConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveVideoAnalyticsConfiguration: + title: tns_RemoveVideoAnalyticsConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + VideoAnalyticsConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveVideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveVideoAnalyticsConfigurationResponse: + title: tns_RemoveVideoAnalyticsConfigurationResponse + type: object + description: '' + xml: + name: RemoveVideoAnalyticsConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddMetadataConfiguration: + title: tns_AddMetadataConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the MetadataConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddMetadataConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddMetadataConfigurationResponse: + title: tns_AddMetadataConfigurationResponse + type: object + description: '' + xml: + name: AddMetadataConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveMetadataConfiguration: + title: tns_RemoveMetadataConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + MetadataConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveMetadataConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveMetadataConfigurationResponse: + title: tns_RemoveMetadataConfigurationResponse + type: object + description: '' + xml: + name: RemoveMetadataConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioOutputConfiguration: + title: tns_AddAudioOutputConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Contains a reference to the AudioOutputConfiguration to add + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddAudioOutputConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioOutputConfigurationResponse: + title: tns_AddAudioOutputConfigurationResponse + type: object + description: '' + xml: + name: AddAudioOutputConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioOutputConfiguration: + title: tns_RemoveAudioOutputConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: >- + Contains a reference to the media profile from which the + + AudioOutputConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveAudioOutputConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioOutputConfigurationResponse: + title: tns_RemoveAudioOutputConfigurationResponse + type: object + description: '' + xml: + name: RemoveAudioOutputConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioDecoderConfiguration: + title: tns_AddAudioDecoderConfiguration + required: + - ProfileToken + - ConfigurationToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: This element contains a reference to the profile where the configuration should be added. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: This element contains a reference to the AudioDecoderConfiguration to add. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddAudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddAudioDecoderConfigurationResponse: + title: tns_AddAudioDecoderConfigurationResponse + type: object + description: '' + xml: + name: AddAudioDecoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioDecoderConfiguration: + title: tns_RemoveAudioDecoderConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: This element contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveAudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveAudioDecoderConfigurationResponse: + title: tns_RemoveAudioDecoderConfigurationResponse + type: object + description: '' + xml: + name: RemoveAudioDecoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteProfile: + title: tns_DeleteProfile + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: This element contains a reference to the profile that should be deleted. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteProfile + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteProfileResponse: + title: tns_DeleteProfileResponse + type: object + description: '' + xml: + name: DeleteProfileResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurations: + title: tns_GetVideoEncoderConfigurations + type: object + description: '' + xml: + name: GetVideoEncoderConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurationsResponse: + title: tns_GetVideoEncoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + description: This element contains a list of video encoder configurations. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurations: + title: tns_GetVideoSourceConfigurations + type: object + description: '' + xml: + name: GetVideoSourceConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurationsResponse: + title: tns_GetVideoSourceConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoSourceConfiguration' + description: This element contains a list of video source configurations. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurations: + title: tns_GetAudioEncoderConfigurations + type: object + description: '' + xml: + name: GetAudioEncoderConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurationsResponse: + title: tns_GetAudioEncoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + description: This element contains a list of audio encoder configurations. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurations: + title: tns_GetAudioSourceConfigurations + type: object + description: '' + xml: + name: GetAudioSourceConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurationsResponse: + title: tns_GetAudioSourceConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioSourceConfiguration' + description: This element contains a list of audio source configurations. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoAnalyticsConfigurations: + title: tns_GetVideoAnalyticsConfigurations + type: object + description: '' + xml: + name: GetVideoAnalyticsConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoAnalyticsConfigurationsResponse: + title: tns_GetVideoAnalyticsConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + description: This element contains a list of VideoAnalytics configurations. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoAnalyticsConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurations: + title: tns_GetMetadataConfigurations + type: object + description: '' + xml: + name: GetMetadataConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurationsResponse: + title: tns_GetMetadataConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_MetadataConfiguration' + description: This element contains a list of metadata configurations + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurations: + title: tns_GetAudioOutputConfigurations + type: object + description: '' + xml: + name: GetAudioOutputConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurationsResponse: + title: tns_GetAudioOutputConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioOutputConfiguration' + description: This element contains a list of audio output configurations + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurations: + title: tns_GetAudioDecoderConfigurations + type: object + description: '' + xml: + name: GetAudioDecoderConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurationsResponse: + title: tns_GetAudioDecoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + description: This element contains a list of audio decoder configurations + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfiguration: + title: tns_GetVideoSourceConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested video source configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurationResponse: + title: tns_GetVideoSourceConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: The requested video source configuration. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfiguration: + title: tns_GetVideoEncoderConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested video encoder configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurationResponse: + title: tns_GetVideoEncoderConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: The requested video encoder configuration. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfiguration: + title: tns_GetAudioSourceConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested audio source configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurationResponse: + title: tns_GetAudioSourceConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: The requested audio source configuration. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfiguration: + title: tns_GetAudioEncoderConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested audio encoder configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurationResponse: + title: tns_GetAudioEncoderConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: The requested audio encoder configuration + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoAnalyticsConfiguration: + title: tns_GetVideoAnalyticsConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested video analytics configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoAnalyticsConfigurationResponse: + title: tns_GetVideoAnalyticsConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: The requested video analytics configuration. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoAnalyticsConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfiguration: + title: tns_GetMetadataConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested metadata configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurationResponse: + title: tns_GetMetadataConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: The requested metadata configuration. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfiguration: + title: tns_GetAudioOutputConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested audio output configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurationResponse: + title: tns_GetAudioOutputConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: The requested audio output configuration. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfiguration: + title: tns_GetAudioDecoderConfiguration + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested audio decoder configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurationResponse: + title: tns_GetAudioDecoderConfigurationResponse + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: The requested audio decoder configuration + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleVideoEncoderConfigurations: + title: tns_GetCompatibleVideoEncoderConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleVideoEncoderConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleVideoEncoderConfigurationsResponse: + title: tns_GetCompatibleVideoEncoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + description: Contains a list of video encoder configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleVideoEncoderConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleVideoSourceConfigurations: + title: tns_GetCompatibleVideoSourceConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleVideoSourceConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleVideoSourceConfigurationsResponse: + title: tns_GetCompatibleVideoSourceConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoSourceConfiguration' + description: Contains a list of video source configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleVideoSourceConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioEncoderConfigurations: + title: tns_GetCompatibleAudioEncoderConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioEncoderConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioEncoderConfigurationsResponse: + title: tns_GetCompatibleAudioEncoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + description: Contains a list of audio encoder configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioEncoderConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioSourceConfigurations: + title: tns_GetCompatibleAudioSourceConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioSourceConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioSourceConfigurationsResponse: + title: tns_GetCompatibleAudioSourceConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioSourceConfiguration' + description: Contains a list of audio source configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioSourceConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleVideoAnalyticsConfigurations: + title: tns_GetCompatibleVideoAnalyticsConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleVideoAnalyticsConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleVideoAnalyticsConfigurationsResponse: + title: tns_GetCompatibleVideoAnalyticsConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + description: Contains a list of video analytics configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleVideoAnalyticsConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleMetadataConfigurations: + title: tns_GetCompatibleMetadataConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleMetadataConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleMetadataConfigurationsResponse: + title: tns_GetCompatibleMetadataConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_MetadataConfiguration' + description: Contains a list of metadata configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleMetadataConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioOutputConfigurations: + title: tns_GetCompatibleAudioOutputConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioOutputConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioOutputConfigurationsResponse: + title: tns_GetCompatibleAudioOutputConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioOutputConfiguration' + description: Contains a list of audio output configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioOutputConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioDecoderConfigurations: + title: tns_GetCompatibleAudioDecoderConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioDecoderConfigurations + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleAudioDecoderConfigurationsResponse: + title: tns_GetCompatibleAudioDecoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + description: Contains a list of audio decoder configurations that are compatible with the specified media profile. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleAudioDecoderConfigurationsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoEncoderConfiguration: + title: tns_SetVideoEncoderConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Contains the modified video encoder configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoEncoderConfigurationResponse: + title: tns_SetVideoEncoderConfigurationResponse + type: object + description: '' + xml: + name: SetVideoEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceConfiguration: + title: tns_SetVideoSourceConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Contains the modified video source configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceConfigurationResponse: + title: tns_SetVideoSourceConfigurationResponse + type: object + description: '' + xml: + name: SetVideoSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioEncoderConfiguration: + title: tns_SetAudioEncoderConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Contains the modified audio encoder configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioEncoderConfigurationResponse: + title: tns_SetAudioEncoderConfigurationResponse + type: object + description: '' + xml: + name: SetAudioEncoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioSourceConfiguration: + title: tns_SetAudioSourceConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Contains the modified audio source configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioSourceConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioSourceConfigurationResponse: + title: tns_SetAudioSourceConfigurationResponse + type: object + description: '' + xml: + name: SetAudioSourceConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoAnalyticsConfiguration: + title: tns_SetVideoAnalyticsConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Contains the modified video analytics configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoAnalyticsConfigurationResponse: + title: tns_SetVideoAnalyticsConfigurationResponse + type: object + description: '' + xml: + name: SetVideoAnalyticsConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetMetadataConfiguration: + title: tns_SetMetadataConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Contains the modified metadata configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetMetadataConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetMetadataConfigurationResponse: + title: tns_SetMetadataConfigurationResponse + type: object + description: '' + xml: + name: SetMetadataConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioOutputConfiguration: + title: tns_SetAudioOutputConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Contains the modified audio output configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioOutputConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioOutputConfigurationResponse: + title: tns_SetAudioOutputConfigurationResponse + type: object + description: '' + xml: + name: SetAudioOutputConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioDecoderConfiguration: + title: tns_SetAudioDecoderConfiguration + required: + - Configuration + - ForcePersistence + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Contains the modified audio decoder configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: The ForcePersistence element is obsolete and should always be assumed to be true. + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioDecoderConfigurationResponse: + title: tns_SetAudioDecoderConfigurationResponse + type: object + description: '' + xml: + name: SetAudioDecoderConfigurationResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurationOptions: + title: tns_GetVideoSourceConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional video source configurationToken that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurationOptionsResponse: + title: tns_GetVideoSourceConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurationOptions: + title: tns_GetVideoEncoderConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional video encoder configuration token that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurationOptionsResponse: + title: tns_GetVideoEncoderConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfigurationOptions' + - xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurationOptions: + title: tns_GetAudioSourceConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional audio source configuration token that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurationOptionsResponse: + title: tns_GetAudioSourceConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurationOptions: + title: tns_GetAudioEncoderConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional audio encoder configuration token that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurationOptionsResponse: + title: tns_GetAudioEncoderConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurationOptions: + title: tns_GetMetadataConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional metadata configuration token that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurationOptionsResponse: + title: tns_GetMetadataConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurationOptions: + title: tns_GetAudioOutputConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional audio output configuration token that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurationOptionsResponse: + title: tns_GetAudioOutputConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurationOptions: + title: tns_GetAudioDecoderConfigurationOptions + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Optional audio decoder configuration token that specifies an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurationOptionsResponse: + title: tns_GetAudioDecoderConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfigurationOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetGuaranteedNumberOfVideoEncoderInstances: + title: tns_GetGuaranteedNumberOfVideoEncoderInstances + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the video source configuration + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetGuaranteedNumberOfVideoEncoderInstances + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetGuaranteedNumberOfVideoEncoderInstancesResponse: + title: tns_GetGuaranteedNumberOfVideoEncoderInstancesResponse + required: + - TotalNumber + type: object + properties: + TotalNumber: + type: integer + description: The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the TotalNumber of streams + format: int32 + xml: + name: TotalNumber + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + JPEG: + type: integer + 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. + format: int32 + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + H264: + type: integer + 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. + format: int32 + xml: + name: H264 + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + MPEG4: + type: integer + 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. + format: int32 + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetGuaranteedNumberOfVideoEncoderInstancesResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStreamUri: + title: tns_GetStreamUri + required: + - StreamSetup + - ProfileToken + type: object + properties: + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream Setup that should be used with the uri + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStreamUri + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStreamUriResponse: + title: tns_GetStreamUriResponse + required: + - MediaUri + type: object + properties: + MediaUri: + allOf: + - $ref: '#/components/schemas/tt_MediaUri' + - xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStreamUriResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StartMulticastStreaming: + title: tns_StartMulticastStreaming + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of the Profile that is used to define the multicast stream. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: StartMulticastStreaming + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StartMulticastStreamingResponse: + title: tns_StartMulticastStreamingResponse + type: object + description: '' + xml: + name: StartMulticastStreamingResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StopMulticastStreaming: + title: tns_StopMulticastStreaming + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of the Profile that is used to define the multicast stream. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: StopMulticastStreaming + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StopMulticastStreamingResponse: + title: tns_StopMulticastStreamingResponse + type: object + description: '' + xml: + name: StopMulticastStreamingResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetSynchronizationPoint: + title: tns_SetSynchronizationPoint + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains a Profile reference for which a Synchronization Point is requested. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetSynchronizationPoint + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetSynchronizationPointResponse: + title: tns_SetSynchronizationPointResponse + type: object + description: '' + xml: + name: SetSynchronizationPointResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSnapshotUri: + title: tns_GetSnapshotUri + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSnapshotUri + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSnapshotUriResponse: + title: tns_GetSnapshotUriResponse + required: + - MediaUri + type: object + properties: + MediaUri: + allOf: + - $ref: '#/components/schemas/tt_MediaUri' + - xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSnapshotUriResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceModes: + title: tns_GetVideoSourceModes + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Contains a video source reference for which a video source mode is requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceModes + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceModesResponse: + title: tns_GetVideoSourceModesResponse + required: + - VideoSourceModes + type: object + properties: + VideoSourceModes: + type: array + items: + $ref: '#/components/schemas/tns_VideoSourceMode' + description: Return the information for specified video source mode. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceModesResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceMode: + title: tns_SetVideoSourceMode + required: + - VideoSourceToken + - VideoSourceModeToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Contains a video source reference for which a video source mode is requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + VideoSourceModeToken: + maxLength: 64 + type: string + description: Indicate video source mode. + xml: + name: VideoSourceModeToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoSourceMode + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceModeResponse: + title: tns_SetVideoSourceModeResponse + required: + - Reboot + type: object + properties: + Reboot: + type: boolean + description: The response contains information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode. + xml: + name: Reboot + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoSourceModeResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_VideoSourceMode: + title: tns_VideoSourceMode + required: + - token + - MaxFramerate + - MaxResolution + - Encodings + - Reboot + type: object + properties: + token: + maxLength: 64 + type: string + description: Indicate token for video source mode. + xml: + name: token + prefix: tns + attribute: true + wrapped: false + Enabled: + type: 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. + xml: + name: Enabled + prefix: tns + attribute: true + wrapped: false + MaxFramerate: + type: number + description: Max frame rate in frames per second for this video source mode. + xml: + name: MaxFramerate + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + MaxResolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Max horizontal and vertical resolution for this video source mode. + xml: + name: MaxResolution + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + Encodings: + type: array + items: + type: string + xml: + name: Encodings + attribute: false + wrapped: false + description: Indication which encodings are supported for this video source. The list may contain one or more enumeration values of tt:VideoEncoding. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + Reboot: + type: boolean + 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. + xml: + name: Reboot + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + Description: + type: string + description: Informative description of this video source mode. This field should be described in English. + xml: + name: Description + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tns_VideoSourceModeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceMode + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_VideoSourceModeExtension: + title: tns_VideoSourceModeExtension + type: object + description: '' + xml: + name: VideoSourceModeExtension + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDs: + title: tns_GetOSDs + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDs + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDsResponse: + title: tns_GetOSDsResponse + type: object + properties: + OSDs: + type: array + items: + $ref: '#/components/schemas/tt_OSDConfiguration' + description: This element contains a list of requested OSDs. + xml: + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSD: + title: tns_GetOSD + required: + - OSDToken + type: object + properties: + OSDToken: + maxLength: 64 + type: string + description: The GetOSD command fetches the OSD configuration if the OSD token is known. + xml: + name: OSDToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDResponse: + title: tns_GetOSDResponse + required: + - OSD + type: object + properties: + OSD: + allOf: + - $ref: '#/components/schemas/tt_OSDConfiguration' + - description: The requested OSD configuration. + xml: + name: OSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetOSD: + title: tns_SetOSD + required: + - OSD + type: object + properties: + OSD: + allOf: + - $ref: '#/components/schemas/tt_OSDConfiguration' + - description: Contains the modified OSD configuration. + xml: + name: OSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetOSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetOSDResponse: + title: tns_SetOSDResponse + type: object + description: '' + xml: + name: SetOSDResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDOptions: + title: tns_GetOSDOptions + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDOptionsResponse: + title: tns_GetOSDOptionsResponse + required: + - OSDOptions + type: object + properties: + OSDOptions: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptions' + - xml: + name: OSDOptions + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDOptionsResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateOSD: + title: tns_CreateOSD + required: + - OSD + type: object + properties: + OSD: + allOf: + - $ref: '#/components/schemas/tt_OSDConfiguration' + - description: Contain the initial OSD configuration for create. + xml: + name: OSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateOSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateOSDResponse: + title: tns_CreateOSDResponse + required: + - OSDToken + type: object + properties: + OSDToken: + maxLength: 64 + type: string + description: Returns Token of the newly created OSD + xml: + name: OSDToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateOSDResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteOSD: + title: tns_DeleteOSD + required: + - OSDToken + type: object + properties: + OSDToken: + maxLength: 64 + type: string + description: This element contains a reference to the OSD configuration that should be deleted. + xml: + name: OSDToken + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteOSD + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteOSDResponse: + title: tns_DeleteOSDResponse + type: object + description: '' + xml: + name: DeleteOSDResponse + namespace: http://www.onvif.org/ver10/media/wsdl + prefix: tns + attribute: false + wrapped: false + tt_IntRange: + title: tt_IntRange + required: + - Min + - Max + type: object + properties: + Min: + type: integer + format: int32 + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: integer + format: int32 + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: IntRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector2D: + title: tt_Vector2D + required: + - x + - y + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Pan/tilt coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector2D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector1D: + title: tt_Vector1D + required: + - x + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Zoom coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector1D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZVector: + title: tt_PTZVector + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan and the y component to tilt. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom position. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZVector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatus: + title: tt_PTZStatus + required: + - UtcTime + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - 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. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: States a current PTZ error. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UtcTime: + type: string + description: Specifies the UTC time when this status was generated. + format: date-time + xml: + name: UtcTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZMoveStatus: + title: tt_PTZMoveStatus + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZMoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveStatus: + title: tt_MoveStatus + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + description: '' + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector: + title: tt_Vector + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rectangle: + title: tt_Rectangle + type: object + properties: + bottom: + type: number + xml: + name: bottom + prefix: tt + attribute: true + wrapped: false + top: + type: number + xml: + name: top + prefix: tt + attribute: true + wrapped: false + right: + type: number + xml: + name: right + prefix: tt + attribute: true + wrapped: false + left: + type: number + xml: + name: left + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Rectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polygon: + title: tt_Polygon + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polygon + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Color: + title: tt_Color + required: + - X + - Y + - Z + type: object + properties: + X: + type: number + xml: + name: X + prefix: tt + attribute: true + wrapped: false + Y: + type: number + xml: + name: Y + prefix: tt + attribute: true + wrapped: false + Z: + type: number + xml: + name: Z + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: 'Acceptable values:' + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorCovariance: + title: tt_ColorCovariance + required: + - XX + - YY + - ZZ + type: object + properties: + XX: + type: number + xml: + name: XX + prefix: tt + attribute: true + wrapped: false + YY: + type: number + xml: + name: YY + prefix: tt + attribute: true + wrapped: false + ZZ: + type: number + xml: + name: ZZ + prefix: tt + attribute: true + wrapped: false + XY: + type: number + xml: + name: XY + prefix: tt + attribute: true + wrapped: false + XZ: + type: number + xml: + name: XZ + prefix: tt + attribute: true + wrapped: false + YZ: + type: number + xml: + name: YZ + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: ColorCovariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorDescriptor: + title: tt_ColorDescriptor + type: object + properties: + ColorCluster: + type: array + items: + $ref: '#/components/schemas/tt_ColorCluster' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transformation: + title: tt_Transformation + type: object + properties: + Translate: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Translate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Scale: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Scale + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TransformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransformationExtension: + title: tt_TransformationExtension + type: object + description: '' + xml: + name: TransformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoLocation: + title: tt_GeoLocation + type: object + properties: + lon: + type: number + description: East west location as angle. + xml: + name: lon + prefix: tt + attribute: true + wrapped: false + lat: + type: number + description: North south location as angle. + xml: + name: lat + prefix: tt + attribute: true + wrapped: false + elevation: + type: number + description: Hight in meters above sea level. + xml: + name: elevation + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoOrientation: + title: tt_GeoOrientation + type: object + properties: + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + pitch: + type: number + description: Rotation around the y axis. + xml: + name: pitch + prefix: tt + attribute: true + wrapped: false + yaw: + type: number + description: Rotation around the z axis. + xml: + name: yaw + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalLocation: + title: tt_LocalLocation + type: object + properties: + x: + type: number + description: East west location as angle. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: North south location as angle. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + z: + type: number + description: Offset in meters from the sea level. + xml: + name: z + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalOrientation: + title: tt_LocalOrientation + type: object + properties: + pan: + type: number + description: Rotation around the y axis. + xml: + name: pan + prefix: tt + attribute: true + wrapped: false + tilt: + type: number + description: Rotation around the z axis. + xml: + name: tilt + prefix: tt + attribute: true + wrapped: false + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Entity: + title: tt_Entity + enum: + - Device + - VideoSource + - AudioSource + type: string + description: '' + xml: + name: Entity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocationEntity: + title: tt_LocationEntity + type: object + properties: + Entity: + type: string + description: Entity type the entry refers to, use a value from the tt:Entity enumeration. + xml: + name: Entity + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + description: Optional entity token. + xml: + name: Token + prefix: tt + attribute: true + wrapped: false + Fixed: + type: boolean + description: If this value is true the entity cannot be deleted. + xml: + name: Fixed + prefix: tt + attribute: true + wrapped: false + GeoSource: + type: string + description: Optional reference to the XAddr of another devices DeviceManagement service. + xml: + name: GeoSource + prefix: tt + attribute: true + wrapped: false + AutoGeo: + type: boolean + description: If set the geo location is obtained internally. + xml: + name: AutoGeo + prefix: tt + attribute: true + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: Location on earth. + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GeoOrientation: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Orientation relative to earth. + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalLocation: + allOf: + - $ref: '#/components/schemas/tt_LocalLocation' + - description: Indoor location offset. + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalOrientation: + allOf: + - $ref: '#/components/schemas/tt_LocalOrientation' + - description: Indoor orientation offset. + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LocationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceEntity: + title: tt_DeviceEntity + required: + - token + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier referencing the physical entity. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + description: Base class for physical entities like inputs and outputs. + xml: + name: DeviceEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangle: + title: tt_IntRectangle + required: + - x + - y + - width + - height + type: object + properties: + x: + type: integer + format: int32 + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: integer + format: int32 + xml: + name: y + prefix: tt + attribute: true + wrapped: false + width: + type: integer + format: int32 + xml: + name: width + prefix: tt + attribute: true + wrapped: false + height: + type: integer + format: int32 + xml: + name: height + prefix: tt + attribute: true + wrapped: false + description: Rectangle defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangleRange: + title: tt_IntRectangleRange + required: + - XRange + - YRange + - WidthRange + - HeightRange + type: object + properties: + XRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of X-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of Y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WidthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of width. + xml: + name: WidthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HeightRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of height. + xml: + name: HeightRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangleRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatRange: + title: tt_FloatRange + required: + - Min + - Max + type: object + properties: + Min: + type: number + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: number + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: FloatRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DurationRange: + title: tt_DurationRange + required: + - Min + - Max + type: object + properties: + Min: + type: string + format: date-time + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: string + format: date-time + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of duration greater equal Min duration and less equal Max duration. + xml: + name: DurationRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntItems: + title: tt_IntItems + type: object + properties: + Items: + type: array + items: + type: integer + format: int32 + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: List of values. + xml: + name: IntItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatItems: + title: tt_FloatItems + type: object + properties: + Items: + type: array + items: + type: number + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FloatItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StringItems: + title: tt_StringItems + required: + - Item + type: object + properties: + Item: + type: array + items: + type: string + xml: + name: Item + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StringItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnyHolder: + title: tt_AnyHolder + type: object + description: '' + xml: + name: AnyHolder + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSource: + title: tt_VideoSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Framerate + - Resolution + type: object + properties: + Framerate: + type: number + description: Frame rate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Horizontal and vertical resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings' + - description: Optional configuration of the image sensor. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video input. + tt_VideoSourceExtension: + title: tt_VideoSourceExtension + type: object + properties: + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if imaging service 2.00 is supported. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceExtension2: + title: tt_VideoSourceExtension2 + type: object + description: '' + xml: + name: VideoSourceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSource: + title: tt_AudioSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Channels + type: object + properties: + Channels: + type: integer + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + xml: + name: Channels + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio input. + tt_Profile: + title: tt_Profile + required: + - token + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of the profile. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: A value of true signals that the profile cannot be deleted. Default is false. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and rule engine. + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + A media profile consists of a set of media configurations. Media profiles are used by a client + to configure properties of a media stream from an NVT. + xml: + name: Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension: + title: tt_ProfileExtension + type: object + properties: + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension2: + title: tt_ProfileExtension2 + type: object + description: '' + xml: + name: ProfileExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfiguration: + title: tt_VideoSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + - Bounds + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Reference to the physical input. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bounds: + allOf: + - $ref: '#/components/schemas/tt_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area. + xml: + name: Bounds + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ViewMode: + type: string + description: Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes. + xml: + name: ViewMode + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioSourceConfiguration: + title: tt_AudioSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Token of the Audio Source the configuration applies to + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncoderConfiguration: + title: tt_VideoEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Configuration' + - description: Optional element to configure H.264 related parameters. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related video stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoderConfiguration: + title: tt_AudioEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoAnalyticsConfiguration: + title: tt_VideoAnalyticsConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfiguration' + - xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZConfiguration: + title: tt_PTZConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - NodeToken + type: object + properties: + NodeToken: + maxLength: 64 + type: string + description: A mandatory reference to the PTZ Node that the PTZ Configuration belongs to. + xml: + name: NodeToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsolutePantTiltPositionSpace: + type: string + description: If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default. + xml: + name: DefaultAbsolutePantTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsoluteZoomPositionSpace: + type: string + description: If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default. + xml: + name: DefaultAbsoluteZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativePanTiltTranslationSpace: + type: string + description: If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default. + xml: + name: DefaultRelativePanTiltTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativeZoomTranslationSpace: + type: string + description: If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default. + xml: + name: DefaultRelativeZoomTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousPanTiltVelocitySpace: + type: string + description: If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default. + xml: + name: DefaultContinuousPanTiltVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousZoomVelocitySpace: + type: string + description: If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default. + xml: + name: DefaultContinuousZoomVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds. + xml: + name: DefaultPTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZTimeout: + type: string + description: If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops. + format: date-time + xml: + name: DefaultPTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/tt_PanTiltLimits' + - 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. + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomLimits: + allOf: + - $ref: '#/components/schemas/tt_ZoomLimits' + - 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. + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveRamp: + type: integer + description: The optional acceleration ramp used by the device when moving. + format: int32 + xml: + name: MoveRamp + prefix: tt + attribute: true + wrapped: false + PresetRamp: + type: integer + description: The optional acceleration ramp used by the device when recalling presets. + format: int32 + xml: + name: PresetRamp + prefix: tt + attribute: true + wrapped: false + PresetTourRamp: + type: integer + description: The optional acceleration ramp used by the device when executing PresetTours. + format: int32 + xml: + name: PresetTourRamp + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_MetadataConfiguration: + title: tt_MetadataConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Multicast + - SessionTimeout + type: object + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZFilter' + - description: optional element to configure which PTZ related data is to include in the metadata stream + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventSubscription' + - description: "Optional element to configure the streaming of events. A client might be interested in receiving all, \n none or some of the events produced by the device:" + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Analytics: + type: boolean + description: Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.) + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored) + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - description: >- + Indication which AnalyticsModules shall output metadata. + Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration. + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CompressionType: + type: string + description: Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType. + xml: + name: CompressionType + prefix: tt + attribute: true + wrapped: false + GeoLocation: + type: boolean + description: Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + ShapePolygon: + type: boolean + description: Optional parameter to configure if the generated metadata stream should contain shape information as polygon. + xml: + name: ShapePolygon + prefix: tt + attribute: true + wrapped: false + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioOutputConfiguration: + title: tt_AudioOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + - OutputLevel + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the phsycial Audio output. + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacy: + type: string + description: >- + An audio channel MAY support different types of audio transmission. While for full duplex + operation no special handling is required, in half duplex operation the transmission direction + needs to be switched. + The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which + direction is currently active. An NVC can switch between different modes by setting the + AudioOutputConfiguration. + xml: + name: SendPrimacy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevel: + type: integer + description: Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange. + format: int32 + xml: + name: OutputLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioDecoderConfiguration: + title: tt_AudioDecoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - type: object + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The Audio Decoder Configuration does not contain any that parameter to configure the + + decoding .A decoder shall decode every data it receives (according to its capabilities). + tt_ConfigurationEntity: + title: tt_ConfigurationEntity + required: + - token + - Name + - UseCount + type: object + properties: + token: + maxLength: 64 + type: string + description: Token that uniquely references this configuration. Length up to 64 characters. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name. Length up to 64 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseCount: + type: integer + description: Number of internal references currently using this configuration. + format: int32 + xml: + name: UseCount + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Base type defining the common properties of a configuration. + xml: + name: ConfigurationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension: + title: tt_VideoSourceConfigurationExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_Rotate' + - description: >- + Optional element to configure rotation of captured image. + What resolutions a device supports shall be unaffected by the Rotate parameters. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension2: + title: tt_VideoSourceConfigurationExtension2 + type: object + properties: + LensDescription: + type: array + items: + $ref: '#/components/schemas/tt_LensDescription' + description: Optional element describing the geometric lens distortion. Multiple instances for future variable lens support. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneOrientation: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientation' + - description: Optional element describing the scene orientation in the camera’s field of view. + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rotate: + title: tt_Rotate + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RotateMode' + - description: Parameter to enable/disable Rotation feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Degree: + type: integer + 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. + format: int32 + xml: + name: Degree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateExtension: + title: tt_RotateExtension + type: object + description: '' + xml: + name: RotateExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateMode: + title: tt_RotateMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: RotateMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensProjection: + title: tt_LensProjection + required: + - Angle + - Radius + type: object + properties: + Angle: + type: number + description: Angle of incidence. + xml: + name: Angle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Radius: + type: number + description: Mapping radius as a consequence of the emergent angle. + xml: + name: Radius + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transmittance: + type: number + description: Optional ray absorption at the given angle due to vignetting. A value of one means no absorption. + xml: + name: Transmittance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensProjection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensOffset: + title: tt_LensOffset + type: object + properties: + x: + type: number + description: Optional horizontal offset of the lens center in normalized coordinates. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: Optional vertical offset of the lens center in normalized coordinates. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LensOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensDescription: + title: tt_LensDescription + required: + - Offset + - Projection + - XFactor + type: object + properties: + FocalLength: + type: number + description: Optional focal length of the optical system. + xml: + name: FocalLength + prefix: tt + attribute: true + wrapped: false + Offset: + allOf: + - $ref: '#/components/schemas/tt_LensOffset' + - description: Offset of the lens center to the imager center in normalized coordinates. + xml: + name: Offset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Projection: + type: array + items: + $ref: '#/components/schemas/tt_LensProjection' + description: "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation \n over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. \n Items outside the last projection Radius shall be assumed to be invisible (black)." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XFactor: + type: number + description: Compensation of the x coordinate needed for the ONVIF normalized coordinate system. + xml: + name: XFactor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptions: + title: tt_VideoSourceConfigurationOptions + required: + - BoundsRange + - VideoSourceTokensAvailable + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tt + attribute: true + wrapped: false + BoundsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRectangleRange' + - description: >- + Supported range for the capturing area. + Device that does not support cropped streaming shall express BoundsRange option as mentioned below + BoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits. + xml: + name: BoundsRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: VideoSourceTokensAvailable + attribute: false + wrapped: false + description: List of physical inputs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension: + title: tt_VideoSourceConfigurationOptionsExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_RotateOptions' + - description: Options of parameters for Rotation feature. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension2: + title: tt_VideoSourceConfigurationOptionsExtension2 + type: object + properties: + SceneOrientationMode: + type: array + items: + $ref: '#/components/schemas/tt_SceneOrientationMode' + description: Scene orientation modes supported by the device for this configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptions: + title: tt_RotateOptions + required: + - Mode + type: object + properties: + Reboot: + type: boolean + description: >- + After setting the rotation, if a device starts to reboot this value is true. + If a device can handle rotation setting without rebooting this value is false. + xml: + name: Reboot + prefix: tt + attribute: true + wrapped: false + Mode: + type: array + items: + $ref: '#/components/schemas/tt_RotateMode' + description: Supported options of Rotate mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DegreeList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported degree value for rotation. + xml: + name: DegreeList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RotateOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptionsExtension: + title: tt_RotateOptionsExtension + type: object + description: '' + xml: + name: RotateOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationMode: + title: tt_SceneOrientationMode + enum: + - MANUAL + - AUTO + type: string + description: '' + xml: + name: SceneOrientationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationOption: + title: tt_SceneOrientationOption + enum: + - Below + - Horizon + - Above + type: string + description: Defines the acceptable values for the Orientation element of the SceneOrientation type + xml: + name: SceneOrientationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientation: + title: tt_SceneOrientation + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene orientation. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Orientation: + type: string + description: "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field \n is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required \n and the device will return an InvalidArgs fault if missing." + xml: + name: Orientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ViewModes: + title: tt_ViewModes + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + type: string + description: Source view modes supported by device. + xml: + name: ViewModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoding: + title: tt_VideoEncoding + enum: + - JPEG + - MPEG4 + - H264 + type: string + description: '' + xml: + name: VideoEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Profile: + title: tt_Mpeg4Profile + enum: + - SP + - ASP + type: string + description: '' + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Profile: + title: tt_H264Profile + enum: + - Baseline + - Main + - Extended + - High + type: string + description: '' + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoResolution: + title: tt_VideoResolution + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl: + title: tt_VideoRateControl + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + type: object + properties: + FrameRateLimit: + type: integer + description: Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor. + format: int32 + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingInterval: + type: integer + 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 ...) + format: int32 + xml: + name: EncodingInterval + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Configuration: + title: tt_Mpeg4Configuration + required: + - GovLength + - Mpeg4Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP) + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Configuration: + title: tt_H264Configuration + required: + - GovLength + - H264Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264Profile: + allOf: + - $ref: '#/components/schemas/tt_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderConfigurationOptions: + title: tt_VideoEncoderConfigurationOptions + required: + - QualityRange + type: object + properties: + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension element). + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension element). + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension element). + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension: + title: tt_VideoEncoderOptionsExtension + type: object + properties: + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options2' + - description: Optional H.264 encoder settings ranges. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension2: + title: tt_VideoEncoderOptionsExtension2 + type: object + description: '' + xml: + name: VideoEncoderOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions: + title: tt_JpegOptions + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions2: + title: tt_JpegOptions2 + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: JpegOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_Mpeg4Options: + title: tt_Mpeg4Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported MPEG-4 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Options2: + title: tt_Mpeg4Options2 + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Mpeg4Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_H264Options: + title: tt_H264Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H.264 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Options2: + title: tt_H264Options2 + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: H264Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncodingMimeNames: + title: tt_VideoEncodingMimeNames + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + type: string + description: Video Media Subtypes as referenced by IANA (without the leading "video/" Video Media Type). See also + xml: + name: VideoEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncodingProfiles: + title: tt_VideoEncodingProfiles + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + type: string + description: '' + xml: + name: VideoEncodingProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2Configuration: + title: tt_VideoEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + type: object + properties: + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution2' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + prefix: tt + attribute: true + wrapped: false + Profile: + type: string + description: The encoder profile as defined in tt:VideoEncodingProfiles. + xml: + name: Profile + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoResolution2: + title: tt_VideoResolution2 + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl2: + title: tt_VideoRateControl2 + required: + - FrameRateLimit + - BitrateLimit + type: object + properties: + ConstantBitRate: + type: boolean + description: Enforce constant bitrate. + xml: + name: ConstantBitRate + prefix: tt + attribute: true + wrapped: false + FrameRateLimit: + type: number + description: Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations. + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2ConfigurationOptions: + title: tt_VideoEncoder2ConfigurationOptions + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + type: object + properties: + GovLengthRange: + type: integer + 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. + format: int32 + xml: + name: GovLengthRange + prefix: tt + attribute: true + wrapped: false + FrameRatesSupported: + type: number + description: List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first. + xml: + name: FrameRatesSupported + prefix: tt + attribute: true + wrapped: false + ProfilesSupported: + type: string + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + xml: + name: ProfilesSupported + prefix: tt + attribute: true + wrapped: false + ConstantBitRateSupported: + type: boolean + description: Signal whether enforcing constant bitrate is supported. + xml: + name: ConstantBitRateSupported + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution2' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceConfigurationOptions: + title: tt_AudioSourceConfigurationOptions + required: + - InputTokensAvailable + type: object + properties: + InputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the audio source the configuration can be used for. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceOptionsExtension: + title: tt_AudioSourceOptionsExtension + type: object + description: '' + xml: + name: AudioSourceOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoding: + title: tt_AudioEncoding + enum: + - G711 + - G726 + - AAC + type: string + description: '' + xml: + name: AudioEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOptions: + title: tt_AudioEncoderConfigurationOptions + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfigurationOption' + description: list of supported AudioEncoderConfigurations + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOption: + title: tt_AudioEncoderConfigurationOption + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncodingMimeNames: + title: tt_AudioEncodingMimeNames + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + type: string + description: Audio Media Subtypes as referenced by IANA (without the leading "audio/" Audio Media Type and except for the audio types defined in the restriction). See also + xml: + name: AudioEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoder2Configuration: + title: tt_AudioEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoder2ConfigurationOptions: + title: tt_AudioEncoder2ConfigurationOptions + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationExtension: + title: tt_MetadataConfigurationExtension + type: object + description: '' + xml: + name: MetadataConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZFilter: + title: tt_PTZFilter + required: + - Status + - Position + type: object + properties: + Status: + type: boolean + description: True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN) + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + type: boolean + description: True if the metadata stream shall contain the PTZ position + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventSubscription: + title: tt_EventSubscription + type: object + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Subcription handling in the same way as base notification subscription. + xml: + name: EventSubscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptions: + title: tt_MetadataConfigurationOptions + required: + - PTZStatusFilterOptions + type: object + properties: + GeoLocation: + type: boolean + description: True if the device is able to stream the Geo Located positions of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + MaxContentFilterSize: + type: integer + description: A device signalling support for content filtering shall support expressions with the provided expression size. + format: int32 + xml: + name: MaxContentFilterSize + prefix: tt + attribute: true + wrapped: false + PTZStatusFilterOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptions' + - xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension: + title: tt_MetadataConfigurationOptionsExtension + type: object + properties: + CompressionType: + type: array + items: + type: string + xml: + name: CompressionType + attribute: false + wrapped: false + description: List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension2: + title: tt_MetadataConfigurationOptionsExtension2 + type: object + description: '' + xml: + name: MetadataConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataCompressionType: + title: tt_MetadataCompressionType + enum: + - None + - GZIP + - EXI + type: string + description: '' + xml: + name: MetadataCompressionType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptions: + title: tt_PTZStatusFilterOptions + required: + - PanTiltStatusSupported + - ZoomStatusSupported + type: object + properties: + PanTiltStatusSupported: + type: boolean + description: True if the device is able to stream pan or tilt status information. + xml: + name: PanTiltStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomStatusSupported: + type: boolean + description: True if the device is able to stream zoom status inforamtion. + xml: + name: ZoomStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSupported: + type: boolean + description: True if the device is able to stream the pan or tilt position. + xml: + name: PanTiltPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSupported: + type: boolean + description: True if the device is able to stream zoom position information. + xml: + name: ZoomPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptionsExtension: + title: tt_PTZStatusFilterOptionsExtension + type: object + description: '' + xml: + name: PTZStatusFilterOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutput: + title: tt_VideoOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Layout + type: object + properties: + Layout: + allOf: + - $ref: '#/components/schemas/tt_Layout' + - xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Resolution of the display in Pixel. + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RefreshRate: + type: number + description: Refresh rate of the display in Hertz. + xml: + name: RefreshRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AspectRatio: + type: number + description: Aspect ratio of the display as physical extent of width divided by height. + xml: + name: AspectRatio + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoOutputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video outputs. + tt_VideoOutputExtension: + title: tt_VideoOutputExtension + type: object + description: '' + xml: + name: VideoOutputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutputConfiguration: + title: tt_VideoOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the Video Output the configuration applies to + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoOutputConfigurationOptions: + title: tt_VideoOutputConfigurationOptions + type: object + description: '' + xml: + name: VideoOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptions: + title: tt_VideoDecoderConfigurationOptions + type: object + properties: + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/tt_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element describes the supported codecs and configurations + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264DecOptions: + allOf: + - $ref: '#/components/schemas/tt_H264DecOptions' + - description: If the device is able to decode H.264 streams this element describes the supported codecs and configurations + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264DecOptions: + title: tt_H264DecOptions + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported H.264 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedH264Profiles: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H264 Profiles (either baseline, main, extended or high) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegDecOptions: + title: tt_JpegDecOptions + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Jpeg Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4DecOptions: + title: tt_Mpeg4DecOptions + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Mpeg4 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedMpeg4Profiles: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported Mpeg4 Profiles (either SP or ASP) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptionsExtension: + title: tt_VideoDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: VideoDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioOutput: + title: tt_AudioOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + xml: + name: AudioOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio outputs. + tt_AudioOutputConfigurationOptions: + title: tt_AudioOutputConfigurationOptions + required: + - OutputTokensAvailable + - OutputLevelRange + type: object + properties: + OutputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: OutputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the physical Audio outputs (typically one). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacyOptions: + type: array + items: + type: string + xml: + name: SendPrimacyOptions + attribute: false + wrapped: false + description: An + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Minimum and maximum level range supported for this Output. + xml: + name: OutputLevelRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptions: + title: tt_AudioDecoderConfigurationOptions + type: object + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/tt_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section describes the supported configurations + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G711DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section describes the supported configurations + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G726DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section describes the supported configurations + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G711DecOptions: + title: tt_G711DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AACDecOptions: + title: tt_AACDecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G726DecOptions: + title: tt_G726DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptionsExtension: + title: tt_AudioDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: AudioDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MulticastConfiguration: + title: tt_MulticastConfiguration + required: + - Address + - Port + - TTL + - AutoStart + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/tt_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast streaming is enaled) + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: integer + description: The RTP mutlicast 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. + format: int32 + xml: + name: Port + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: integer + 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. + format: int32 + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Read only property signalling that streaming is persistant. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MulticastConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamSetup: + title: tt_StreamSetup + required: + - Stream + - Transport + type: object + properties: + Stream: + allOf: + - $ref: '#/components/schemas/tt_StreamType' + - description: Defines if a multicast or unicast stream is requested + xml: + name: Stream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transport: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamType: + title: tt_StreamType + enum: + - RTP-Unicast + - RTP-Multicast + type: string + description: '' + xml: + name: StreamType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transport: + title: tt_Transport + required: + - Protocol + type: object + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/tt_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + xml: + name: Protocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tunnel: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - description: Optional element to describe further tunnel options. This element is normally not needed + xml: + name: Tunnel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransportProtocol: + title: tt_TransportProtocol + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + description: '' + xml: + name: TransportProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaUri: + title: tt_MediaUri + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting the media stream + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterConnect: + type: boolean + description: Indicates if the Uri is only valid until the connection is established. The value shall be set to "false". + xml: + name: InvalidAfterConnect + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterReboot: + type: boolean + description: Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false". + xml: + name: InvalidAfterReboot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Timeout: + type: string + 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 + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ScopeDefinition: + title: tt_ScopeDefinition + enum: + - Fixed + - Configurable + type: string + description: '' + xml: + name: ScopeDefinition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Scope: + title: tt_Scope + required: + - ScopeDef + - ScopeItem + type: object + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/tt_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + xml: + name: ScopeDef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScopeItem: + type: string + description: Scope item URI. + xml: + name: ScopeItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Scope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DiscoveryMode: + title: tt_DiscoveryMode + enum: + - Discoverable + - NonDiscoverable + type: string + description: '' + xml: + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterface: + title: tt_NetworkInterface + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Info: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceInfo' + - description: Network interface information + xml: + name: Info + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceLink' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_NetworkInterfaceExtension: + title: tt_NetworkInterfaceExtension + required: + - InterfaceType + type: object + properties: + InterfaceType: + type: integer + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: Extension point prepared for future 802.3 configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot3Configuration: + title: tt_Dot3Configuration + type: object + description: '' + xml: + name: Dot3Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceExtension2: + title: tt_NetworkInterfaceExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceLink: + title: tt_NetworkInterfaceLink + required: + - AdminSettings + - OperSettings + - InterfaceType + type: object + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + xml: + name: AdminSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OperSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + xml: + name: OperSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InterfaceType: + type: integer + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceLink + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceConnectionSetting: + title: tt_NetworkInterfaceConnectionSetting + required: + - AutoNegotiation + - Speed + - Duplex + type: object + properties: + AutoNegotiation: + type: boolean + description: Auto negotiation on/off. + xml: + name: AutoNegotiation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: integer + description: Speed. + format: int32 + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Duplex: + allOf: + - $ref: '#/components/schemas/tt_Duplex' + - description: Duplex type, Half or Full. + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceConnectionSetting + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Duplex: + title: tt_Duplex + enum: + - Full + - Half + type: string + description: '' + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceInfo: + title: tt_NetworkInterfaceInfo + required: + - HwAddress + type: object + properties: + Name: + type: string + description: Network interface name, for example eth0. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HwAddress: + type: string + description: Network interface MAC address. + xml: + name: HwAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterface: + title: tt_IPv6NetworkInterface + required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv6Configuration' + - description: IPv6 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterface: + title: tt_IPv4NetworkInterface + required: + - Enabled + - Config + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv4Configuration' + - description: IPv4 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4Configuration: + title: tt_IPv4Configuration + required: + - DHCP + type: object + properties: + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: Link local address. + xml: + name: LinkLocal + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6Configuration: + title: tt_IPv6Configuration + required: + - DHCP + type: object + properties: + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually entered IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of link local IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromRA: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using router advertisment. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPv6ConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6ConfigurationExtension: + title: tt_IPv6ConfigurationExtension + type: object + description: '' + xml: + name: IPv6ConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6DHCPConfiguration: + title: tt_IPv6DHCPConfiguration + enum: + - Auto + - Stateful + - Stateless + - Off + type: string + description: '' + xml: + name: IPv6DHCPConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocol: + title: tt_NetworkProtocol + required: + - Name + - Enabled + - Port + type: object + properties: + Name: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolType' + - description: Network protocol type string. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates if the protocol is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: array + items: + type: integer + format: int32 + xml: + name: Port + attribute: false + wrapped: false + description: The port that is used by the protocol. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolExtension: + title: tt_NetworkProtocolExtension + type: object + description: '' + xml: + name: NetworkProtocolExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolType: + title: tt_NetworkProtocolType + enum: + - HTTP + - HTTPS + - RTSP + type: string + description: '' + xml: + name: NetworkProtocolType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostType: + title: tt_NetworkHostType + enum: + - IPv4 + - IPv6 + - DNS + type: string + description: '' + xml: + name: NetworkHostType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHost: + title: tt_NetworkHost + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address. + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSname: + type: string + description: DNS name. + xml: + name: DNSname + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkHost + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostExtension: + title: tt_NetworkHostExtension + type: object + description: '' + xml: + name: NetworkHostExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddress: + title: tt_IPAddress + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv4Address: + title: tt_PrefixedIPv4Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv4 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv6Address: + title: tt_PrefixedIPv6Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv6 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPType: + title: tt_IPType + enum: + - IPv4 + - IPv6 + type: string + description: '' + xml: + name: IPType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformation: + title: tt_HostnameInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether the hostname is obtained from DHCP or not. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: Indicates the hostname. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: HostnameInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformationExtension: + title: tt_HostnameInformationExtension + type: object + description: '' + xml: + name: HostnameInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformation: + title: tt_DNSInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether or not DNS information is retrieved from DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SearchDomain: + type: array + items: + type: string + xml: + name: SearchDomain + attribute: false + wrapped: false + description: Search domain. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of DNS addresses received from DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSManual: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of manually entered DNS addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformationExtension: + title: tt_DNSInformationExtension + type: object + description: '' + xml: + name: DNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformation: + title: tt_NTPInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates if NTP information is to be retrieved by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of NTP addresses retrieved by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPManual: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of manually entered NTP addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NTPInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NTPInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformationExtension: + title: tt_NTPInformationExtension + type: object + description: '' + xml: + name: NTPInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterType: + title: tt_IPAddressFilterType + enum: + - Allow + - Deny + type: string + description: '' + xml: + name: IPAddressFilterType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformation: + title: tt_DynamicDNSInformation + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: DNS name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: string + description: Time to live. + format: date-time + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformationExtension: + title: tt_DynamicDNSInformationExtension + type: object + description: '' + xml: + name: DynamicDNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSType: + title: tt_DynamicDNSType + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + type: string + description: '' + xml: + name: DynamicDNSType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfiguration: + title: tt_NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension: + title: tt_NetworkInterfaceSetConfigurationExtension + type: object + properties: + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterfaceSetConfiguration: + title: tt_IPv6NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually added IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterfaceSetConfiguration: + title: tt_IPv4NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkGateway: + title: tt_NetworkGateway + type: object + properties: + IPv4Address: + type: array + items: + type: string + xml: + name: IPv4Address + attribute: false + wrapped: false + description: IPv4 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + type: string + xml: + name: IPv6Address + attribute: false + wrapped: false + description: IPv6 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkGateway + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfiguration: + title: tt_NetworkZeroConfiguration + required: + - InterfaceToken + - Enabled + type: object + properties: + InterfaceToken: + maxLength: 64 + type: string + description: Unique identifier of network interface. + xml: + name: InterfaceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates whether the zero-configuration is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Addresses: + type: array + items: + type: string + xml: + name: Addresses + attribute: false + wrapped: false + description: The zero-configuration IPv4 address(es) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension: + title: tt_NetworkZeroConfigurationExtension + type: object + properties: + Additional: + type: array + items: + $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + description: Optional array holding the configuration for the second and possibly further interfaces. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension2: + title: tt_NetworkZeroConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkZeroConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilter: + title: tt_IPAddressFilter + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterExtension: + title: tt_IPAddressFilterExtension + type: object + description: '' + xml: + name: IPAddressFilterExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Configuration: + title: tt_Dot11Configuration + required: + - SSID + - Mode + - Alias + - Priority + - Security + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11StationMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Alias: + maxLength: 64 + type: string + xml: + name: Alias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + maximum: 31 + minimum: 0 + type: integer + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfiguration' + - xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11StationMode: + title: tt_Dot11StationMode + enum: + - Ad-hoc + - Infrastructure + - Extended + type: string + description: '' + xml: + name: Dot11StationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfiguration: + title: tt_Dot11SecurityConfiguration + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Algorithm: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: Algorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PSK: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSet' + - xml: + name: PSK + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot1X: + maxLength: 64 + type: string + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11SecurityConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfigurationExtension: + title: tt_Dot11SecurityConfigurationExtension + type: object + description: '' + xml: + name: Dot11SecurityConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityMode: + title: tt_Dot11SecurityMode + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + type: string + description: '' + xml: + name: Dot11SecurityMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Cipher: + title: tt_Dot11Cipher + enum: + - CCMP + - TKIP + - Any + - Extended + type: string + description: '' + xml: + name: Dot11Cipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSet: + title: tt_Dot11PSKSet + type: object + properties: + Key: + type: string + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex + format: binary + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Passphrase: + pattern: '[ -~]{8,63}' + type: string + description: >- + According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and + each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. + xml: + name: Passphrase + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSetExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11PSKSet + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSetExtension: + title: tt_Dot11PSKSetExtension + type: object + description: '' + xml: + name: Dot11PSKSetExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension2: + title: tt_NetworkInterfaceSetConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Capabilities: + title: tt_Dot11Capabilities + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + type: object + properties: + TKIP: + type: boolean + xml: + name: TKIP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScanAvailableNetworks: + type: boolean + xml: + name: ScanAvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MultipleConfiguration: + type: boolean + xml: + name: MultipleConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AdHocStationMode: + type: boolean + xml: + name: AdHocStationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WEP: + type: boolean + xml: + name: WEP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SignalStrength: + title: tt_Dot11SignalStrength + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + type: string + description: '' + xml: + name: Dot11SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Status: + title: tt_Dot11Status + required: + - SSID + - ActiveConfigAlias + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: PairCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: GroupCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ActiveConfigAlias: + maxLength: 64 + type: string + xml: + name: ActiveConfigAlias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AuthAndMangementSuite: + title: tt_Dot11AuthAndMangementSuite + enum: + - None + - Dot1X + - PSK + - Extended + type: string + description: '' + xml: + name: Dot11AuthAndMangementSuite + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworks: + title: tt_Dot11AvailableNetworks + required: + - SSID + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuthAndMangementSuite: + type: array + items: + $ref: '#/components/schemas/tt_Dot11AuthAndMangementSuite' + description: See IEEE802.11 7.3.2.25.2 for details. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11AvailableNetworksExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11AvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworksExtension: + title: tt_Dot11AvailableNetworksExtension + type: object + description: '' + xml: + name: Dot11AvailableNetworksExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilityCategory: + title: tt_CapabilityCategory + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + type: string + description: '' + xml: + name: CapabilityCategory + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Capabilities: + title: tt_Capabilities + type: object + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsCapabilities' + - description: Analytics capabilities + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Device: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilities' + - description: Device capabilities + xml: + name: Device + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventCapabilities' + - description: Event capabilities + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingCapabilities' + - description: Imaging capabilities + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Media: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilities' + - description: Media capabilities + xml: + name: Media + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZCapabilities' + - description: PTZ capabilities + xml: + name: PTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension: + title: tt_CapabilitiesExtension + type: object + properties: + DeviceIO: + allOf: + - $ref: '#/components/schemas/tt_DeviceIOCapabilities' + - xml: + name: DeviceIO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Display: + allOf: + - $ref: '#/components/schemas/tt_DisplayCapabilities' + - xml: + name: Display + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Recording: + allOf: + - $ref: '#/components/schemas/tt_RecordingCapabilities' + - xml: + name: Recording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Search: + allOf: + - $ref: '#/components/schemas/tt_SearchCapabilities' + - xml: + name: Search + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Replay: + allOf: + - $ref: '#/components/schemas/tt_ReplayCapabilities' + - xml: + name: Replay + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tt_ReceiverCapabilities' + - xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsDevice: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceCapabilities' + - xml: + name: AnalyticsDevice + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extensions: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension2' + - xml: + name: Extensions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension2: + title: tt_CapabilitiesExtension2 + type: object + description: '' + xml: + name: CapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsCapabilities: + title: tt_AnalyticsCapabilities + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + type: object + properties: + XAddr: + type: string + description: Analytics service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Indicates whether or not rules are supported. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleSupport: + type: boolean + description: Indicates whether or not modules are supported. + xml: + name: AnalyticsModuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilities: + title: tt_DeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Device service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilities' + - description: Network capabilities. + xml: + name: Network + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilities' + - description: System capabilities. + xml: + name: System + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IO: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilities' + - description: I/O capabilities. + xml: + name: IO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilities' + - description: Security capabilities. + xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilitiesExtension: + title: tt_DeviceCapabilitiesExtension + type: object + description: '' + xml: + name: DeviceCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventCapabilities: + title: tt_EventCapabilities + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + type: object + properties: + XAddr: + type: string + description: Event service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSSubscriptionPolicySupport: + type: boolean + description: Indicates whether or not WS Subscription policy is supported. + xml: + name: WSSubscriptionPolicySupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPullPointSupport: + type: boolean + description: Indicates whether or not WS Pull Point is supported. + xml: + name: WSPullPointSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPausableSubscriptionManagerInterfaceSupport: + type: boolean + description: Indicates whether or not WS Pausable Subscription Manager Interface is supported. + xml: + name: WSPausableSubscriptionManagerInterfaceSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EventCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilities: + title: tt_IOCapabilities + type: object + properties: + InputConnectors: + type: integer + description: Number of input connectors. + format: int32 + xml: + name: InputConnectors + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + description: Number of relay outputs. + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension: + title: tt_IOCapabilitiesExtension + required: + - Extension + type: object + properties: + Auxiliary: + type: boolean + xml: + name: Auxiliary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension2: + title: tt_IOCapabilitiesExtension2 + type: object + description: '' + xml: + name: IOCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilities: + title: tt_MediaCapabilities + required: + - XAddr + - StreamingCapabilities + type: object + properties: + XAddr: + type: string + description: Media service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilitiesExtension: + title: tt_MediaCapabilitiesExtension + required: + - ProfileCapabilities + type: object + properties: + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tt_ProfileCapabilities' + - xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilities: + title: tt_RealTimeStreamingCapabilities + type: object + properties: + RTPMulticast: + type: boolean + description: Indicates whether or not RTP multicast is supported. + xml: + name: RTPMulticast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether or not RTP over TCP is supported. + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether or not RTP/RTSP/TCP is supported. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RealTimeStreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilitiesExtension: + title: tt_RealTimeStreamingCapabilitiesExtension + type: object + description: '' + xml: + name: RealTimeStreamingCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileCapabilities: + title: tt_ProfileCapabilities + required: + - MaximumNumberOfProfiles + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilities: + title: tt_NetworkCapabilities + type: object + properties: + IPFilter: + type: boolean + description: Indicates whether or not IP filtering is supported. + xml: + name: IPFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZeroConfiguration: + type: boolean + description: Indicates whether or not zeroconf is supported. + xml: + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPVersion6: + type: boolean + description: Indicates whether or not IPv6 is supported. + xml: + name: IPVersion6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynDNS: + type: boolean + description: Indicates whether or not is supported. + xml: + name: DynDNS + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension: + title: tt_NetworkCapabilitiesExtension + type: object + properties: + Dot11Configuration: + type: boolean + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension2: + title: tt_NetworkCapabilitiesExtension2 + type: object + description: '' + xml: + name: NetworkCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilities: + title: tt_SecurityCapabilities + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + type: object + properties: + TLS1.1: + type: boolean + description: Indicates whether or not TLS 1.1 is supported. + xml: + name: TLS1.1 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TLS1.2: + type: boolean + description: Indicates whether or not TLS 1.2 is supported. + xml: + name: TLS1.2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OnboardKeyGeneration: + type: boolean + description: Indicates whether or not onboard key generation is supported. + xml: + name: OnboardKeyGeneration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AccessPolicyConfig: + type: boolean + description: Indicates whether or not access policy configuration is supported. + xml: + name: AccessPolicyConfig + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + X.509Token: + type: boolean + description: Indicates whether or not WS-Security X.509 token is supported. + xml: + name: X.509Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SAMLToken: + type: boolean + description: Indicates whether or not WS-Security SAML token is supported. + xml: + name: SAMLToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KerberosToken: + type: boolean + description: Indicates whether or not WS-Security Kerberos token is supported. + xml: + name: KerberosToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RELToken: + type: boolean + description: Indicates whether or not WS-Security REL token is supported. + xml: + name: RELToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension: + title: tt_SecurityCapabilitiesExtension + required: + - TLS1.0 + type: object + properties: + TLS1.0: + type: boolean + xml: + name: TLS1.0 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension2: + title: tt_SecurityCapabilitiesExtension2 + required: + - Dot1X + - RemoteUserHandling + type: object + properties: + Dot1X: + type: boolean + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedEAPMethod: + type: array + items: + type: integer + format: int32 + xml: + name: SupportedEAPMethod + attribute: false + wrapped: false + description: EAP Methods supported by the device. The int values refer to the + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteUserHandling: + type: boolean + xml: + name: RemoteUserHandling + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilities: + title: tt_SystemCapabilities + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + type: object + properties: + DiscoveryResolve: + type: boolean + description: Indicates whether or not WS Discovery resolve requests are supported. + xml: + name: DiscoveryResolve + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DiscoveryBye: + type: boolean + description: Indicates whether or not WS-Discovery Bye is supported. + xml: + name: DiscoveryBye + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteDiscovery: + type: boolean + description: Indicates whether or not remote discovery is supported. + xml: + name: RemoteDiscovery + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemBackup: + type: boolean + description: Indicates whether or not system backup is supported. + xml: + name: SystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemLogging: + type: boolean + description: Indicates whether or not system logging is supported. + xml: + name: SystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FirmwareUpgrade: + type: boolean + description: Indicates whether or not firmware upgrade is supported. + xml: + name: FirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedVersions: + type: array + items: + $ref: '#/components/schemas/tt_OnvifVersion' + description: Indicates supported ONVIF version(s). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension: + title: tt_SystemCapabilitiesExtension + type: object + properties: + HttpFirmwareUpgrade: + type: boolean + xml: + name: HttpFirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemBackup: + type: boolean + xml: + name: HttpSystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemLogging: + type: boolean + xml: + name: HttpSystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSupportInformation: + type: boolean + xml: + name: HttpSupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension2: + title: tt_SystemCapabilitiesExtension2 + type: object + description: '' + xml: + name: SystemCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OnvifVersion: + title: tt_OnvifVersion + required: + - Major + - Minor + type: object + properties: + Major: + type: integer + description: Major version number. + format: int32 + xml: + name: Major + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minor: + type: integer + description: >- + Two digit minor version number. + If 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. + Otherwise, minor number is month of release, such as "06" for June. + format: int32 + xml: + name: Minor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OnvifVersion + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingCapabilities: + title: tt_ImagingCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Imaging service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZCapabilities: + title: tt_PTZCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: PTZ service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceIOCapabilities: + title: tt_DeviceIOCapabilities + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSources: + type: integer + format: int32 + xml: + name: VideoSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoOutputs: + type: integer + format: int32 + xml: + name: VideoOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSources: + type: integer + format: int32 + xml: + name: AudioSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputs: + type: integer + format: int32 + xml: + name: AudioOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceIOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DisplayCapabilities: + title: tt_DisplayCapabilities + required: + - XAddr + - FixedLayout + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedLayout: + type: boolean + description: Indication that the SetLayout command supports only predefined layouts. + xml: + name: FixedLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DisplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingCapabilities: + title: tt_RecordingCapabilities + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverSource: + type: boolean + xml: + name: ReceiverSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaProfileSource: + type: boolean + xml: + name: MediaProfileSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicRecordings: + type: boolean + xml: + name: DynamicRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicTracks: + type: boolean + xml: + name: DynamicTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxStringLength: + type: integer + format: int32 + xml: + name: MaxStringLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchCapabilities: + title: tt_SearchCapabilities + required: + - XAddr + - MetadataSearch + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataSearch: + type: boolean + xml: + name: MetadataSearch + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SearchCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayCapabilities: + title: tt_ReplayCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: The address of the replay service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverCapabilities: + title: tt_ReceiverCapabilities + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + type: object + properties: + XAddr: + type: string + description: The address of the receiver service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_Multicast: + type: boolean + description: Indicates whether the device can receive RTP multicast streams. + xml: + name: RTP_Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/TCP streams + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedReceivers: + type: integer + description: The maximum number of receivers supported by the device. + format: int32 + xml: + name: SupportedReceivers + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRTSPURILength: + type: integer + description: The maximum allowed length for RTSP URIs. + format: int32 + xml: + name: MaximumRTSPURILength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReceiverCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceCapabilities: + title: tt_AnalyticsDeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Obsolete property. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceExtension: + title: tt_AnalyticsDeviceExtension + type: object + description: '' + xml: + name: AnalyticsDeviceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogType: + title: tt_SystemLogType + enum: + - System + - Access + type: string + description: Enumeration describing the available system log modes. + xml: + name: SystemLogType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLog: + title: tt_SystemLog + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The log information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The log information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLog + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportInformation: + title: tt_SupportInformation + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The support information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The support information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BinaryData: + title: tt_BinaryData + required: + - Data + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Data: + type: string + description: base64 encoded binary data. + format: binary + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BinaryData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AttachmentData: + title: tt_AttachmentData + required: + - Include + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Include: + allOf: + - $ref: '#/components/schemas/xop_Include' + - xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + description: '' + xml: + name: AttachmentData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BackupFile: + title: tt_BackupFile + required: + - Name + - Data + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BackupFile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUriList: + title: tt_SystemLogUriList + type: object + properties: + SystemLog: + type: array + items: + $ref: '#/components/schemas/tt_SystemLogUri' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUriList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUri: + title: tt_SystemLogUri + required: + - Type + - Uri + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Uri: + type: string + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FactoryDefaultType: + title: tt_FactoryDefaultType + enum: + - Hard + - Soft + type: string + description: Enumeration describing the available factory default modes. + xml: + name: FactoryDefaultType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SetDateTimeType: + title: tt_SetDateTimeType + enum: + - Manual + - NTP + type: string + description: '' + xml: + name: SetDateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTime: + title: tt_SystemDateTime + required: + - DateTimeType + - DaylightSavings + type: object + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + xml: + name: DateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DaylightSavings: + type: boolean + description: Informative indicator whether daylight savings is currently on/off. + xml: + name: DaylightSavings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: Timezone information in Posix format. + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Current system date and time in UTC format. This field is mandatory since version 2.0. + xml: + name: UTCDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in local format. + xml: + name: LocalDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTimeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: General date time inforamtion returned by the GetSystemDateTime method. + xml: + name: SystemDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTimeExtension: + title: tt_SystemDateTimeExtension + type: object + description: '' + xml: + name: SystemDateTimeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTime: + title: tt_DateTime + required: + - Time + - Date + type: object + properties: + Time: + allOf: + - $ref: '#/components/schemas/tt_Time' + - xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Date: + allOf: + - $ref: '#/components/schemas/tt_Date' + - xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Date: + title: tt_Date + required: + - Year + - Month + - Day + type: object + properties: + Year: + type: integer + format: int32 + xml: + name: Year + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Month: + type: integer + description: Range is 1 to 12. + format: int32 + xml: + name: Month + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Day: + type: integer + description: Range is 1 to 31. + format: int32 + xml: + name: Day + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Time: + title: tt_Time + required: + - Hour + - Minute + - Second + type: object + properties: + Hour: + type: integer + description: Range is 0 to 23. + format: int32 + xml: + name: Hour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minute: + type: integer + description: Range is 0 to 59. + format: int32 + xml: + name: Minute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Second: + type: integer + description: Range is 0 to 61 (typically 59). + format: int32 + xml: + name: Second + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TimeZone: + title: tt_TimeZone + required: + - TZ + type: object + properties: + TZ: + type: string + description: Posix timezone string. + xml: + name: TZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3 + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RemoteUser: + title: tt_RemoteUser + required: + - Username + - UseDerivedPassword + type: object + properties: + Username: + type: string + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseDerivedPassword: + type: boolean + xml: + name: UseDerivedPassword + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RemoteUser + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserLevel: + title: tt_UserLevel + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + description: '' + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_User: + title: tt_User + required: + - Username + - UserLevel + type: object + properties: + Username: + type: string + description: Username string. + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password string. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UserLevel: + allOf: + - $ref: '#/components/schemas/tt_UserLevel' + - description: User level string. + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_UserExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: User + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserExtension: + title: tt_UserExtension + type: object + description: '' + xml: + name: UserExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParameters: + title: tt_CertificateGenerationParameters + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subject: + type: string + xml: + name: Subject + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotBefore: + type: string + xml: + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotAfter: + type: string + xml: + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateGenerationParametersExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateGenerationParameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParametersExtension: + title: tt_CertificateGenerationParametersExtension + type: object + description: '' + xml: + name: CertificateGenerationParametersExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Certificate: + title: tt_Certificate + required: + - CertificateID + - Certificate + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateStatus: + title: tt_CertificateStatus + required: + - CertificateID + - Status + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + type: boolean + description: Indicates whether or not a certificate is used in a HTTPS configuration. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateWithPrivateKey: + title: tt_CertificateWithPrivateKey + required: + - Certificate + - PrivateKey + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrivateKey: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: PrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformation: + title: tt_CertificateInformation + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IssuerDN: + type: string + xml: + name: IssuerDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubjectDN: + type: string + xml: + name: SubjectDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: KeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExtendedKeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: ExtendedKeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyLength: + type: integer + format: int32 + xml: + name: KeyLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Version: + type: string + xml: + name: Version + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SerialNum: + type: string + xml: + name: SerialNum + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignatureAlgorithm: + type: string + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding DateTimeRange is from "From" to "Until" + xml: + name: SignatureAlgorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Validity: + allOf: + - $ref: '#/components/schemas/tt_DateTimeRange' + - xml: + name: Validity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateUsage: + title: tt_CertificateUsage + required: + - Critical + type: object + properties: + Critical: + type: boolean + xml: + name: Critical + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: CertificateUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformationExtension: + title: tt_CertificateInformationExtension + type: object + description: '' + xml: + name: CertificateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfiguration: + title: tt_Dot1XConfiguration + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + type: object + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Identity: + type: string + xml: + name: Identity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnonymousID: + type: string + xml: + name: AnonymousID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethod: + type: integer + description: EAP Method type as defined in + format: int32 + xml: + name: EAPMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CACertificateID: + type: array + items: + type: string + xml: + name: CACertificateID + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethodConfiguration: + allOf: + - $ref: '#/components/schemas/tt_EAPMethodConfiguration' + - xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfigurationExtension: + title: tt_Dot1XConfigurationExtension + type: object + description: '' + xml: + name: Dot1XConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EAPMethodConfiguration: + title: tt_EAPMethodConfiguration + type: object + properties: + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/tt_TLSConfiguration' + - description: Confgiuration information for TLS Method. + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password for those EAP Methods that require a password. The password shall never be returned on a get method. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EapMethodExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EapMethodExtension: + title: tt_EapMethodExtension + type: object + description: '' + xml: + name: EapMethodExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TLSConfiguration: + title: tt_TLSConfiguration + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GenericEapPwdConfigurationExtension: + title: tt_GenericEapPwdConfigurationExtension + type: object + description: '' + xml: + name: GenericEapPwdConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayLogicalState: + title: tt_RelayLogicalState + enum: + - active + - inactive + type: string + description: '' + xml: + name: RelayLogicalState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayIdleState: + title: tt_RelayIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: RelayIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutputSettings: + title: tt_RelayOutputSettings + required: + - Mode + - DelayTime + - IdleState + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RelayMode' + - description: "'Bistable' or 'Monostable'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DelayTime: + type: string + 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. + format: date-time + xml: + name: DelayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IdleState: + allOf: + - $ref: '#/components/schemas/tt_RelayIdleState' + - description: "'open' or 'closed'" + xml: + name: IdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelayOutputSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayMode: + title: tt_RelayMode + enum: + - Monostable + - Bistable + type: string + description: '' + xml: + name: RelayMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutput: + title: tt_RelayOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Properties + type: object + properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + name: Properties + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: RelayOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_DigitalIdleState: + title: tt_DigitalIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: DigitalIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DigitalInput: + title: tt_DigitalInput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + properties: + IdleState: + allOf: + - $ref: '#/components/schemas/tt_DigitalIdleState' + - description: Indicate the Digital IdleState status. + xml: + name: IdleState + prefix: tt + attribute: true + wrapped: false + xml: + name: DigitalInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNode: + title: tt_PTZNode + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + properties: + Name: + maxLength: 64 + type: string + description: A unique identifier that is used to reference PTZ Nodes. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range. + xml: + name: SupportedPTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumNumberOfPresets: + type: integer + description: All preset operations MUST be available for this PTZ Node if one preset is supported. + format: int32 + xml: + name: MaximumNumberOfPresets + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HomeSupported: + type: boolean + 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. + xml: + name: HomeSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedHomePosition: + type: boolean + description: Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command. + xml: + name: FixedHomePosition + prefix: tt + attribute: true + wrapped: false + GeoMove: + type: boolean + description: Indication whether the Node supports the geo-referenced move command. + xml: + name: GeoMove + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZNode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNodeExtension: + title: tt_PTZNodeExtension + type: object + properties: + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + xml: + name: SupportedPresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZNodeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZNodeExtension2: + title: tt_PTZNodeExtension2 + type: object + description: '' + xml: + name: PTZNodeExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupported: + title: tt_PTZPresetTourSupported + required: + - MaximumNumberOfPresetTours + type: object + properties: + MaximumNumberOfPresetTours: + type: integer + 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. + format: int32 + xml: + name: MaximumNumberOfPresetTours + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPresetTourOperation: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourOperation' + description: Indicates which preset tour operations are available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupportedExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupportedExtension: + title: tt_PTZPresetTourSupportedExtension + type: object + description: '' + xml: + name: PTZPresetTourSupportedExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension: + title: tt_PTZConfigurationExtension + type: object + properties: + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirection' + - description: Optional element to configure PT Control Direction related features. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension2: + title: tt_PTZConfigurationExtension2 + type: object + description: '' + xml: + name: PTZConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirection: + title: tt_PTControlDirection + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlip' + - description: Optional element to configure related parameters for E-Flip. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_Reverse' + - description: Optional element to configure related parameters for reversing of PT Control Direction. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionExtension: + title: tt_PTControlDirectionExtension + type: object + description: '' + xml: + name: PTControlDirectionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlip: + title: tt_EFlip + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Reverse: + title: tt_Reverse + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipMode: + title: tt_EFlipMode + enum: + - OFF + - ON + - Extended + type: string + description: '' + xml: + name: EFlipMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseMode: + title: tt_ReverseMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ReverseMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions: + title: tt_PTZConfigurationOptions + required: + - Spaces + - PTZTimeout + type: object + properties: + PTZRamps: + type: integer + description: >- + The list of acceleration ramps supported by the device. The + smallest acceleration value corresponds to the minimal index, the + highest acceleration corresponds to the maximum index. + format: int32 + xml: + name: PTZRamps + prefix: tt + attribute: true + wrapped: false + Spaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of supported coordinate systems including their range limitations. + xml: + name: Spaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZTimeout: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the PTZ Node. + xml: + name: PTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions2: + title: tt_PTZConfigurationOptions2 + type: object + description: '' + xml: + name: PTZConfigurationOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptions: + title: tt_PTControlDirectionOptions + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptions' + - description: Supported options for EFlip feature. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptions' + - description: Supported options for Reverse feature. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirectionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptionsExtension: + title: tt_PTControlDirectionOptionsExtension + type: object + description: '' + xml: + name: PTControlDirectionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptions: + title: tt_EFlipOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_EFlipMode' + description: Options of EFlip mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlipOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptionsExtension: + title: tt_EFlipOptionsExtension + type: object + description: '' + xml: + name: EFlipOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptions: + title: tt_ReverseOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ReverseMode' + description: Options of Reverse mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReverseOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptionsExtension: + title: tt_ReverseOptionsExtension + type: object + description: '' + xml: + name: ReverseOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PanTiltLimits: + title: tt_PanTiltLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: A range of pan tilt limits. + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ZoomLimits: + title: tt_ZoomLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: A range of zoom limit + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpaces: + title: tt_PTZSpaces + type: object + properties: + AbsolutePanTiltPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AbsoluteZoomPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). \n There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePanTiltTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativeZoomTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, 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 where 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 There 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousPanTiltVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 rotation 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousZoomVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt \n movement is represented by a single non-negative scalar value." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZSpacesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpacesExtension: + title: tt_PTZSpacesExtension + type: object + description: '' + xml: + name: PTZSpacesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space2DDescription: + title: tt_Space2DDescription + required: + - URI + - XRange + - YRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space2DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space1DDescription: + title: tt_Space1DDescription + required: + - URI + - XRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space1DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpeed: + title: tt_PTZSpeed + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - 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. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPreset: + title: tt_PTZPreset + type: object + properties: + token: + maxLength: 64 + type: string + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: A list of preset position name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A list of preset position. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPreset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourState: + title: tt_PTZPresetTourState + enum: + - Idle + - Touring + - Paused + - Extended + type: string + description: '' + xml: + name: PTZPresetTourState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourDirection: + title: tt_PTZPresetTourDirection + enum: + - Forward + - Backward + - Extended + type: string + description: '' + xml: + name: PTZPresetTourDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOperation: + title: tt_PTZPresetTourOperation + enum: + - Start + - Stop + - Pause + - Extended + type: string + description: '' + xml: + name: PTZPresetTourOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PresetTour: + title: tt_PresetTour + required: + - Status + - AutoStart + - StartingCondition + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of this preset tour. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: Readable name of the preset tour. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset tour. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Auto Start flag of the preset tour. True allows the preset tour to be activated always. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourSpot' + description: A list of detail of touring spots including preset positions. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourExtension: + title: tt_PTZPresetTourExtension + type: object + description: '' + xml: + name: PTZPresetTourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpot: + title: tt_PTZPresetTourSpot + required: + - PresetDetail + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + type: string + description: Optional parameter to specify time duration of staying on this tour sport. + format: date-time + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotExtension: + title: tt_PTZPresetTourSpotExtension + type: object + description: '' + xml: + name: PTZPresetTourSpotExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetail: + title: tt_PTZPresetTourPresetDetail + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourTypeExtension: + title: tt_PTZPresetTourTypeExtension + type: object + description: '' + xml: + name: PTZPresetTourTypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatus: + title: tt_PTZPresetTourStatus + required: + - State + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + xml: + name: CurrentTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatusExtension: + title: tt_PTZPresetTourStatusExtension + type: object + description: '' + xml: + name: PTZPresetTourStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingCondition: + title: tt_PTZPresetTourStartingCondition + type: object + properties: + RandomPresetOrder: + type: 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. + xml: + name: RandomPresetOrder + prefix: tt + attribute: true + wrapped: false + RecurringTime: + type: integer + description: Optional parameter to specify how many times the preset tour is recurred. + format: int32 + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + type: string + description: Optional parameter to specify how long time duration the preset tour is recurred. + format: date-time + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted. + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionExtension: + title: tt_PTZPresetTourStartingConditionExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOptions: + title: tt_PTZPresetTourOptions + required: + - AutoStart + - StartingCondition + - TourSpot + type: object + properties: + AutoStart: + type: boolean + description: Indicates whether or not the AutoStart is supported. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + xml: + name: TourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotOptions: + title: tt_PTZPresetTourSpotOptions + required: + - PresetDetail + - StayTime + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of stay time for a tour spot. + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpotOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptions: + title: tt_PTZPresetTourPresetDetailOptions + type: object + properties: + PresetToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: PresetToken + attribute: false + wrapped: false + description: A list of available Preset Tokens for tour spots. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + description: An option to indicate Home postion for tour spots. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + xml: + name: PanTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + xml: + name: ZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetailOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptionsExtension: + title: tt_PTZPresetTourPresetDetailOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourPresetDetailOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptions: + title: tt_PTZPresetTourStartingConditionOptions + type: object + properties: + RecurringTime: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of Recurring Time. + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of Recurring Duration. + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourDirection' + description: Supported options for Direction of Preset Tour. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingConditionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptionsExtension: + title: tt_PTZPresetTourStartingConditionOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveAndTrackMethod: + title: tt_MoveAndTrackMethod + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + type: string + description: '' + xml: + name: MoveAndTrackMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus: + title: tt_ImagingStatus + required: + - FocusStatus + type: object + properties: + FocusStatus: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus' + - xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus: + title: tt_FocusStatus + required: + - Position + - MoveStatus + - Error + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration: + title: tt_FocusConfiguration + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: >- + Parameter to set autofocus far limit (unit: meter). + + If set to 0.0, infinity will be used. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AutoFocusMode: + title: tt_AutoFocusMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AFModes: + title: tt_AFModes + enum: + - OnceAfterMove + type: string + description: '' + xml: + name: AFModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings: + title: tt_ImagingSettings + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension: + title: tt_ImagingSettingsExtension + type: object + description: '' + xml: + name: ImagingSettingsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure: + title: tt_Exposure + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + description: Minimum value of the iris range allowed to be used by the algorithm. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + description: Maximum value of the iris range allowed to be used by the algorithm. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + description: The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicMode: + title: tt_WideDynamicMode + enum: + - OFF + - ON + type: string + description: '' + xml: + name: WideDynamicMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange: + title: tt_WideDynamicRange + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: White dynamic range (on/off) + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unitless) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationMode: + title: tt_BacklightCompensationMode + enum: + - OFF + - ON + type: string + description: Enumeration describing the available backlight compenstation modes. + xml: + name: BacklightCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation: + title: tt_BacklightCompensation + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposurePriority: + title: tt_ExposurePriority + enum: + - LowNoise + - FrameRate + type: string + description: '' + xml: + name: ExposurePriority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions: + title: tt_ImagingOptions + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions' + - xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions' + - xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions' + - xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions' + - xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions' + - xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions: + title: tt_WideDynamicRangeOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions: + title: tt_BacklightCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions: + title: tt_FocusOptions + required: + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions: + title: tt_ExposureOptions + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions: + title: tt_WhiteBalanceOptions + required: + - Mode + - YrGain + - YbGain + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusMove: + title: tt_FocusMove + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocus' + - description: Parameters for the absolute focus control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocus' + - description: Parameters for the relative focus control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocus' + - description: Parameter for the continuous focus control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusMove + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocus: + title: tt_AbsoluteFocus + required: + - Position + type: object + properties: + Position: + type: number + description: Position parameter for the absolute focus control. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the absolute focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocus: + title: tt_RelativeFocus + required: + - Distance + type: object + properties: + Distance: + type: number + description: Distance parameter for the relative focus control. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the relative focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocus: + title: tt_ContinuousFocus + required: + - Speed + type: object + properties: + Speed: + type: number + description: Speed parameter for the Continuous focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions: + title: tt_MoveOptions + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions' + - xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocusOptions: + title: tt_AbsoluteFocusOptions + required: + - Position + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions: + title: tt_RelativeFocusOptions + required: + - Distance + - Speed + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocusOptions: + title: tt_ContinuousFocusOptions + required: + - Speed + type: object + properties: + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureMode: + title: tt_ExposureMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: ExposureMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Enabled: + title: tt_Enabled + enum: + - ENABLED + - DISABLED + type: string + description: '' + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceMode: + title: tt_WhiteBalanceMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: WhiteBalanceMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterMode: + title: tt_IrCutFilterMode + enum: + - ON + - OFF + - AUTO + type: string + description: '' + xml: + name: IrCutFilterMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance: + title: tt_WhiteBalance + required: + - Mode + - CrGain + - CbGain + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20: + title: tt_ImagingStatus20 + type: object + properties: + FocusStatus20: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20' + - description: Status of focus. + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20Extension: + title: tt_ImagingStatus20Extension + type: object + description: '' + xml: + name: ImagingStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20: + title: tt_FocusStatus20 + required: + - Position + - MoveStatus + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20Extension: + title: tt_FocusStatus20Extension + type: object + description: '' + xml: + name: FocusStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings20: + title: tt_ImagingSettings20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure20' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange20' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension20' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command. + xml: + name: ImagingSettings20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension20: + title: tt_ImagingSettingsExtension20 + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension202' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension202: + title: tt_ImagingSettingsExtension202 + type: object + properties: + IrCutFilterAutoAdjustment: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustment' + description: An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension203' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension202 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension203: + title: tt_ImagingSettingsExtension203 + type: object + properties: + ToneCompensation: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Defogging: + allOf: + - $ref: '#/components/schemas/tt_Defogging' + - description: Optional element to configure Image Defogging. + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReduction: + allOf: + - $ref: '#/components/schemas/tt_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension204' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension203 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension204: + title: tt_ImagingSettingsExtension204 + type: object + description: '' + xml: + name: ImagingSettingsExtension204 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilization: + title: tt_ImageStabilization + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationExtension: + title: tt_ImageStabilizationExtension + type: object + description: '' + xml: + name: ImageStabilizationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationMode: + title: tt_ImageStabilizationMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ImageStabilizationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustment: + title: tt_IrCutFilterAutoAdjustment + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: string + description: Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + name: BoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: number + 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). + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTime: + type: string + description: Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels. + format: date-time + xml: + name: ResponseTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentExtension: + title: tt_IrCutFilterAutoAdjustmentExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoBoundaryType: + title: tt_IrCutFilterAutoBoundaryType + enum: + - Common + - ToOn + - ToOff + - Extended + type: string + description: '' + xml: + name: IrCutFilterAutoBoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange20: + title: tt_WideDynamicRange20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether WDR mode is enabled or disabled (on/off). + xml: + name: WideDynamicRange20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation20: + title: tt_BacklightCompensation20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether BLC mode is enabled or disabled (on/off). + xml: + name: BacklightCompensation20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure20: + title: tt_Exposure20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + 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. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + 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. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + 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. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the exposure settings. + xml: + name: Exposure20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensation: + title: tt_ToneCompensation + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationExtension: + title: tt_ToneCompensationExtension + type: object + description: '' + xml: + name: ToneCompensationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationMode: + title: tt_ToneCompensationMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: ToneCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Defogging: + title: tt_Defogging + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DefoggingExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingExtension: + title: tt_DefoggingExtension + type: object + description: '' + xml: + name: DefoggingExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingMode: + title: tt_DefoggingMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: DefoggingMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReduction: + title: tt_NoiseReduction + required: + - Level + type: object + properties: + Level: + type: number + description: Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20: + title: tt_ImagingOptions20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Brightness. + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Color Saturation. + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Contrast. + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions20' + - description: Valid range of Exposure. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20' + - description: Valid range of Focus. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: Valid range of IrCutFilterModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Sharpness. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension: + title: tt_ImagingOptions20Extension + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension2: + title: tt_ImagingOptions20Extension2 + type: object + properties: + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto mode. + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension3' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension3: + title: tt_ImagingOptions20Extension3 + type: object + properties: + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/tt_DefoggingOptions' + - description: Options of parameters for Defogging feature. + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/tt_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension4' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension3 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension4: + title: tt_ImagingOptions20Extension4 + type: object + description: '' + xml: + name: ImagingOptions20Extension4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptions: + title: tt_ImageStabilizationOptions + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ImageStabilizationMode' + description: Supported options of Image Stabilization mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Image Stabilization. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilizationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptionsExtension: + title: tt_ImageStabilizationOptionsExtension + type: object + description: '' + xml: + name: ImageStabilizationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptions: + title: tt_IrCutFilterAutoAdjustmentOptions + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: array + items: + type: string + xml: + name: BoundaryType + attribute: false + wrapped: false + description: Supported options of boundary types for adjustment of Ir cut filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: boolean + description: Indicates whether or not boundary offset for toggling Ir cut filter is supported. + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + xml: + name: ResponseTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptionsExtension: + title: tt_IrCutFilterAutoAdjustmentOptionsExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions20: + title: tt_WideDynamicRangeOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions20: + title: tt_BacklightCompensationOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_BacklightCompensationMode' + description: "'ON' or 'OFF'" + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Level range of BacklightCompensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions20: + title: tt_ExposureOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: Exposure Mode + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: The exposure priority mode (low noise/framerate). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum ExposureTime. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum ExposureTime. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Gain. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Gain. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Iris. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Iris. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the ExposureTime. + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Gain. + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions20: + title: tt_MoveOptions20 + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions20: + title: tt_RelativeFocusOptions20 + required: + - Distance + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20: + title: tt_WhiteBalance20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: "'AUTO' or 'MANUAL'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20Extension: + title: tt_WhiteBalance20Extension + type: object + description: '' + xml: + name: WhiteBalance20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20: + title: tt_FocusConfiguration20 + required: + - AutoFocusMode + type: object + properties: + AFMode: + type: string + description: Zero or more modes as defined in enumeration tt:AFModes. + xml: + name: AFMode + prefix: tt + attribute: true + wrapped: false + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - description: Mode of auto focus. + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: 'Parameter to set autofocus far limit (unit: meter).' + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20Extension: + title: tt_FocusConfiguration20Extension + type: object + description: '' + xml: + name: FocusConfiguration20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20: + title: tt_WhiteBalanceOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: Mode of WhiteBalance. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20Extension: + title: tt_WhiteBalanceOptions20Extension + type: object + description: '' + xml: + name: WhiteBalanceOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20: + title: tt_FocusOptions20 + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: Supported modes for auto focus. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of DefaultSpeed. + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of NearLimit. + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of FarLimit. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20Extension: + title: tt_FocusOptions20Extension + type: object + properties: + AFModes: + type: array + items: + type: string + xml: + name: AFModes + attribute: false + wrapped: false + description: Supported options for auto focus. Options shall be chosen from tt:AFModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationOptions: + title: tt_ToneCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Tone Compensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingOptions: + title: tt_DefoggingOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Defogging. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReductionOptions: + title: tt_NoiseReductionOptions + required: + - Level + type: object + properties: + Level: + type: boolean + description: Indicates whether or not support Level parameter for NoiseReduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageSendingType: + title: tt_ImageSendingType + enum: + - Embedded + - LocalStorage + - RemoteStorage + type: string + description: '' + xml: + name: ImageSendingType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PropertyOperation: + title: tt_PropertyOperation + enum: + - Initialized + - Deleted + - Changed + type: string + description: '' + xml: + name: PropertyOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Message: + title: tt_Message + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + PropertyOperation: + allOf: + - $ref: '#/components/schemas/tt_PropertyOperation' + - xml: + name: PropertyOperation + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: Token value pairs that triggered this message. Typically only one item is present. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Message + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageExtension: + title: tt_MessageExtension + type: object + description: '' + xml: + name: MessageExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemList: + title: tt_ItemList + type: object + properties: + SimpleItem: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItem' + description: Value name pair as defined by the corresponding description. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItem: + type: array + items: + $ref: '#/components/schemas/tt_ElementItem' + description: Complex value structure. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ItemList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListExtension: + title: tt_ItemListExtension + type: object + description: '' + xml: + name: ItemListExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescription: + title: tt_MessageDescription + type: object + properties: + IsProperty: + type: 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. + xml: + name: IsProperty + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + Set of tokens producing this message. The list may only contain SimpleItemDescription items. + The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key. + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes the payload of the message. + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MessageDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescriptionExtension: + title: tt_MessageDescriptionExtension + type: object + description: '' + xml: + name: MessageDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescription: + title: tt_ItemListDescription + type: object + properties: + SimpleItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItemDescription' + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_ElementItemDescription' + description: Description of a complex type. The Type must reference a defined type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + Describes a list of items. Each item in the list shall have a unique name. + The list is designed as linear structure without optional or unbounded elements. + Use ElementItems only when complex structures are inevitable. + xml: + name: ItemListDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescriptionExtension: + title: tt_ItemListDescriptionExtension + type: object + description: '' + xml: + name: ItemListDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polyline: + title: tt_Polyline + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polyline + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Direction: + title: tt_Direction + enum: + - Left + - Right + - Any + type: string + description: '' + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfiguration: + title: tt_AnalyticsEngineConfiguration + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfigurationExtension: + title: tt_AnalyticsEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfiguration: + title: tt_RuleEngineConfiguration + type: object + properties: + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfigurationExtension: + title: tt_RuleEngineConfigurationExtension + type: object + description: '' + xml: + name: RuleEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Config: + title: tt_Config + required: + - Name + - Type + - Parameters + type: object + properties: + Name: + type: string + description: Name of the configuration. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + 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. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: List of configuration parameters as defined in the corresponding description. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescription: + title: tt_ConfigDescription + required: + - Name + - Parameters + type: object + properties: + Name: + type: string + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies the type of rule, not a type definition in a schema. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: The fixed attribute signals that it is not allowed to add or remove this type of configuration. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + maxInstances: + type: integer + description: The maxInstances attribute signals the maximum number of instances per configuration. + format: int32 + xml: + name: maxInstances + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems + should be used to transport the information to ease parsing of dynamically defined messages by a client + application. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Messages: + type: array + items: + $ref: '#/components/schemas/tt_Messages' + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ConfigDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ConfigDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescriptionExtension: + title: tt_ConfigDescriptionExtension + type: object + description: '' + xml: + name: ConfigDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRules: + title: tt_SupportedRules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + RuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: RuleContentSchemaLocation + attribute: false + wrapped: false + description: Lists the location of all schemas that are referenced in the rules. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: List of rules supported by the Video Analytics configuration.. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedRulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedRules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRulesExtension: + title: tt_SupportedRulesExtension + type: object + description: '' + xml: + name: SupportedRulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModules: + title: tt_SupportedAnalyticsModules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + AnalyticsModuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: AnalyticsModuleContentSchemaLocation + attribute: false + wrapped: false + description: >- + It optionally contains a list of URLs that provide the location of schema files. + These schema files describe the types and elements used in the analytics module descriptions. + Analytics module descriptions that reference types or elements imported from any ONVIF defined schema files + need not explicitly list those schema files. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModulesExtension: + title: tt_SupportedAnalyticsModulesExtension + type: object + description: '' + xml: + name: SupportedAnalyticsModulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArray: + title: tt_PolylineArray + required: + - Segment + type: object + properties: + Segment: + type: array + items: + $ref: '#/components/schemas/tt_Polyline' + description: Contains array of Polyline + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PolylineArrayExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayExtension: + title: tt_PolylineArrayExtension + type: object + description: '' + xml: + name: PolylineArrayExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayConfiguration: + title: tt_PolylineArrayConfiguration + required: + - PolylineArray + type: object + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/tt_PolylineArray' + - description: Contains PolylineArray configuration data + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArrayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpression: + title: tt_MotionExpression + required: + - Expression + type: object + properties: + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Expression: + type: string + description: Motion Expression data structure contains motion expression which is based on Scene Descriptor schema with XPATH syntax. The Type argument could allow introduction of different dialects + xml: + name: Expression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpressionConfiguration: + title: tt_MotionExpressionConfiguration + required: + - MotionExpression + type: object + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/tt_MotionExpression' + - description: Contains Rule MotionExpression configuration + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpressionConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CellLayout: + title: tt_CellLayout + required: + - Columns + - Rows + - Transformation + type: object + properties: + Columns: + type: integer + description: Number of columns of the cell grid (x dimension) + format: int32 + xml: + name: Columns + prefix: tt + attribute: true + wrapped: false + Rows: + type: integer + description: Number of rows of the cell grid (y dimension) + format: int32 + xml: + name: Rows + prefix: tt + attribute: true + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid is starting from the upper left corner and x dimension is going from left to right and the y dimension from up to down. + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CellLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneConfiguration: + title: tt_PaneConfiguration + required: + - Token + type: object + properties: + PaneName: + type: string + description: Optional name of the pane configuration. + xml: + name: PaneName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputToken: + maxLength: 64 + type: string + description: >- + If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client + + can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. + xml: + name: AudioOutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceToken: + maxLength: 64 + type: string + description: >- + If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. + + The 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 + + DeviceIO service. + xml: + name: AudioSourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: >- + The configuration of the audio encoder including codec, bitrate + + and sample rate. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + maxLength: 64 + type: string + description: >- + A pointer to a Receiver that has the necessary information to receive + data 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 + GetReceivers command of the Receiver Service. + xml: + name: ReceiverToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: A unique identifier in the display device. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration of the streaming and coding settings of a Video window. + xml: + name: PaneConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayout: + title: tt_PaneLayout + required: + - Pane + - Area + type: object + properties: + Pane: + maxLength: 64 + type: string + description: Reference to the configuration of the streaming and coding parameters. + xml: + name: Pane + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Area: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Describes the location and size of the area on the monitor. The area coordinate values are espressed in normalized units [-1.0, 1.0]. + xml: + name: Area + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen. + xml: + name: PaneLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Layout: + title: tt_Layout + required: + - PaneLayout + type: object + properties: + PaneLayout: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayout' + description: List of panes assembling the display layout. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A layout describes a set of Video windows that are displayed simultaniously on a display. + xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutExtension: + title: tt_LayoutExtension + type: object + description: '' + xml: + name: LayoutExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CodingCapabilities: + title: tt_CodingCapabilities + required: + - VideoDecodingCapabilities + type: object + properties: + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes the supported codecs and their configuration. + xml: + name: AudioEncodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes the supported codecs and their settings. + xml: + name: AudioDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their configuration. + xml: + name: VideoDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: This type contains the Audio and Video coding capabilities of a display service. + xml: + name: CodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptions: + title: tt_LayoutOptions + required: + - PaneLayoutOptions + type: object + properties: + PaneLayoutOptions: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayoutOptions' + description: Lists the possible Pane Layouts of the Video Output + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The options supported for a display layout. + xml: + name: LayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptionsExtension: + title: tt_LayoutOptionsExtension + type: object + description: '' + xml: + name: LayoutOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayoutOptions: + title: tt_PaneLayoutOptions + required: + - Area + type: object + properties: + Area: + type: array + items: + $ref: '#/components/schemas/tt_Rectangle' + description: List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PaneOptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a pane layout describing a complete display layout. + xml: + name: PaneLayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneOptionExtension: + title: tt_PaneOptionExtension + type: object + description: '' + xml: + name: PaneOptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Receiver: + title: tt_Receiver + required: + - Token + - Configuration + type: object + properties: + Token: + maxLength: 64 + type: string + description: Unique identifier of the receiver. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a receiver, including its token and configuration. + xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverConfiguration: + title: tt_ReceiverConfiguration + required: + - Mode + - MediaUri + - StreamSetup + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReceiverMode' + - description: 'The following connection modes are defined:' + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaUri: + type: string + description: Details of the URI to which the receiver should connect. + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream connection parameters. + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describes the configuration of a receiver. + xml: + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverMode: + title: tt_ReceiverMode + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + description: Specifies a receiver connection mode. + xml: + name: ReceiverMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverState: + title: tt_ReceiverState + enum: + - NotConnected + - Connecting + - Connected + - Unknown + type: string + description: Specifies the current connection state of the receiver. + xml: + name: ReceiverState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverStateInformation: + title: tt_ReceiverStateInformation + required: + - State + - AutoCreated + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_ReceiverState' + - description: 'The connection state of the receiver may have one of the following states:' + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreated: + type: boolean + description: Indicates whether or not the receiver was created automatically. + xml: + name: AutoCreated + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Contains information about a receiver's current state. + xml: + name: ReceiverStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceReference: + title: tt_SourceReference + required: + - Token + type: object + properties: + Type: + type: string + default: http://www.onvif.org/ver10/schema/Receiver + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTimeRange: + title: tt_DateTimeRange + required: + - From + - Until + type: object + properties: + From: + type: string + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSummary: + title: tt_RecordingSummary + required: + - DataFrom + - DataUntil + - NumberRecordings + type: object + properties: + DataFrom: + type: string + description: The earliest point in time where there is recorded data on the device. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataUntil: + type: string + description: The most recent point in time where there is recorded data on the device. + format: date-time + xml: + name: DataUntil + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NumberRecordings: + type: integer + description: The device contains this many recordings. + format: int32 + xml: + name: NumberRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingSummary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScope: + title: tt_SearchScope + type: object + properties: + IncludedSources: + type: array + items: + $ref: '#/components/schemas/tt_SourceReference' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IncludedRecordings: + type: array + items: + maxLength: 64 + type: string + xml: + name: IncludedRecordings + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformationFilter: + type: string + 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. + xml: + name: RecordingInformationFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SearchScopeExtension' + - description: Extension point + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A structure for defining a limited scope when searching in recorded data. + xml: + name: SearchScope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScopeExtension: + title: tt_SearchScopeExtension + type: object + description: '' + xml: + name: SearchScopeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventFilter: + title: tt_EventFilter + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + xml: + name: EventFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZPositionFilter: + title: tt_PTZPositionFilter + required: + - MinPosition + - MaxPosition + - EnterOrExit + type: object + properties: + MinPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + xml: + name: MinPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + xml: + name: MaxPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EnterOrExit: + type: boolean + description: If true, search for when entering the specified PTZ volume. + xml: + name: EnterOrExit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPositionFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataFilter: + title: tt_MetadataFilter + required: + - MetadataStreamFilter + type: object + properties: + MetadataStreamFilter: + type: string + xml: + name: MetadataStreamFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindRecordingResultList: + title: tt_FindRecordingResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformation: + type: array + items: + $ref: '#/components/schemas/tt_RecordingInformation' + description: A RecordingInformation structure for each found recording matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindRecordingResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResultList: + title: tt_FindEventResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindEventResult' + description: A FindEventResult structure for each found event matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResult: + title: tt_FindEventResult + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: The recording where this event was found. Empty string if no recording is associated with this event. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the track where this event was found. Empty string if no track is associated with this event. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the event occured. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + xml: + name: Event + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartStateEvent: + type: boolean + 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. + xml: + name: StartStateEvent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResultList: + title: tt_FindPTZPositionResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindPTZPositionResult' + description: A FindPTZPositionResult structure for each found PTZ position matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResult: + title: tt_FindPTZPositionResult + required: + - RecordingToken + - TrackToken + - Time + - Position + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the PTZ position. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the PTZ position. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the PTZ position was valid. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The PTZ position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResultList: + title: tt_FindMetadataResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindMetadataResult' + description: A FindMetadataResult structure for each found set of Metadata matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResult: + title: tt_FindMetadataResult + required: + - RecordingToken + - TrackToken + - Time + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the metadata. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the matching metadata. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The point in time when the matching metadata occurs in the metadata track. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchState: + title: tt_SearchState + enum: + - Queued + - Searching + - Completed + - Unknown + type: string + description: '' + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingInformation: + title: tt_RecordingInformation + required: + - RecordingToken + - Source + - Content + - RecordingStatus + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: >- + Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single + recording is intended to record related material, there is just one source. It is indicates the physical location or the + major data source for the recording. Currently the recordingconfiguration cannot describe each individual data source. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EarliestRecording: + type: string + format: date-time + xml: + name: EarliestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LatestRecording: + type: string + format: date-time + xml: + name: LatestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Track: + type: array + items: + $ref: '#/components/schemas/tt_TrackInformation' + description: Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingStatus: + allOf: + - $ref: '#/components/schemas/tt_RecordingStatus' + - xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSourceInformation: + title: tt_RecordingSourceInformation + required: + - SourceId + - Name + - Location + - Description + - Address + type: object + properties: + SourceId: + type: string + description: >- + Identifier for the source chosen by the client that creates the structure. + This identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters. + xml: + name: SourceId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + maxLength: 64 + type: string + description: Informative user readable name of the source, e.g. "Camera23". A device shall support at least 20 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Location: + type: string + description: Informative description of the physical location of the source, e.g. the coordinates on a map. + xml: + name: Location + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the source. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Address: + type: string + description: URI provided by the service supplying data to be recorded. A device shall support at least 128 characters. + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of informative desciptions of a data source. The Search searvice allows a client to filter on recordings based on information in this structure. + xml: + name: RecordingSourceInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingStatus: + title: tt_RecordingStatus + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + type: string + description: '' + xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackInformation: + title: tt_TrackInformation + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + type: object + properties: + TrackToken: + maxLength: 64 + type: string + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track: "Video", "Audio" or "Metadata". + The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the contents of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataFrom: + type: string + description: The start date and time of the oldest recorded data in the track. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataTo: + type: string + description: The stop date and time of the newest recorded data in the track. + format: date-time + xml: + name: DataTo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackType: + title: tt_TrackType + enum: + - Video + - Audio + - Metadata + - Extended + type: string + description: '' + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaAttributes: + title: tt_MediaAttributes + required: + - RecordingToken + - From + - Until + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording that has these attributes. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackAttributes: + type: array + items: + $ref: '#/components/schemas/tt_TrackAttributes' + description: A set of attributes for each track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + From: + type: string + description: The attributes are valid from this point in time in the recording. + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + 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. + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of media attributes valid for a recording at a point in time or for a time interval. + xml: + name: MediaAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributes: + title: tt_TrackAttributes + required: + - TrackInformation + type: object + properties: + TrackInformation: + allOf: + - $ref: '#/components/schemas/tt_TrackInformation' + - description: The basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAttributes: + allOf: + - $ref: '#/components/schemas/tt_VideoAttributes' + - description: If the track is a video track, exactly one of this structure shall be present and contain the video attributes. + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioAttributes: + allOf: + - $ref: '#/components/schemas/tt_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure shall be present and contain the audio attributes. + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/tt_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure shall be present and contain the metadata attributes. + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TrackAttributesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributesExtension: + title: tt_TrackAttributesExtension + type: object + description: '' + xml: + name: TrackAttributesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAttributes: + title: tt_VideoAttributes + required: + - Width + - Height + - Encoding + - Framerate + type: object + properties: + Bitrate: + type: integer + description: Average bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Width: + type: integer + description: The width of the video in pixels. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: The height of the video in pixels. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Video encoding of the track. Use value from tt:VideoEncoding for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Framerate: + type: number + description: Average framerate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAttributes: + title: tt_AudioAttributes + required: + - Encoding + - Samplerate + type: object + properties: + Bitrate: + type: integer + description: The bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Audio encoding of the track. Use values from tt:AudioEncoding for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Samplerate: + type: integer + description: The sample rate in kHz. + format: int32 + xml: + name: Samplerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataAttributes: + title: tt_MetadataAttributes + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + type: object + properties: + PtzSpaces: + type: 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. + xml: + name: PtzSpaces + prefix: tt + attribute: true + wrapped: false + CanContainPTZ: + type: boolean + description: Indicates that there can be PTZ data in the metadata track in the specified time interval. + xml: + name: CanContainPTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainAnalytics: + type: boolean + description: Indicates that there can be analytics data in the metadata track in the specified time interval. + xml: + name: CanContainAnalytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainNotifications: + type: boolean + description: Indicates that there can be notifications in the metadata track in the specified time interval. + xml: + name: CanContainNotifications + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingConfiguration: + title: tt_RecordingConfiguration + required: + - Source + - Content + - MaximumRetentionTime + type: object + properties: + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: Information about the source of the recording. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + description: Informative description of the source. + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRetentionTime: + type: string + description: >- + Sspecifies the maximum time that data in any track within the + recording shall be stored. The device shall delete any data older than the maximum retention + time. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0, + the device shall not limit the retention time of stored data, except by resource constraints. + Whatever the value of MaximumRetentionTime, the device may automatically delete + recordings to free up storage space for new recordings. + format: date-time + xml: + name: MaximumRetentionTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackConfiguration: + title: tt_TrackConfiguration + required: + - TrackType + - Description + type: object + properties: + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track. It shall be equal to the strings “Video”, + “Audio” or “Metadata”. The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingsResponseItem: + title: tt_GetRecordingsResponseItem + required: + - RecordingToken + - Configuration + - Tracks + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Token of the recording. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_RecordingConfiguration' + - description: Configuration of the recording. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_GetTracksResponseList' + - description: List of tracks. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseList: + title: tt_GetTracksResponseList + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_GetTracksResponseItem' + description: Configuration of a track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseItem: + title: tt_GetTracksResponseItem + required: + - TrackToken + - Configuration + type: object + properties: + TrackToken: + maxLength: 64 + type: string + description: Token of the track. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_TrackConfiguration' + - description: Configuration of the track. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfiguration: + title: tt_RecordingJobConfiguration + required: + - RecordingToken + - Mode + - Priority + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identifies the recording to which this job shall store the received data. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + type: string + description: >- + The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try + to obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: integer + description: >- + This shall be a non-negative number. If there are multiple recording jobs that store data to + the same track, the device will only store the data for the recording job with the highest + priority. The priority is specified per recording job, but the device shall determine the priority + of each track individually. If there are two recording jobs with the same priority, the device + shall record the data corresponding to the recording job that was activated the latest. + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobSource' + description: Source of the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfigurationExtension: + title: tt_RecordingJobConfigurationExtension + type: object + description: '' + xml: + name: RecordingJobConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSource: + title: tt_RecordingJobSource + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: >- + This field shall be a reference to the source of the data. The type of the source + is determined by the attribute Type in the SourceToken structure. If Type is + http://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case + the device shall receive the data over the network. If Type is + http://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, instructing the + device to obtain data from a profile that exists on the local device. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreateReceiver: + type: boolean + description: >- + If this field is TRUE, and if the SourceToken is omitted, the device + shall create a receiver object (through the receiver service) and assign the + ReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration + from the device, the AutoCreateReceiver field shall never be present. + xml: + name: AutoCreateReceiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobTrack' + description: List of tracks associated with the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSourceExtension: + title: tt_RecordingJobSourceExtension + type: object + description: '' + xml: + name: RecordingJobSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobTrack: + title: tt_RecordingJobTrack + required: + - SourceTag + - Destination + type: object + properties: + SourceTag: + type: string + description: >- + If the received RTSP stream contains multiple tracks of the same type, the + SourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: >- + The destination is the tracktoken of the track to which the device shall store the + received data. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformation: + title: tt_RecordingJobStateInformation + required: + - RecordingToken + - State + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identification of the recording that the recording job records to. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over the whole RecordingJobInformation structure. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sources: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateSource' + description: Identifies the data source of the recording job. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformationExtension: + title: tt_RecordingJobStateInformationExtension + type: object + description: '' + xml: + name: RecordingJobStateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateSource: + title: tt_RecordingJobStateSource + required: + - SourceToken + - State + - Tracks + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: Identifies the data source of the recording job. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateTracks' + - description: List of track items. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTracks: + title: tt_RecordingJobStateTracks + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateTrack' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTrack: + title: tt_RecordingJobStateTrack + required: + - SourceTag + - Destination + - State + type: object + properties: + SourceTag: + type: string + description: Identifies the track of the data source that provides the data. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: Indicates the destination track. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: >- + Optionally holds an implementation defined string value that describes the error. + The string should be in the English language. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: >- + Provides the job state of the track. The valid + values of state shall be “Idle”, “Active” and “Error”. If state equals “Error”, the Error field may be filled in with an implementation defined value. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingJobsResponseItem: + title: tt_GetRecordingJobsResponseItem + required: + - JobToken + - JobConfiguration + type: object + properties: + JobToken: + maxLength: 64 + type: string + xml: + name: JobToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JobConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfiguration' + - xml: + name: JobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingJobsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayConfiguration: + title: tt_ReplayConfiguration + required: + - SessionTimeout + type: object + properties: + SessionTimeout: + type: string + description: The RTSP session timeout. + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration parameters for the replay service. + xml: + name: ReplayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngine: + title: tt_AnalyticsEngine + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngine + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AnalyticsDeviceEngineConfiguration: + title: tt_AnalyticsDeviceEngineConfiguration + required: + - EngineConfiguration + type: object + properties: + EngineConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_EngineConfiguration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceEngineConfigurationExtension: + title: tt_AnalyticsDeviceEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsDeviceEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EngineConfiguration: + title: tt_EngineConfiguration + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + type: object + properties: + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineInputInfo: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfo' + - xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfo: + title: tt_AnalyticsEngineInputInfo + type: object + properties: + InputInfo: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: InputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfoExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfoExtension: + title: tt_AnalyticsEngineInputInfoExtension + type: object + description: '' + xml: + name: AnalyticsEngineInputInfoExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInput: + title: tt_AnalyticsEngineInput + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + properties: + SourceIdentification: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentification' + - xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoInput: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - xml: + name: VideoInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataInput: + allOf: + - $ref: '#/components/schemas/tt_MetadataInput' + - xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_SourceIdentification: + title: tt_SourceIdentification + required: + - Name + - Token + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + type: array + items: + maxLength: 64 + type: string + xml: + name: Token + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentificationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceIdentificationExtension: + title: tt_SourceIdentificationExtension + type: object + description: '' + xml: + name: SourceIdentificationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInput: + title: tt_MetadataInput + type: object + properties: + MetadataConfig: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataInputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInputExtension: + title: tt_MetadataInputExtension + type: object + description: '' + xml: + name: MetadataInputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineControl: + title: tt_AnalyticsEngineControl + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + properties: + EngineToken: + maxLength: 64 + type: string + description: Token of the analytics engine (AnalyticsEngine) being controlled. + xml: + name: EngineToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EngineConfigToken: + maxLength: 64 + type: string + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect. + xml: + name: EngineConfigToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InputToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputToken + attribute: false + wrapped: false + description: Tokens of the input (AnalyticsEngineInput) configuration applied. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: ReceiverToken + attribute: false + wrapped: false + description: Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subscription: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: Subscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ModeOfOperation' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_ModeOfOperation: + title: tt_ModeOfOperation + enum: + - Idle + - Active + - Unknown + type: string + description: '' + xml: + name: ModeOfOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsStateInformation: + title: tt_AnalyticsStateInformation + required: + - AnalyticsEngineControlToken + - State + type: object + properties: + AnalyticsEngineControlToken: + maxLength: 64 + type: string + description: Token of the control object whose status is requested. + xml: + name: AnalyticsEngineControlToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsState' + - xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsState: + title: tt_AnalyticsState + required: + - State + type: object + properties: + Error: + type: string + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayload: + title: tt_ActionEngineEventPayload + type: object + properties: + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + xml: + name: RequestInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + xml: + name: ResponseInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + xml: + name: Fault + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ActionEngineEventPayloadExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Action Engine Event Payload data structure contains the information about the ONVIF command invocations. Since this event could be generated by other or proprietary actions, the command invocation specific fields are defined as optional and additional extension mechanism is provided for future or additional action definitions. + xml: + name: ActionEngineEventPayload + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayloadExtension: + title: tt_ActionEngineEventPayloadExtension + type: object + description: '' + xml: + name: ActionEngineEventPayloadExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassType: + title: tt_AudioClassType + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + type: string + description: >- + AudioClassType acceptable values are; + gun_shot, scream, glass_breaking, tire_screech + xml: + name: AudioClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassCandidate: + title: tt_AudioClassCandidate + required: + - Type + - Likelihood + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_AudioClassType' + - description: Indicates audio class label + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + description: A likelihood/probability that the corresponding audio event belongs to this class. The sum of the likelihoods shall NOT exceed 1 + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptor: + title: tt_AudioClassDescriptor + type: object + properties: + ClassCandidate: + type: array + items: + $ref: '#/components/schemas/tt_AudioClassCandidate' + description: Array of audio class label and class probability + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioClassDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptorExtension: + title: tt_AudioClassDescriptorExtension + type: object + description: '' + xml: + name: AudioClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActiveConnection: + title: tt_ActiveConnection + required: + - CurrentBitrate + - CurrentFps + type: object + properties: + CurrentBitrate: + type: number + xml: + name: CurrentBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentFps: + type: number + xml: + name: CurrentFps + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ActiveConnection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatus: + title: tt_ProfileStatus + type: object + properties: + ActiveConnections: + type: array + items: + $ref: '#/components/schemas/tt_ActiveConnection' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatusExtension: + title: tt_ProfileStatusExtension + type: object + description: '' + xml: + name: ProfileStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDReference: + title: tt_OSDReference + type: object + description: '' + xml: + name: OSDReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDType: + title: tt_OSDType + enum: + - Text + - Image + - Extended + type: string + description: '' + xml: + name: OSDType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfiguration: + title: tt_OSDPosConfiguration + required: + - Type + type: object + properties: + Type: + type: string + description: 'For OSD position type, following are the pre-defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Pos: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Pos + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDPosConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfigurationExtension: + title: tt_OSDPosConfigurationExtension + type: object + description: '' + xml: + name: OSDPosConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColor: + title: tt_OSDColor + required: + - Color + type: object + properties: + Transparent: + type: integer + format: int32 + xml: + name: Transparent + prefix: tt + attribute: true + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: 'The value range of "Transparent" could be defined by vendors only should follow this rule: the minimum value means non-transparent and the maximum value maens fully transparent.' + xml: + name: OSDColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfiguration: + title: tt_OSDTextConfiguration + required: + - Type + type: object + properties: + IsPersistentText: + type: 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. + xml: + name: IsPersistentText + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: 'The following OSD Text Type are defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: string + 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:' + xml: + name: DateFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: string + 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:' + xml: + name: TimeFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSize: + type: integer + description: Font size of the text in pt. + format: int32 + xml: + name: FontSize + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Font color of the text. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Background color of the text. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PlainText: + type: string + description: The content of text to be displayed. + xml: + name: PlainText + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfigurationExtension: + title: tt_OSDTextConfigurationExtension + type: object + description: '' + xml: + name: OSDTextConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfiguration: + title: tt_OSDImgConfiguration + required: + - ImgPath + type: object + properties: + ImgPath: + type: string + description: The URI of the image which to be displayed. + xml: + name: ImgPath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfigurationExtension: + title: tt_OSDImgConfigurationExtension + type: object + description: '' + xml: + name: OSDImgConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorspaceRange: + title: tt_ColorspaceRange + required: + - X + - Y + - Z + - Colorspace + type: object + properties: + X: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Y: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Y + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Z: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Z + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorspaceRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptions: + title: tt_ColorOptions + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the colors supported. Either list each color or define the range of color values. + xml: + name: ColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptions: + title: tt_OSDColorOptions + type: object + properties: + Color: + oneOf: + - $ref: '#/components/schemas/tt_ColorOptionsChoice0' + - $ref: '#/components/schemas/tt_ColorOptionsChoice1' + description: Optional list of supported colors. + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transparent: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + xml: + name: Transparent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the option of the color and its transparency. + xml: + name: OSDColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptionsExtension: + title: tt_OSDColorOptionsExtension + type: object + description: '' + xml: + name: OSDColorOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptions: + title: tt_OSDTextOptions + required: + - Type + type: object + properties: + Type: + type: array + items: + type: string + xml: + name: Type + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSizeRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the font size value. + xml: + name: FontSizeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: array + items: + type: string + xml: + name: DateFormat + attribute: false + wrapped: false + description: List of supported date format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: array + items: + type: string + xml: + name: TimeFormat + attribute: false + wrapped: false + description: List of supported time format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported font color. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported background color. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptionsExtension: + title: tt_OSDTextOptionsExtension + type: object + description: '' + xml: + name: OSDTextOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptions: + title: tt_OSDImgOptions + required: + - ImagePath + type: object + properties: + FormatsSupported: + type: string + description: List of supported image MIME types, such as "image/png". + xml: + name: FormatsSupported + prefix: tt + attribute: true + wrapped: false + MaxSize: + type: integer + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + xml: + name: MaxSize + prefix: tt + attribute: true + wrapped: false + MaxWidth: + type: integer + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxWidth + prefix: tt + attribute: true + wrapped: false + MaxHeight: + type: integer + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxHeight + prefix: tt + attribute: true + wrapped: false + ImagePath: + type: array + items: + type: string + xml: + name: ImagePath + attribute: false + wrapped: false + description: List of available image URIs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptionsExtension: + title: tt_OSDImgOptionsExtension + type: object + description: '' + xml: + name: OSDImgOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfiguration: + title: tt_OSDConfiguration + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + properties: + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/tt_OSDReference' + - description: Reference to the video source configuration. + xml: + name: VideoSourceConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_OSDType' + - description: Type of OSD. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfiguration' + - description: Position configuration of OSD. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextString: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the value of Type field is Text. + xml: + name: TextString + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Image: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the value of Type field is Image + xml: + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: OSDConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_OSDConfigurationExtension: + title: tt_OSDConfigurationExtension + type: object + description: '' + xml: + name: OSDConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MaximumNumberOfOSDs: + title: tt_MaximumNumberOfOSDs + required: + - Total + type: object + properties: + Total: + type: integer + format: int32 + xml: + name: Total + prefix: tt + attribute: true + wrapped: false + Image: + type: integer + format: int32 + xml: + name: Image + prefix: tt + attribute: true + wrapped: false + PlainText: + type: integer + format: int32 + xml: + name: PlainText + prefix: tt + attribute: true + wrapped: false + Date: + type: integer + format: int32 + xml: + name: Date + prefix: tt + attribute: true + wrapped: false + Time: + type: integer + format: int32 + xml: + name: Time + prefix: tt + attribute: true + wrapped: false + DateAndTime: + type: integer + format: int32 + xml: + name: DateAndTime + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptions: + title: tt_OSDConfigurationOptions + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + type: object + properties: + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/tt_MaximumNumberOfOSDs' + - 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. + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + type: array + items: + $ref: '#/components/schemas/tt_OSDType' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PositionOption: + type: array + items: + type: string + xml: + name: PositionOption + attribute: false + wrapped: false + description: 'List available OSD position type. Following are the pre-defined:' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextOption: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text. + xml: + name: TextOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ImageOption: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image. + xml: + name: ImageOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptionsExtension: + title: tt_OSDConfigurationOptionsExtension + type: object + description: '' + xml: + name: OSDConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FileProgress: + title: tt_FileProgress + required: + - FileName + - Progress + type: object + properties: + FileName: + type: string + description: Exported file name + xml: + name: FileName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Progress: + type: number + description: Normalized percentage completion for uploading the exported file + xml: + name: Progress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgress: + title: tt_ArrayOfFileProgress + type: object + properties: + FileProgress: + type: array + items: + $ref: '#/components/schemas/tt_FileProgress' + description: Exported file name and export progress information + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ArrayOfFileProgressExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ArrayOfFileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgressExtension: + title: tt_ArrayOfFileProgressExtension + type: object + description: '' + xml: + name: ArrayOfFileProgressExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePath: + title: tt_StorageReferencePath + required: + - StorageToken + type: object + properties: + StorageToken: + maxLength: 64 + type: string + description: identifier of an existing Storage Configuration. + xml: + name: StorageToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePath: + type: string + description: gives the relative directory path on the storage + xml: + name: RelativePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_StorageReferencePathExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StorageReferencePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePathExtension: + title: tt_StorageReferencePathExtension + type: object + description: '' + xml: + name: StorageReferencePathExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolygonOptions: + title: tt_PolygonOptions + type: object + properties: + RectangleOnly: + type: boolean + description: >- + True if the device supports defining a region only using Rectangle. + + The rectangle points are still passed using a Polygon element if the device does not support polygon regions. In this case, the points provided in the Polygon element shall represent a rectangle. + xml: + name: RectangleOnly + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VertexLimits: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: >- + Provides the minimum and maximum number of points that can be defined in the Polygon. + + If RectangleOnly is not set to true, this parameter is required. + xml: + name: VertexLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolygonOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xmime_base64Binary: + title: xmime_base64Binary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: base64Binary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + xmime_hexBinary: + title: xmime_hexBinary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: hexBinary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + soapenv_Envelope: + title: soapenv_Envelope + required: + - Body + type: object + properties: + Header: + allOf: + - $ref: '#/components/schemas/soapenv_Header' + - xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Body: + allOf: + - $ref: '#/components/schemas/soapenv_Body' + - xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: Envelope + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Header: + title: soapenv_Header + type: object + description: Elements replacing the wildcard MUST be namespace qualified, but can be in the targetNamespace + xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Body: + title: soapenv_Body + type: object + description: '' + xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Fault: + title: soapenv_Fault + required: + - Code + - Reason + type: object + properties: + Code: + allOf: + - $ref: '#/components/schemas/soapenv_faultcode' + - xml: + name: Code + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Reason: + allOf: + - $ref: '#/components/schemas/soapenv_faultreason' + - xml: + name: Reason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Node: + type: string + xml: + name: Node + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Role: + type: string + xml: + name: Role + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Detail: + allOf: + - $ref: '#/components/schemas/soapenv_detail' + - xml: + name: Detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: Fault reporting structure + xml: + name: Fault + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultreason: + title: soapenv_faultreason + required: + - Text + type: object + properties: + Text: + type: array + items: + $ref: '#/components/schemas/soapenv_reasontext' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultreason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_reasontext: + title: soapenv_reasontext + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: reasontext + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcode: + title: soapenv_faultcode + required: + - Value + type: object + properties: + Value: + allOf: + - $ref: '#/components/schemas/soapenv_faultcodeEnum' + - xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcodeEnum: + title: soapenv_faultcodeEnum + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + type: string + description: '' + xml: + name: faultcodeEnum + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_subcode: + title: soapenv_subcode + required: + - Value + type: object + properties: + Value: + type: string + xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_detail: + title: soapenv_detail + type: object + description: '' + xml: + name: detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_NotUnderstoodType: + title: soapenv_NotUnderstoodType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: NotUnderstoodType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_SupportedEnvType: + title: soapenv_SupportedEnvType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: SupportedEnvType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_UpgradeType: + title: soapenv_UpgradeType + required: + - SupportedEnvelope + type: object + properties: + SupportedEnvelope: + type: array + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: UpgradeType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + wsnt_QueryExpressionType: + title: wsnt_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_TopicExpressionType: + title: wsnt_TopicExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_FilterType: + title: wsnt_FilterType + type: object + description: '' + xml: + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicyType: + title: wsnt_SubscriptionPolicyType + type: object + description: '' + xml: + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationProducerRP: + title: wsnt_NotificationProducerRP + type: object + properties: + TopicExpression: + type: array + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + default: true + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsa_EndpointReferenceType: + title: wsa_EndpointReferenceType + required: + - Address + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsnt_SubscriptionManagerRP: + title: wsnt_SubscriptionManagerRP + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CreationTime: + type: string + format: date-time + xml: + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationMessageHolderType: + title: wsnt_NotificationMessageHolderType + required: + - Message + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Notify: + title: wsnt_Notify + required: + - NotificationMessage + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UseRaw: + title: wsnt_UseRaw + type: object + description: '' + xml: + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Subscribe: + title: wsnt_Subscribe + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeResponse: + title: wsnt_SubscribeResponse + required: + - SubscriptionReference + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessage: + title: wsnt_GetCurrentMessage + required: + - Topic + type: object + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessageResponse: + title: wsnt_GetCurrentMessageResponse + type: object + description: '' + xml: + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + title: wsnt_SubscribeCreationFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidFilterFaultType: + title: wsnt_InvalidFilterFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - UnknownFilter + type: object + properties: + UnknownFilter: + type: array + items: + type: string + xml: + name: UnknownFilter + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicExpressionDialectUnknownFaultType: + title: wsnt_TopicExpressionDialectUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidTopicExpressionFaultType: + title: wsnt_InvalidTopicExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicNotSupportedFaultType: + title: wsnt_TopicNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_MultipleTopicsSpecifiedFaultType: + title: wsnt_MultipleTopicsSpecifiedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidProducerPropertiesExpressionFaultType: + title: wsnt_InvalidProducerPropertiesExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidMessageContentExpressionFaultType: + title: wsnt_InvalidMessageContentExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnrecognizedPolicyRequestFaultType: + title: wsnt_UnrecognizedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnrecognizedPolicy: + type: array + items: + type: string + xml: + name: UnrecognizedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnsupportedPolicyRequestFaultType: + title: wsnt_UnsupportedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnsupportedPolicy: + type: array + items: + type: string + xml: + name: UnsupportedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NotifyMessageNotSupportedFaultType: + title: wsnt_NotifyMessageNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnacceptableInitialTerminationTimeFaultType: + title: wsnt_UnacceptableInitialTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NoCurrentMessageOnTopicFaultType: + title: wsnt_NoCurrentMessageOnTopicFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_GetMessages: + title: wsnt_GetMessages + type: object + properties: + MaximumNumber: + type: integer + format: int32 + xml: + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetMessagesResponse: + title: wsnt_GetMessagesResponse + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPoint: + title: wsnt_DestroyPullPoint + type: object + description: '' + xml: + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPointResponse: + title: wsnt_DestroyPullPointResponse + type: object + description: '' + xml: + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToGetMessagesFaultType: + title: wsnt_UnableToGetMessagesFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnableToDestroyPullPointFaultType: + title: wsnt_UnableToDestroyPullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_CreatePullPoint: + title: wsnt_CreatePullPoint + type: object + description: '' + xml: + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_CreatePullPointResponse: + title: wsnt_CreatePullPointResponse + required: + - PullPoint + type: object + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToCreatePullPointFaultType: + title: wsnt_UnableToCreatePullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Renew: + title: wsnt_Renew + required: + - TerminationTime + type: object + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_RenewResponse: + title: wsnt_RenewResponse + required: + - TerminationTime + type: object + properties: + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnacceptableTerminationTimeFaultType: + title: wsnt_UnacceptableTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Unsubscribe: + title: wsnt_Unsubscribe + type: object + description: '' + xml: + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnsubscribeResponse: + title: wsnt_UnsubscribeResponse + type: object + description: '' + xml: + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToDestroySubscriptionFaultType: + title: wsnt_UnableToDestroySubscriptionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_PauseSubscription: + title: wsnt_PauseSubscription + type: object + description: '' + xml: + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseSubscriptionResponse: + title: wsnt_PauseSubscriptionResponse + type: object + description: '' + xml: + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscription: + title: wsnt_ResumeSubscription + type: object + description: '' + xml: + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscriptionResponse: + title: wsnt_ResumeSubscriptionResponse + type: object + description: '' + xml: + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseFailedFaultType: + title: wsnt_PauseFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_ResumeFailedFaultType: + title: wsnt_ResumeFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xop_Include: + title: xop_Include + required: + - href + type: object + properties: + href: + type: string + xml: + name: href + prefix: xop + attribute: true + wrapped: false + description: '' + xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + wsa_ReferenceParametersType: + title: wsa_ReferenceParametersType + type: object + description: '' + xml: + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_MetadataType: + title: wsa_MetadataType + type: object + description: '' + xml: + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedURIType: + title: wsa_AttributedURIType + type: object + description: '' + xml: + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelatesToType: + title: wsa_RelatesToType + type: object + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + name: RelationshipType + attribute: true + wrapped: false + description: '' + xml: + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelationshipTypeOpenEnum: + title: wsa_RelationshipTypeOpenEnum + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + description: '' + xml: + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_FaultCodesOpenEnumType: + title: wsa_FaultCodesOpenEnumType + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + description: '' + xml: + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedQNameType: + title: wsa_AttributedQNameType + type: object + description: '' + xml: + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedAnyType: + title: wsa_AttributedAnyType + type: object + description: '' + xml: + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ProblemActionType: + title: wsa_ProblemActionType + type: object + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + SoapAction: + type: string + xml: + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsrf-bf_BaseFaultType: + title: wsrf-bf_BaseFaultType + required: + - Timestamp + type: object + properties: + Timestamp: + type: string + format: date-time + xml: + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Description: + type: array + items: + $ref: '#/components/schemas/wsrf-bf_Description' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + description: '' + xml: + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Documentation: + title: wstop_Documentation + type: object + description: '' + xml: + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_ExtensibleDocumented: + title: wstop_ExtensibleDocumented + type: object + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_QueryExpressionType: + title: wstop_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_TopicNamespaceType: + title: wstop_TopicNamespaceType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - targetNamespace + type: object + properties: + Topic: + type: array + items: + $ref: '#/components/schemas/wstop_Topic' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + name: + type: string + xml: + name: name + attribute: true + wrapped: false + targetNamespace: + type: string + xml: + name: targetNamespace + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + name: final + attribute: true + wrapped: false + xml: + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicType: + title: wstop_TopicType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - name + type: object + properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - {} + name: + type: string + xml: + attribute: true + wrapped: false + messageTypes: + type: array + items: + type: string + description: '' + xml: + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + attribute: true + wrapped: false + xml: + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicSetType: + title: wstop_TopicSetType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + AddAudioDecoderConfigurationRequest: + title: AddAudioDecoderConfigurationRequest + required: + - AddAudioDecoderConfiguration + type: object + properties: + AddAudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddAudioDecoderConfiguration' + - {} + AddAudioDecoderConfigurationResponse: + title: AddAudioDecoderConfigurationResponse + required: + - AddAudioDecoderConfigurationResponse + type: object + properties: + AddAudioDecoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddAudioDecoderConfigurationResponse' + - xml: + name: AddAudioDecoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddAudioDecoderConfigurationResponse + attribute: false + wrapped: false + AddAudioEncoderConfigurationRequest: + title: AddAudioEncoderConfigurationRequest + required: + - AddAudioEncoderConfiguration + type: object + properties: + AddAudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddAudioEncoderConfiguration' + - {} + AddAudioEncoderConfigurationResponse: + title: AddAudioEncoderConfigurationResponse + required: + - AddAudioEncoderConfigurationResponse + type: object + properties: + AddAudioEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddAudioEncoderConfigurationResponse' + - xml: + name: AddAudioEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddAudioEncoderConfigurationResponse + attribute: false + wrapped: false + AddAudioOutputConfigurationRequest: + title: AddAudioOutputConfigurationRequest + required: + - AddAudioOutputConfiguration + type: object + properties: + AddAudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddAudioOutputConfiguration' + - {} + AddAudioOutputConfigurationResponse: + title: AddAudioOutputConfigurationResponse + required: + - AddAudioOutputConfigurationResponse + type: object + properties: + AddAudioOutputConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddAudioOutputConfigurationResponse' + - xml: + name: AddAudioOutputConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddAudioOutputConfigurationResponse + attribute: false + wrapped: false + AddAudioSourceConfigurationRequest: + title: AddAudioSourceConfigurationRequest + required: + - AddAudioSourceConfiguration + type: object + properties: + AddAudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddAudioSourceConfiguration' + - {} + AddAudioSourceConfigurationResponse: + title: AddAudioSourceConfigurationResponse + required: + - AddAudioSourceConfigurationResponse + type: object + properties: + AddAudioSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddAudioSourceConfigurationResponse' + - xml: + name: AddAudioSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddAudioSourceConfigurationResponse + attribute: false + wrapped: false + AddMetadataConfigurationRequest: + title: AddMetadataConfigurationRequest + required: + - AddMetadataConfiguration + type: object + properties: + AddMetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddMetadataConfiguration' + - {} + AddMetadataConfigurationResponse: + title: AddMetadataConfigurationResponse + required: + - AddMetadataConfigurationResponse + type: object + properties: + AddMetadataConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddMetadataConfigurationResponse' + - xml: + name: AddMetadataConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddMetadataConfigurationResponse + attribute: false + wrapped: false + AddPTZConfigurationRequest: + title: AddPTZConfigurationRequest + required: + - AddPTZConfiguration + type: object + properties: + AddPTZConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddPTZConfiguration' + - {} + AddPTZConfigurationResponse: + title: AddPTZConfigurationResponse + required: + - AddPTZConfigurationResponse + type: object + properties: + AddPTZConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddPTZConfigurationResponse' + - xml: + name: AddPTZConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddPTZConfigurationResponse + attribute: false + wrapped: false + AddVideoAnalyticsConfigurationRequest: + title: AddVideoAnalyticsConfigurationRequest + required: + - AddVideoAnalyticsConfiguration + type: object + properties: + AddVideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddVideoAnalyticsConfiguration' + - {} + AddVideoAnalyticsConfigurationResponse: + title: AddVideoAnalyticsConfigurationResponse + required: + - AddVideoAnalyticsConfigurationResponse + type: object + properties: + AddVideoAnalyticsConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddVideoAnalyticsConfigurationResponse' + - xml: + name: AddVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + AddVideoEncoderConfigurationRequest: + title: AddVideoEncoderConfigurationRequest + required: + - AddVideoEncoderConfiguration + type: object + properties: + AddVideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddVideoEncoderConfiguration' + - {} + AddVideoEncoderConfigurationResponse: + title: AddVideoEncoderConfigurationResponse + required: + - AddVideoEncoderConfigurationResponse + type: object + properties: + AddVideoEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddVideoEncoderConfigurationResponse' + - xml: + name: AddVideoEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddVideoEncoderConfigurationResponse + attribute: false + wrapped: false + AddVideoSourceConfigurationRequest: + title: AddVideoSourceConfigurationRequest + required: + - AddVideoSourceConfiguration + type: object + properties: + AddVideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddVideoSourceConfiguration' + - {} + AddVideoSourceConfigurationResponse: + title: AddVideoSourceConfigurationResponse + required: + - AddVideoSourceConfigurationResponse + type: object + properties: + AddVideoSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddVideoSourceConfigurationResponse' + - xml: + name: AddVideoSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddVideoSourceConfigurationResponse + attribute: false + wrapped: false + Choice0: + title: Choice0 + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice1: + title: Choice1 + type: object + properties: + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice2: + title: Choice2 + type: object + properties: + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice3: + title: Choice3 + type: object + properties: + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CreateOSDRequest: + title: CreateOSDRequest + required: + - CreateOSD + type: object + properties: + CreateOSD: + allOf: + - $ref: '#/components/schemas/tns_CreateOSD' + - {} + CreateOSDResponse: + title: CreateOSDResponse + required: + - CreateOSDResponse + type: object + properties: + CreateOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateOSDResponse' + - xml: + name: CreateOSDResponse + attribute: false + wrapped: false + xml: + name: CreateOSDResponse + attribute: false + wrapped: false + CreateProfileRequest: + title: CreateProfileRequest + required: + - CreateProfile + type: object + properties: + CreateProfile: + allOf: + - $ref: '#/components/schemas/tns_CreateProfile' + - {} + CreateProfileResponse: + title: CreateProfileResponse + required: + - CreateProfileResponse + type: object + properties: + CreateProfileResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateProfileResponse' + - xml: + name: CreateProfileResponse + attribute: false + wrapped: false + xml: + name: CreateProfileResponse + attribute: false + wrapped: false + DeleteOSDRequest: + title: DeleteOSDRequest + required: + - DeleteOSD + type: object + properties: + DeleteOSD: + allOf: + - $ref: '#/components/schemas/tns_DeleteOSD' + - {} + DeleteOSDResponse: + title: DeleteOSDResponse + required: + - DeleteOSDResponse + type: object + properties: + DeleteOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteOSDResponse' + - xml: + name: DeleteOSDResponse + attribute: false + wrapped: false + xml: + name: DeleteOSDResponse + attribute: false + wrapped: false + DeleteProfileRequest: + title: DeleteProfileRequest + required: + - DeleteProfile + type: object + properties: + DeleteProfile: + allOf: + - $ref: '#/components/schemas/tns_DeleteProfile' + - {} + DeleteProfileResponse: + title: DeleteProfileResponse + required: + - DeleteProfileResponse + type: object + properties: + DeleteProfileResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteProfileResponse' + - xml: + name: DeleteProfileResponse + attribute: false + wrapped: false + xml: + name: DeleteProfileResponse + attribute: false + wrapped: false + GetAudioDecoderConfigurationOptionsRequest: + title: GetAudioDecoderConfigurationOptionsRequest + required: + - GetAudioDecoderConfigurationOptions + type: object + properties: + GetAudioDecoderConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurationOptions' + - {} + GetAudioDecoderConfigurationOptionsResponse: + title: GetAudioDecoderConfigurationOptionsResponse + required: + - GetAudioDecoderConfigurationOptionsResponse + type: object + properties: + GetAudioDecoderConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurationOptionsResponse' + - xml: + name: GetAudioDecoderConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioDecoderConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioDecoderConfigurationRequest: + title: GetAudioDecoderConfigurationRequest + required: + - GetAudioDecoderConfiguration + type: object + properties: + GetAudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfiguration' + - {} + GetAudioDecoderConfigurationResponse: + title: GetAudioDecoderConfigurationResponse + required: + - GetAudioDecoderConfigurationResponse + type: object + properties: + GetAudioDecoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurationResponse' + - xml: + name: GetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + GetAudioDecoderConfigurationsRequest: + title: GetAudioDecoderConfigurationsRequest + required: + - GetAudioDecoderConfigurations + type: object + properties: + GetAudioDecoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurations' + - {} + GetAudioDecoderConfigurationsResponse: + title: GetAudioDecoderConfigurationsResponse + required: + - GetAudioDecoderConfigurationsResponse + type: object + properties: + GetAudioDecoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurationsResponse' + - xml: + name: GetAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + GetAudioEncoderConfigurationOptionsRequest: + title: GetAudioEncoderConfigurationOptionsRequest + required: + - GetAudioEncoderConfigurationOptions + type: object + properties: + GetAudioEncoderConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurationOptions' + - {} + GetAudioEncoderConfigurationOptionsResponse: + title: GetAudioEncoderConfigurationOptionsResponse + required: + - GetAudioEncoderConfigurationOptionsResponse + type: object + properties: + GetAudioEncoderConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurationOptionsResponse' + - xml: + name: GetAudioEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioEncoderConfigurationRequest: + title: GetAudioEncoderConfigurationRequest + required: + - GetAudioEncoderConfiguration + type: object + properties: + GetAudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfiguration' + - {} + GetAudioEncoderConfigurationResponse: + title: GetAudioEncoderConfigurationResponse + required: + - GetAudioEncoderConfigurationResponse + type: object + properties: + GetAudioEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurationResponse' + - xml: + name: GetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + GetAudioEncoderConfigurationsRequest: + title: GetAudioEncoderConfigurationsRequest + required: + - GetAudioEncoderConfigurations + type: object + properties: + GetAudioEncoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurations' + - {} + GetAudioEncoderConfigurationsResponse: + title: GetAudioEncoderConfigurationsResponse + required: + - GetAudioEncoderConfigurationsResponse + type: object + properties: + GetAudioEncoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurationsResponse' + - xml: + name: GetAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + GetAudioOutputConfigurationOptionsRequest: + title: GetAudioOutputConfigurationOptionsRequest + required: + - GetAudioOutputConfigurationOptions + type: object + properties: + GetAudioOutputConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurationOptions' + - {} + GetAudioOutputConfigurationOptionsResponse: + title: GetAudioOutputConfigurationOptionsResponse + required: + - GetAudioOutputConfigurationOptionsResponse + type: object + properties: + GetAudioOutputConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurationOptionsResponse' + - xml: + name: GetAudioOutputConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioOutputConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioOutputConfigurationRequest: + title: GetAudioOutputConfigurationRequest + required: + - GetAudioOutputConfiguration + type: object + properties: + GetAudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfiguration' + - {} + GetAudioOutputConfigurationResponse: + title: GetAudioOutputConfigurationResponse + required: + - GetAudioOutputConfigurationResponse + type: object + properties: + GetAudioOutputConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurationResponse' + - xml: + name: GetAudioOutputConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetAudioOutputConfigurationResponse + attribute: false + wrapped: false + GetAudioOutputConfigurationsRequest: + title: GetAudioOutputConfigurationsRequest + required: + - GetAudioOutputConfigurations + type: object + properties: + GetAudioOutputConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurations' + - {} + GetAudioOutputConfigurationsResponse: + title: GetAudioOutputConfigurationsResponse + required: + - GetAudioOutputConfigurationsResponse + type: object + properties: + GetAudioOutputConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurationsResponse' + - xml: + name: GetAudioOutputConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioOutputConfigurationsResponse + attribute: false + wrapped: false + GetAudioOutputsRequest: + title: GetAudioOutputsRequest + required: + - GetAudioOutputs + type: object + properties: + GetAudioOutputs: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputs' + - {} + GetAudioOutputsResponse: + title: GetAudioOutputsResponse + required: + - GetAudioOutputsResponse + type: object + properties: + GetAudioOutputsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputsResponse' + - xml: + name: GetAudioOutputsResponse + attribute: false + wrapped: false + xml: + name: GetAudioOutputsResponse + attribute: false + wrapped: false + GetAudioSourceConfigurationOptionsRequest: + title: GetAudioSourceConfigurationOptionsRequest + required: + - GetAudioSourceConfigurationOptions + type: object + properties: + GetAudioSourceConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurationOptions' + - {} + GetAudioSourceConfigurationOptionsResponse: + title: GetAudioSourceConfigurationOptionsResponse + required: + - GetAudioSourceConfigurationOptionsResponse + type: object + properties: + GetAudioSourceConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurationOptionsResponse' + - xml: + name: GetAudioSourceConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioSourceConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioSourceConfigurationRequest: + title: GetAudioSourceConfigurationRequest + required: + - GetAudioSourceConfiguration + type: object + properties: + GetAudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfiguration' + - {} + GetAudioSourceConfigurationResponse: + title: GetAudioSourceConfigurationResponse + required: + - GetAudioSourceConfigurationResponse + type: object + properties: + GetAudioSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurationResponse' + - xml: + name: GetAudioSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetAudioSourceConfigurationResponse + attribute: false + wrapped: false + GetAudioSourceConfigurationsRequest: + title: GetAudioSourceConfigurationsRequest + required: + - GetAudioSourceConfigurations + type: object + properties: + GetAudioSourceConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurations' + - {} + GetAudioSourceConfigurationsResponse: + title: GetAudioSourceConfigurationsResponse + required: + - GetAudioSourceConfigurationsResponse + type: object + properties: + GetAudioSourceConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurationsResponse' + - xml: + name: GetAudioSourceConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioSourceConfigurationsResponse + attribute: false + wrapped: false + GetAudioSourcesRequest: + title: GetAudioSourcesRequest + required: + - GetAudioSources + type: object + properties: + GetAudioSources: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSources' + - {} + GetAudioSourcesResponse: + title: GetAudioSourcesResponse + required: + - GetAudioSourcesResponse + type: object + properties: + GetAudioSourcesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourcesResponse' + - xml: + name: GetAudioSourcesResponse + attribute: false + wrapped: false + xml: + name: GetAudioSourcesResponse + attribute: false + wrapped: false + GetCompatibleAudioDecoderConfigurationsRequest: + title: GetCompatibleAudioDecoderConfigurationsRequest + required: + - GetCompatibleAudioDecoderConfigurations + type: object + properties: + GetCompatibleAudioDecoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioDecoderConfigurations' + - {} + GetCompatibleAudioDecoderConfigurationsResponse: + title: GetCompatibleAudioDecoderConfigurationsResponse + required: + - GetCompatibleAudioDecoderConfigurationsResponse + type: object + properties: + GetCompatibleAudioDecoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioDecoderConfigurationsResponse' + - xml: + name: GetCompatibleAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleAudioEncoderConfigurationsRequest: + title: GetCompatibleAudioEncoderConfigurationsRequest + required: + - GetCompatibleAudioEncoderConfigurations + type: object + properties: + GetCompatibleAudioEncoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioEncoderConfigurations' + - {} + GetCompatibleAudioEncoderConfigurationsResponse: + title: GetCompatibleAudioEncoderConfigurationsResponse + required: + - GetCompatibleAudioEncoderConfigurationsResponse + type: object + properties: + GetCompatibleAudioEncoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioEncoderConfigurationsResponse' + - xml: + name: GetCompatibleAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleAudioOutputConfigurationsRequest: + title: GetCompatibleAudioOutputConfigurationsRequest + required: + - GetCompatibleAudioOutputConfigurations + type: object + properties: + GetCompatibleAudioOutputConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioOutputConfigurations' + - {} + GetCompatibleAudioOutputConfigurationsResponse: + title: GetCompatibleAudioOutputConfigurationsResponse + required: + - GetCompatibleAudioOutputConfigurationsResponse + type: object + properties: + GetCompatibleAudioOutputConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioOutputConfigurationsResponse' + - xml: + name: GetCompatibleAudioOutputConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleAudioOutputConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleAudioSourceConfigurationsRequest: + title: GetCompatibleAudioSourceConfigurationsRequest + required: + - GetCompatibleAudioSourceConfigurations + type: object + properties: + GetCompatibleAudioSourceConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioSourceConfigurations' + - {} + GetCompatibleAudioSourceConfigurationsResponse: + title: GetCompatibleAudioSourceConfigurationsResponse + required: + - GetCompatibleAudioSourceConfigurationsResponse + type: object + properties: + GetCompatibleAudioSourceConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleAudioSourceConfigurationsResponse' + - xml: + name: GetCompatibleAudioSourceConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleAudioSourceConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleMetadataConfigurationsRequest: + title: GetCompatibleMetadataConfigurationsRequest + required: + - GetCompatibleMetadataConfigurations + type: object + properties: + GetCompatibleMetadataConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleMetadataConfigurations' + - {} + GetCompatibleMetadataConfigurationsResponse: + title: GetCompatibleMetadataConfigurationsResponse + required: + - GetCompatibleMetadataConfigurationsResponse + type: object + properties: + GetCompatibleMetadataConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleMetadataConfigurationsResponse' + - xml: + name: GetCompatibleMetadataConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleMetadataConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleVideoAnalyticsConfigurationsRequest: + title: GetCompatibleVideoAnalyticsConfigurationsRequest + required: + - GetCompatibleVideoAnalyticsConfigurations + type: object + properties: + GetCompatibleVideoAnalyticsConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleVideoAnalyticsConfigurations' + - {} + GetCompatibleVideoAnalyticsConfigurationsResponse: + title: GetCompatibleVideoAnalyticsConfigurationsResponse + required: + - GetCompatibleVideoAnalyticsConfigurationsResponse + type: object + properties: + GetCompatibleVideoAnalyticsConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleVideoAnalyticsConfigurationsResponse' + - xml: + name: GetCompatibleVideoAnalyticsConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleVideoAnalyticsConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleVideoEncoderConfigurationsRequest: + title: GetCompatibleVideoEncoderConfigurationsRequest + required: + - GetCompatibleVideoEncoderConfigurations + type: object + properties: + GetCompatibleVideoEncoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleVideoEncoderConfigurations' + - {} + GetCompatibleVideoEncoderConfigurationsResponse: + title: GetCompatibleVideoEncoderConfigurationsResponse + required: + - GetCompatibleVideoEncoderConfigurationsResponse + type: object + properties: + GetCompatibleVideoEncoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleVideoEncoderConfigurationsResponse' + - xml: + name: GetCompatibleVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + GetCompatibleVideoSourceConfigurationsRequest: + title: GetCompatibleVideoSourceConfigurationsRequest + required: + - GetCompatibleVideoSourceConfigurations + type: object + properties: + GetCompatibleVideoSourceConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleVideoSourceConfigurations' + - {} + GetCompatibleVideoSourceConfigurationsResponse: + title: GetCompatibleVideoSourceConfigurationsResponse + required: + - GetCompatibleVideoSourceConfigurationsResponse + type: object + properties: + GetCompatibleVideoSourceConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleVideoSourceConfigurationsResponse' + - xml: + name: GetCompatibleVideoSourceConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleVideoSourceConfigurationsResponse + attribute: false + wrapped: false + GetGuaranteedNumberOfVideoEncoderInstancesRequest: + title: GetGuaranteedNumberOfVideoEncoderInstancesRequest + required: + - GetGuaranteedNumberOfVideoEncoderInstances + type: object + properties: + GetGuaranteedNumberOfVideoEncoderInstances: + allOf: + - $ref: '#/components/schemas/tns_GetGuaranteedNumberOfVideoEncoderInstances' + - {} + GetGuaranteedNumberOfVideoEncoderInstancesResponse: + title: GetGuaranteedNumberOfVideoEncoderInstancesResponse + required: + - GetGuaranteedNumberOfVideoEncoderInstancesResponse + type: object + properties: + GetGuaranteedNumberOfVideoEncoderInstancesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetGuaranteedNumberOfVideoEncoderInstancesResponse' + - xml: + name: GetGuaranteedNumberOfVideoEncoderInstancesResponse + attribute: false + wrapped: false + xml: + name: GetGuaranteedNumberOfVideoEncoderInstancesResponse + attribute: false + wrapped: false + GetMetadataConfigurationOptionsRequest: + title: GetMetadataConfigurationOptionsRequest + required: + - GetMetadataConfigurationOptions + type: object + properties: + GetMetadataConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurationOptions' + - {} + GetMetadataConfigurationOptionsResponse: + title: GetMetadataConfigurationOptionsResponse + required: + - GetMetadataConfigurationOptionsResponse + type: object + properties: + GetMetadataConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurationOptionsResponse' + - xml: + name: GetMetadataConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetMetadataConfigurationOptionsResponse + attribute: false + wrapped: false + GetMetadataConfigurationRequest: + title: GetMetadataConfigurationRequest + required: + - GetMetadataConfiguration + type: object + properties: + GetMetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfiguration' + - {} + GetMetadataConfigurationResponse: + title: GetMetadataConfigurationResponse + required: + - GetMetadataConfigurationResponse + type: object + properties: + GetMetadataConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurationResponse' + - xml: + name: GetMetadataConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetMetadataConfigurationResponse + attribute: false + wrapped: false + GetMetadataConfigurationsRequest: + title: GetMetadataConfigurationsRequest + required: + - GetMetadataConfigurations + type: object + properties: + GetMetadataConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurations' + - {} + GetMetadataConfigurationsResponse: + title: GetMetadataConfigurationsResponse + required: + - GetMetadataConfigurationsResponse + type: object + properties: + GetMetadataConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurationsResponse' + - xml: + name: GetMetadataConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetMetadataConfigurationsResponse + attribute: false + wrapped: false + GetOSDOptionsRequest: + title: GetOSDOptionsRequest + required: + - GetOSDOptions + type: object + properties: + GetOSDOptions: + allOf: + - $ref: '#/components/schemas/tns_GetOSDOptions' + - {} + GetOSDOptionsResponse: + title: GetOSDOptionsResponse + required: + - GetOSDOptionsResponse + type: object + properties: + GetOSDOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetOSDOptionsResponse' + - xml: + name: GetOSDOptionsResponse + attribute: false + wrapped: false + xml: + name: GetOSDOptionsResponse + attribute: false + wrapped: false + GetOSDRequest: + title: GetOSDRequest + required: + - GetOSD + type: object + properties: + GetOSD: + allOf: + - $ref: '#/components/schemas/tns_GetOSD' + - {} + GetOSDResponse: + title: GetOSDResponse + required: + - GetOSDResponse + type: object + properties: + GetOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_GetOSDResponse' + - xml: + name: GetOSDResponse + attribute: false + wrapped: false + xml: + name: GetOSDResponse + attribute: false + wrapped: false + GetOSDsRequest: + title: GetOSDsRequest + required: + - GetOSDs + type: object + properties: + GetOSDs: + allOf: + - $ref: '#/components/schemas/tns_GetOSDs' + - {} + GetOSDsResponse: + title: GetOSDsResponse + required: + - GetOSDsResponse + type: object + properties: + GetOSDsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetOSDsResponse' + - xml: + name: GetOSDsResponse + attribute: false + wrapped: false + xml: + name: GetOSDsResponse + attribute: false + wrapped: false + GetProfileRequest: + title: GetProfileRequest + required: + - GetProfile + type: object + properties: + GetProfile: + allOf: + - $ref: '#/components/schemas/tns_GetProfile' + - {} + GetProfileResponse: + title: GetProfileResponse + required: + - GetProfileResponse + type: object + properties: + GetProfileResponse: + allOf: + - $ref: '#/components/schemas/tns_GetProfileResponse' + - xml: + name: GetProfileResponse + attribute: false + wrapped: false + xml: + name: GetProfileResponse + attribute: false + wrapped: false + GetProfilesRequest: + title: GetProfilesRequest + required: + - GetProfiles + type: object + properties: + GetProfiles: + allOf: + - $ref: '#/components/schemas/tns_GetProfiles' + - {} + GetProfilesResponse: + title: GetProfilesResponse + required: + - GetProfilesResponse + type: object + properties: + GetProfilesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetProfilesResponse' + - xml: + name: GetProfilesResponse + attribute: false + wrapped: false + xml: + name: GetProfilesResponse + attribute: false + wrapped: false + GetServiceCapabilitiesRequest: + title: GetServiceCapabilitiesRequest + required: + - GetServiceCapabilities + type: object + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + GetServiceCapabilitiesResponse: + title: GetServiceCapabilitiesResponse + required: + - GetServiceCapabilitiesResponse + type: object + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + GetSnapshotUriRequest: + title: GetSnapshotUriRequest + required: + - GetSnapshotUri + type: object + properties: + GetSnapshotUri: + allOf: + - $ref: '#/components/schemas/tns_GetSnapshotUri' + - {} + GetSnapshotUriResponse: + title: GetSnapshotUriResponse + required: + - GetSnapshotUriResponse + type: object + properties: + GetSnapshotUriResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSnapshotUriResponse' + - xml: + name: GetSnapshotUriResponse + attribute: false + wrapped: false + xml: + name: GetSnapshotUriResponse + attribute: false + wrapped: false + GetStreamUriRequest: + title: GetStreamUriRequest + required: + - GetStreamUri + type: object + properties: + GetStreamUri: + allOf: + - $ref: '#/components/schemas/tns_GetStreamUri' + - {} + GetStreamUriResponse: + title: GetStreamUriResponse + required: + - GetStreamUriResponse + type: object + properties: + GetStreamUriResponse: + allOf: + - $ref: '#/components/schemas/tns_GetStreamUriResponse' + - xml: + name: GetStreamUriResponse + attribute: false + wrapped: false + xml: + name: GetStreamUriResponse + attribute: false + wrapped: false + GetVideoAnalyticsConfigurationRequest: + title: GetVideoAnalyticsConfigurationRequest + required: + - GetVideoAnalyticsConfiguration + type: object + properties: + GetVideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetVideoAnalyticsConfiguration' + - {} + GetVideoAnalyticsConfigurationResponse: + title: GetVideoAnalyticsConfigurationResponse + required: + - GetVideoAnalyticsConfigurationResponse + type: object + properties: + GetVideoAnalyticsConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoAnalyticsConfigurationResponse' + - xml: + name: GetVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + GetVideoAnalyticsConfigurationsRequest: + title: GetVideoAnalyticsConfigurationsRequest + required: + - GetVideoAnalyticsConfigurations + type: object + properties: + GetVideoAnalyticsConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetVideoAnalyticsConfigurations' + - {} + GetVideoAnalyticsConfigurationsResponse: + title: GetVideoAnalyticsConfigurationsResponse + required: + - GetVideoAnalyticsConfigurationsResponse + type: object + properties: + GetVideoAnalyticsConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoAnalyticsConfigurationsResponse' + - xml: + name: GetVideoAnalyticsConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetVideoAnalyticsConfigurationsResponse + attribute: false + wrapped: false + GetVideoEncoderConfigurationOptionsRequest: + title: GetVideoEncoderConfigurationOptionsRequest + required: + - GetVideoEncoderConfigurationOptions + type: object + properties: + GetVideoEncoderConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurationOptions' + - {} + GetVideoEncoderConfigurationOptionsResponse: + title: GetVideoEncoderConfigurationOptionsResponse + required: + - GetVideoEncoderConfigurationOptionsResponse + type: object + properties: + GetVideoEncoderConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurationOptionsResponse' + - xml: + name: GetVideoEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetVideoEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + GetVideoEncoderConfigurationRequest: + title: GetVideoEncoderConfigurationRequest + required: + - GetVideoEncoderConfiguration + type: object + properties: + GetVideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfiguration' + - {} + GetVideoEncoderConfigurationResponse: + title: GetVideoEncoderConfigurationResponse + required: + - GetVideoEncoderConfigurationResponse + type: object + properties: + GetVideoEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurationResponse' + - xml: + name: GetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + GetVideoEncoderConfigurationsRequest: + title: GetVideoEncoderConfigurationsRequest + required: + - GetVideoEncoderConfigurations + type: object + properties: + GetVideoEncoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurations' + - {} + GetVideoEncoderConfigurationsResponse: + title: GetVideoEncoderConfigurationsResponse + required: + - GetVideoEncoderConfigurationsResponse + type: object + properties: + GetVideoEncoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurationsResponse' + - xml: + name: GetVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + GetVideoSourceConfigurationOptionsRequest: + title: GetVideoSourceConfigurationOptionsRequest + required: + - GetVideoSourceConfigurationOptions + type: object + properties: + GetVideoSourceConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurationOptions' + - {} + GetVideoSourceConfigurationOptionsResponse: + title: GetVideoSourceConfigurationOptionsResponse + required: + - GetVideoSourceConfigurationOptionsResponse + type: object + properties: + GetVideoSourceConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurationOptionsResponse' + - xml: + name: GetVideoSourceConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceConfigurationOptionsResponse + attribute: false + wrapped: false + GetVideoSourceConfigurationRequest: + title: GetVideoSourceConfigurationRequest + required: + - GetVideoSourceConfiguration + type: object + properties: + GetVideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfiguration' + - {} + GetVideoSourceConfigurationResponse: + title: GetVideoSourceConfigurationResponse + required: + - GetVideoSourceConfigurationResponse + type: object + properties: + GetVideoSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurationResponse' + - xml: + name: GetVideoSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceConfigurationResponse + attribute: false + wrapped: false + GetVideoSourceConfigurationsRequest: + title: GetVideoSourceConfigurationsRequest + required: + - GetVideoSourceConfigurations + type: object + properties: + GetVideoSourceConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurations' + - {} + GetVideoSourceConfigurationsResponse: + title: GetVideoSourceConfigurationsResponse + required: + - GetVideoSourceConfigurationsResponse + type: object + properties: + GetVideoSourceConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurationsResponse' + - xml: + name: GetVideoSourceConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceConfigurationsResponse + attribute: false + wrapped: false + GetVideoSourceModesRequest: + title: GetVideoSourceModesRequest + required: + - GetVideoSourceModes + type: object + properties: + GetVideoSourceModes: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceModes' + - {} + GetVideoSourceModesResponse: + title: GetVideoSourceModesResponse + required: + - GetVideoSourceModesResponse + type: object + properties: + GetVideoSourceModesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceModesResponse' + - xml: + name: GetVideoSourceModesResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceModesResponse + attribute: false + wrapped: false + GetVideoSourcesRequest: + title: GetVideoSourcesRequest + required: + - GetVideoSources + type: object + properties: + GetVideoSources: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSources' + - {} + GetVideoSourcesResponse: + title: GetVideoSourcesResponse + required: + - GetVideoSourcesResponse + type: object + properties: + GetVideoSourcesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourcesResponse' + - xml: + name: GetVideoSourcesResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourcesResponse + attribute: false + wrapped: false + RemoveAudioDecoderConfigurationRequest: + title: RemoveAudioDecoderConfigurationRequest + required: + - RemoveAudioDecoderConfiguration + type: object + properties: + RemoveAudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioDecoderConfiguration' + - {} + RemoveAudioDecoderConfigurationResponse: + title: RemoveAudioDecoderConfigurationResponse + required: + - RemoveAudioDecoderConfigurationResponse + type: object + properties: + RemoveAudioDecoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioDecoderConfigurationResponse' + - xml: + name: RemoveAudioDecoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveAudioDecoderConfigurationResponse + attribute: false + wrapped: false + RemoveAudioEncoderConfigurationRequest: + title: RemoveAudioEncoderConfigurationRequest + required: + - RemoveAudioEncoderConfiguration + type: object + properties: + RemoveAudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioEncoderConfiguration' + - {} + RemoveAudioEncoderConfigurationResponse: + title: RemoveAudioEncoderConfigurationResponse + required: + - RemoveAudioEncoderConfigurationResponse + type: object + properties: + RemoveAudioEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioEncoderConfigurationResponse' + - xml: + name: RemoveAudioEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveAudioEncoderConfigurationResponse + attribute: false + wrapped: false + RemoveAudioOutputConfigurationRequest: + title: RemoveAudioOutputConfigurationRequest + required: + - RemoveAudioOutputConfiguration + type: object + properties: + RemoveAudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioOutputConfiguration' + - {} + RemoveAudioOutputConfigurationResponse: + title: RemoveAudioOutputConfigurationResponse + required: + - RemoveAudioOutputConfigurationResponse + type: object + properties: + RemoveAudioOutputConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioOutputConfigurationResponse' + - xml: + name: RemoveAudioOutputConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveAudioOutputConfigurationResponse + attribute: false + wrapped: false + RemoveAudioSourceConfigurationRequest: + title: RemoveAudioSourceConfigurationRequest + required: + - RemoveAudioSourceConfiguration + type: object + properties: + RemoveAudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioSourceConfiguration' + - {} + RemoveAudioSourceConfigurationResponse: + title: RemoveAudioSourceConfigurationResponse + required: + - RemoveAudioSourceConfigurationResponse + type: object + properties: + RemoveAudioSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveAudioSourceConfigurationResponse' + - xml: + name: RemoveAudioSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveAudioSourceConfigurationResponse + attribute: false + wrapped: false + RemoveMetadataConfigurationRequest: + title: RemoveMetadataConfigurationRequest + required: + - RemoveMetadataConfiguration + type: object + properties: + RemoveMetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveMetadataConfiguration' + - {} + RemoveMetadataConfigurationResponse: + title: RemoveMetadataConfigurationResponse + required: + - RemoveMetadataConfigurationResponse + type: object + properties: + RemoveMetadataConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveMetadataConfigurationResponse' + - xml: + name: RemoveMetadataConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveMetadataConfigurationResponse + attribute: false + wrapped: false + RemovePTZConfigurationRequest: + title: RemovePTZConfigurationRequest + required: + - RemovePTZConfiguration + type: object + properties: + RemovePTZConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemovePTZConfiguration' + - {} + RemovePTZConfigurationResponse: + title: RemovePTZConfigurationResponse + required: + - RemovePTZConfigurationResponse + type: object + properties: + RemovePTZConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemovePTZConfigurationResponse' + - xml: + name: RemovePTZConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemovePTZConfigurationResponse + attribute: false + wrapped: false + RemoveVideoAnalyticsConfigurationRequest: + title: RemoveVideoAnalyticsConfigurationRequest + required: + - RemoveVideoAnalyticsConfiguration + type: object + properties: + RemoveVideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveVideoAnalyticsConfiguration' + - {} + RemoveVideoAnalyticsConfigurationResponse: + title: RemoveVideoAnalyticsConfigurationResponse + required: + - RemoveVideoAnalyticsConfigurationResponse + type: object + properties: + RemoveVideoAnalyticsConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveVideoAnalyticsConfigurationResponse' + - xml: + name: RemoveVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + RemoveVideoEncoderConfigurationRequest: + title: RemoveVideoEncoderConfigurationRequest + required: + - RemoveVideoEncoderConfiguration + type: object + properties: + RemoveVideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveVideoEncoderConfiguration' + - {} + RemoveVideoEncoderConfigurationResponse: + title: RemoveVideoEncoderConfigurationResponse + required: + - RemoveVideoEncoderConfigurationResponse + type: object + properties: + RemoveVideoEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveVideoEncoderConfigurationResponse' + - xml: + name: RemoveVideoEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveVideoEncoderConfigurationResponse + attribute: false + wrapped: false + RemoveVideoSourceConfigurationRequest: + title: RemoveVideoSourceConfigurationRequest + required: + - RemoveVideoSourceConfiguration + type: object + properties: + RemoveVideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveVideoSourceConfiguration' + - {} + RemoveVideoSourceConfigurationResponse: + title: RemoveVideoSourceConfigurationResponse + required: + - RemoveVideoSourceConfigurationResponse + type: object + properties: + RemoveVideoSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveVideoSourceConfigurationResponse' + - xml: + name: RemoveVideoSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveVideoSourceConfigurationResponse + attribute: false + wrapped: false + SetAudioDecoderConfigurationRequest: + title: SetAudioDecoderConfigurationRequest + required: + - SetAudioDecoderConfiguration + type: object + properties: + SetAudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioDecoderConfiguration' + - {} + SetAudioDecoderConfigurationResponse: + title: SetAudioDecoderConfigurationResponse + required: + - SetAudioDecoderConfigurationResponse + type: object + properties: + SetAudioDecoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetAudioDecoderConfigurationResponse' + - xml: + name: SetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + SetAudioEncoderConfigurationRequest: + title: SetAudioEncoderConfigurationRequest + required: + - SetAudioEncoderConfiguration + type: object + properties: + SetAudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioEncoderConfiguration' + - {} + SetAudioEncoderConfigurationResponse: + title: SetAudioEncoderConfigurationResponse + required: + - SetAudioEncoderConfigurationResponse + type: object + properties: + SetAudioEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetAudioEncoderConfigurationResponse' + - xml: + name: SetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + SetAudioOutputConfigurationRequest: + title: SetAudioOutputConfigurationRequest + required: + - SetAudioOutputConfiguration + type: object + properties: + SetAudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioOutputConfiguration' + - {} + SetAudioOutputConfigurationResponse: + title: SetAudioOutputConfigurationResponse + required: + - SetAudioOutputConfigurationResponse + type: object + properties: + SetAudioOutputConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetAudioOutputConfigurationResponse' + - xml: + name: SetAudioOutputConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioOutputConfigurationResponse + attribute: false + wrapped: false + SetAudioSourceConfigurationRequest: + title: SetAudioSourceConfigurationRequest + required: + - SetAudioSourceConfiguration + type: object + properties: + SetAudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioSourceConfiguration' + - {} + SetAudioSourceConfigurationResponse: + title: SetAudioSourceConfigurationResponse + required: + - SetAudioSourceConfigurationResponse + type: object + properties: + SetAudioSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetAudioSourceConfigurationResponse' + - xml: + name: SetAudioSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioSourceConfigurationResponse + attribute: false + wrapped: false + SetMetadataConfigurationRequest: + title: SetMetadataConfigurationRequest + required: + - SetMetadataConfiguration + type: object + properties: + SetMetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetMetadataConfiguration' + - {} + SetMetadataConfigurationResponse: + title: SetMetadataConfigurationResponse + required: + - SetMetadataConfigurationResponse + type: object + properties: + SetMetadataConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetMetadataConfigurationResponse' + - xml: + name: SetMetadataConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetMetadataConfigurationResponse + attribute: false + wrapped: false + SetOSDRequest: + title: SetOSDRequest + required: + - SetOSD + type: object + properties: + SetOSD: + allOf: + - $ref: '#/components/schemas/tns_SetOSD' + - {} + SetOSDResponse: + title: SetOSDResponse + required: + - SetOSDResponse + type: object + properties: + SetOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_SetOSDResponse' + - xml: + name: SetOSDResponse + attribute: false + wrapped: false + xml: + name: SetOSDResponse + attribute: false + wrapped: false + SetSynchronizationPointRequest: + title: SetSynchronizationPointRequest + required: + - SetSynchronizationPoint + type: object + properties: + SetSynchronizationPoint: + allOf: + - $ref: '#/components/schemas/tns_SetSynchronizationPoint' + - {} + SetSynchronizationPointResponse: + title: SetSynchronizationPointResponse + required: + - SetSynchronizationPointResponse + type: object + properties: + SetSynchronizationPointResponse: + allOf: + - $ref: '#/components/schemas/tns_SetSynchronizationPointResponse' + - xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + SetVideoAnalyticsConfigurationRequest: + title: SetVideoAnalyticsConfigurationRequest + required: + - SetVideoAnalyticsConfiguration + type: object + properties: + SetVideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetVideoAnalyticsConfiguration' + - {} + SetVideoAnalyticsConfigurationResponse: + title: SetVideoAnalyticsConfigurationResponse + required: + - SetVideoAnalyticsConfigurationResponse + type: object + properties: + SetVideoAnalyticsConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetVideoAnalyticsConfigurationResponse' + - xml: + name: SetVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetVideoAnalyticsConfigurationResponse + attribute: false + wrapped: false + SetVideoEncoderConfigurationRequest: + title: SetVideoEncoderConfigurationRequest + required: + - SetVideoEncoderConfiguration + type: object + properties: + SetVideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetVideoEncoderConfiguration' + - {} + SetVideoEncoderConfigurationResponse: + title: SetVideoEncoderConfigurationResponse + required: + - SetVideoEncoderConfigurationResponse + type: object + properties: + SetVideoEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetVideoEncoderConfigurationResponse' + - xml: + name: SetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + SetVideoSourceConfigurationRequest: + title: SetVideoSourceConfigurationRequest + required: + - SetVideoSourceConfiguration + type: object + properties: + SetVideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceConfiguration' + - {} + SetVideoSourceConfigurationResponse: + title: SetVideoSourceConfigurationResponse + required: + - SetVideoSourceConfigurationResponse + type: object + properties: + SetVideoSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceConfigurationResponse' + - xml: + name: SetVideoSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetVideoSourceConfigurationResponse + attribute: false + wrapped: false + SetVideoSourceModeRequest: + title: SetVideoSourceModeRequest + required: + - SetVideoSourceMode + type: object + properties: + SetVideoSourceMode: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceMode' + - {} + SetVideoSourceModeResponse: + title: SetVideoSourceModeResponse + required: + - SetVideoSourceModeResponse + type: object + properties: + SetVideoSourceModeResponse: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceModeResponse' + - xml: + name: SetVideoSourceModeResponse + attribute: false + wrapped: false + xml: + name: SetVideoSourceModeResponse + attribute: false + wrapped: false + StartMulticastStreamingRequest: + title: StartMulticastStreamingRequest + required: + - StartMulticastStreaming + type: object + properties: + StartMulticastStreaming: + allOf: + - $ref: '#/components/schemas/tns_StartMulticastStreaming' + - {} + StartMulticastStreamingResponse: + title: StartMulticastStreamingResponse + required: + - StartMulticastStreamingResponse + type: object + properties: + StartMulticastStreamingResponse: + allOf: + - $ref: '#/components/schemas/tns_StartMulticastStreamingResponse' + - xml: + name: StartMulticastStreamingResponse + attribute: false + wrapped: false + xml: + name: StartMulticastStreamingResponse + attribute: false + wrapped: false + StopMulticastStreamingRequest: + title: StopMulticastStreamingRequest + required: + - StopMulticastStreaming + type: object + properties: + StopMulticastStreaming: + allOf: + - $ref: '#/components/schemas/tns_StopMulticastStreaming' + - {} + StopMulticastStreamingResponse: + title: StopMulticastStreamingResponse + required: + - StopMulticastStreamingResponse + type: object + properties: + StopMulticastStreamingResponse: + allOf: + - $ref: '#/components/schemas/tns_StopMulticastStreamingResponse' + - xml: + name: StopMulticastStreamingResponse + attribute: false + wrapped: false + xml: + name: StopMulticastStreamingResponse + attribute: false + wrapped: false + tns1_space: + title: tns1_space + enum: + - default + - preserve + type: string + description: '' + xml: + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + attribute: false + wrapped: false + tt_ColorCluster: + title: tt_ColorCluster + required: + - Color + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Weight: + type: number + xml: + name: Weight + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Covariance: + allOf: + - $ref: '#/components/schemas/tt_ColorCovariance' + - xml: + name: Covariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorCluster + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice0: + title: tt_ColorOptionsChoice0 + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice1: + title: tt_ColorOptionsChoice1 + type: object + properties: + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItem: + title: tt_ElementItem + required: + - Name + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + description: Complex value structure. + xml: + name: ElementItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItemDescription: + title: tt_ElementItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: The type of the item. The Type must reference a defined type. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a complex type. The Type must reference a defined type. + xml: + name: ElementItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Messages: + title: tt_Messages + allOf: + - $ref: '#/components/schemas/tt_MessageDescription' + - required: + - ParentTopic + type: object + properties: + ParentTopic: + type: string + description: The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected. + xml: + name: ParentTopic + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Messages + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + tt_SimpleItem: + title: tt_SimpleItem + required: + - Name + - Value + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Value: + type: string + description: Item value. The type is defined in the corresponding description. + xml: + name: Value + prefix: tt + attribute: true + wrapped: false + description: Value name pair as defined by the corresponding description. + xml: + name: SimpleItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SimpleItemDescription: + title: tt_SimpleItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + name: SimpleItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SubscriptionPolicy: + title: tt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + wsnt_Message: + title: wsnt_Message + type: object + description: '' + xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicy: + title: wsnt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsrf-bf_Description: + title: wsrf-bf_Description + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_ErrorCode: + title: wsrf-bf_ErrorCode + required: + - dialect + type: object + properties: + dialect: + type: string + xml: + name: dialect + attribute: true + wrapped: false + description: '' + xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_FaultCause: + title: wsrf-bf_FaultCause + type: object + description: '' + xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Topic: + title: wstop_Topic + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - type: object + properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + name: parent + attribute: true + wrapped: false + xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object +tags: +- name: MediaBinding + description: '' diff --git a/doc/openapi/ref/media2.yaml b/doc/openapi/ref/media2.yaml new file mode 100644 index 00000000..3293482f --- /dev/null +++ b/doc/openapi/ref/media2.yaml @@ -0,0 +1,25522 @@ +openapi: 3.0.0 +info: + title: Untitled API + contact: {} + version: '1.0' +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +paths: + /GetServiceCapabilities: + post: + tags: + - Media2Binding + summary: GetServiceCapabilities + description: Returns the capabilities of the media service. The result is returned in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + name: GetServiceCapabilitiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + deprecated: false + /CreateProfile: + post: + tags: + - Media2Binding + summary: CreateProfile + description: "This operation creates a new media profile. \n A created profile created via this method may be deleted via the DeleteProfile method.\n Optionally Configurations can be assinged to the profile on creation. For details regarding profile assignement\n check also the method AddConfiguration." + operationId: CreateProfile + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateProfileRequest' + - xml: + name: CreateProfileRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateProfileResponse' + - xml: + name: CreateProfileResponse + attribute: false + wrapped: false + deprecated: false + /GetProfiles: + post: + tags: + - Media2Binding + summary: GetProfiles + description: Retrieve the profile with the specified token or all defined media profiles. + operationId: GetProfiles + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetProfilesRequest' + - xml: + name: GetProfilesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetProfilesResponse' + - xml: + name: GetProfilesResponse + attribute: false + wrapped: false + deprecated: false + /AddConfiguration: + post: + tags: + - Media2Binding + summary: AddConfiguration + 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. + operationId: AddConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddConfigurationRequest' + - xml: + name: AddConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AddConfigurationResponse' + - xml: + name: AddConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /RemoveConfiguration: + post: + tags: + - Media2Binding + summary: RemoveConfiguration + 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. + operationId: RemoveConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveConfigurationRequest' + - xml: + name: RemoveConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemoveConfigurationResponse' + - xml: + name: RemoveConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /DeleteProfile: + post: + tags: + - Media2Binding + summary: DeleteProfile + description: This operation deletes a profile. Deletion of a profile is only possible for non-fixed profiles + operationId: DeleteProfile + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteProfileRequest' + - xml: + name: DeleteProfileRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteProfileResponse' + - xml: + name: DeleteProfileResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceConfigurations: + post: + tags: + - Media2Binding + summary: GetVideoSourceConfigurations + 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. + operationId: GetVideoSourceConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationsRequest' + - xml: + name: GetVideoSourceConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationsResponse' + - xml: + name: GetVideoSourceConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoEncoderConfigurations: + post: + tags: + - Media2Binding + summary: GetVideoEncoderConfigurations + 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. + operationId: GetVideoEncoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationsRequest' + - xml: + name: GetVideoEncoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationsResponse' + - xml: + name: GetVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioSourceConfigurations: + post: + tags: + - Media2Binding + summary: GetAudioSourceConfigurations + 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. + operationId: GetAudioSourceConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationsRequest' + - xml: + name: GetAudioSourceConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationsResponse' + - xml: + name: GetAudioSourceConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioEncoderConfigurations: + post: + tags: + - Media2Binding + summary: GetAudioEncoderConfigurations + 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. + operationId: GetAudioEncoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationsRequest' + - xml: + name: GetAudioEncoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationsResponse' + - xml: + name: GetAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAnalyticsConfigurations: + post: + tags: + - Media2Binding + summary: GetAnalyticsConfigurations + 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. + operationId: GetAnalyticsConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAnalyticsConfigurationsRequest' + - xml: + name: GetAnalyticsConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAnalyticsConfigurationsResponse' + - xml: + name: GetAnalyticsConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetMetadataConfigurations: + post: + tags: + - Media2Binding + summary: GetMetadataConfigurations + 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. + operationId: GetMetadataConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationsRequest' + - xml: + name: GetMetadataConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationsResponse' + - xml: + name: GetMetadataConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioOutputConfigurations: + post: + tags: + - Media2Binding + summary: GetAudioOutputConfigurations + 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. + operationId: GetAudioOutputConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationsRequest' + - xml: + name: GetAudioOutputConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationsResponse' + - xml: + name: GetAudioOutputConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioDecoderConfigurations: + post: + tags: + - Media2Binding + summary: GetAudioDecoderConfigurations + 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. + operationId: GetAudioDecoderConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationsRequest' + - xml: + name: GetAudioDecoderConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationsResponse' + - xml: + name: GetAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoSourceConfiguration: + post: + tags: + - Media2Binding + summary: SetVideoSourceConfiguration + 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. + operationId: SetVideoSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceConfigurationRequest' + - xml: + name: SetVideoSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceConfigurationResponse' + - xml: + name: SetVideoSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoEncoderConfiguration: + post: + tags: + - Media2Binding + summary: SetVideoEncoderConfiguration + 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. + operationId: SetVideoEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoEncoderConfigurationRequest' + - xml: + name: SetVideoEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoEncoderConfigurationResponse' + - xml: + name: SetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioSourceConfiguration: + post: + tags: + - Media2Binding + summary: SetAudioSourceConfiguration + 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. + operationId: SetAudioSourceConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioSourceConfigurationRequest' + - xml: + name: SetAudioSourceConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioSourceConfigurationResponse' + - xml: + name: SetAudioSourceConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioEncoderConfiguration: + post: + tags: + - Media2Binding + summary: SetAudioEncoderConfiguration + 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. + operationId: SetAudioEncoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioEncoderConfigurationRequest' + - xml: + name: SetAudioEncoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioEncoderConfigurationResponse' + - xml: + name: SetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetMetadataConfiguration: + post: + tags: + - Media2Binding + summary: SetMetadataConfiguration + 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. + operationId: SetMetadataConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetMetadataConfigurationRequest' + - xml: + name: SetMetadataConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetMetadataConfigurationResponse' + - xml: + name: SetMetadataConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioOutputConfiguration: + post: + tags: + - Media2Binding + summary: SetAudioOutputConfiguration + description: This operation modifies an audio output configuration. + operationId: SetAudioOutputConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioOutputConfigurationRequest' + - xml: + name: SetAudioOutputConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioOutputConfigurationResponse' + - xml: + name: SetAudioOutputConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /SetAudioDecoderConfiguration: + post: + tags: + - Media2Binding + summary: SetAudioDecoderConfiguration + description: This operation modifies an audio decoder configuration. + operationId: SetAudioDecoderConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioDecoderConfigurationRequest' + - xml: + name: SetAudioDecoderConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetAudioDecoderConfigurationResponse' + - xml: + name: SetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetVideoSourceConfigurationOptions + 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. + operationId: GetVideoSourceConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationOptionsRequest' + - xml: + name: GetVideoSourceConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceConfigurationOptionsResponse' + - xml: + name: GetVideoSourceConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoEncoderConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetVideoEncoderConfigurationOptions + description: "This operation returns the available options (supported values and ranges for video encoder \n configuration parameters) when the video encoder parameters are reconfigured." + operationId: GetVideoEncoderConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationOptionsRequest' + - xml: + name: GetVideoEncoderConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderConfigurationOptionsResponse' + - xml: + name: GetVideoEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioSourceConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetAudioSourceConfigurationOptions + 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. + operationId: GetAudioSourceConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationOptionsRequest' + - xml: + name: GetAudioSourceConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioSourceConfigurationOptionsResponse' + - xml: + name: GetAudioSourceConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioEncoderConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetAudioEncoderConfigurationOptions + description: >- + This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are + reconfigured. + operationId: GetAudioEncoderConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationOptionsRequest' + - xml: + name: GetAudioEncoderConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioEncoderConfigurationOptionsResponse' + - xml: + name: GetAudioEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetMetadataConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetMetadataConfigurationOptions + description: This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. + operationId: GetMetadataConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationOptionsRequest' + - xml: + name: GetMetadataConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMetadataConfigurationOptionsResponse' + - xml: + name: GetMetadataConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioOutputConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetAudioOutputConfigurationOptions + description: This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. + operationId: GetAudioOutputConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationOptionsRequest' + - xml: + name: GetAudioOutputConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioOutputConfigurationOptionsResponse' + - xml: + name: GetAudioOutputConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetAudioDecoderConfigurationOptions: + post: + tags: + - Media2Binding + summary: GetAudioDecoderConfigurationOptions + description: >- + This command list the audio decoding capabilities for a given profile and configuration of a + device. + operationId: GetAudioDecoderConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationOptionsRequest' + - xml: + name: GetAudioDecoderConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetAudioDecoderConfigurationOptionsResponse' + - xml: + name: GetAudioDecoderConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoEncoderInstances: + post: + tags: + - Media2Binding + summary: GetVideoEncoderInstances + description: >- + The GetVideoEncoderInstances command can be used to request the + minimum number of guaranteed video encoder instances (applications) per Video Source + Configuration. + operationId: GetVideoEncoderInstances + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderInstancesRequest' + - xml: + name: GetVideoEncoderInstancesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoEncoderInstancesResponse' + - xml: + name: GetVideoEncoderInstancesResponse + attribute: false + wrapped: false + deprecated: false + /GetStreamUri: + post: + tags: + - Media2Binding + summary: GetStreamUri + 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. + operationId: GetStreamUri + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStreamUriRequest' + - xml: + name: GetStreamUriRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStreamUriResponse' + - xml: + name: GetStreamUriResponse + attribute: false + wrapped: false + deprecated: false + /StartMulticastStreaming: + post: + tags: + - Media2Binding + summary: StartMulticastStreaming + 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. + operationId: StartMulticastStreaming + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartMulticastStreamingRequest' + - xml: + name: StartMulticastStreamingRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StartMulticastStreamingResponse' + - xml: + name: StartMulticastStreamingResponse + attribute: false + wrapped: false + deprecated: false + /StopMulticastStreaming: + post: + tags: + - Media2Binding + summary: StopMulticastStreaming + description: This command stops multicast streaming using a specified media profile of a device + operationId: StopMulticastStreaming + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopMulticastStreamingRequest' + - xml: + name: StopMulticastStreamingRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopMulticastStreamingResponse' + - xml: + name: StopMulticastStreamingResponse + attribute: false + wrapped: false + deprecated: false + /SetSynchronizationPoint: + post: + tags: + - Media2Binding + summary: SetSynchronizationPoint + 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. + operationId: SetSynchronizationPoint + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSynchronizationPointRequest' + - xml: + name: SetSynchronizationPointRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetSynchronizationPointResponse' + - xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + deprecated: false + /GetSnapshotUri: + post: + tags: + - Media2Binding + summary: GetSnapshotUri + 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 a 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. + operationId: GetSnapshotUri + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSnapshotUriRequest' + - xml: + name: GetSnapshotUriRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetSnapshotUriResponse' + - xml: + name: GetSnapshotUriResponse + attribute: false + wrapped: false + deprecated: false + /GetVideoSourceModes: + post: + tags: + - Media2Binding + summary: GetVideoSourceModes + 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. + operationId: GetVideoSourceModes + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceModesRequest' + - xml: + name: GetVideoSourceModesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetVideoSourceModesResponse' + - xml: + name: GetVideoSourceModesResponse + attribute: false + wrapped: false + deprecated: false + /SetVideoSourceMode: + post: + tags: + - Media2Binding + summary: SetVideoSourceMode + 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. + operationId: SetVideoSourceMode + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceModeRequest' + - xml: + name: SetVideoSourceModeRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetVideoSourceModeResponse' + - xml: + name: SetVideoSourceModeResponse + attribute: false + wrapped: false + deprecated: false + /GetOSDs: + post: + tags: + - Media2Binding + summary: GetOSDs + description: This operation lists existing OSD configurations for the device. + operationId: GetOSDs + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDsRequest' + - xml: + name: GetOSDsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDsResponse' + - xml: + name: GetOSDsResponse + attribute: false + wrapped: false + deprecated: false + /GetOSDOptions: + post: + tags: + - Media2Binding + summary: GetOSDOptions + description: Get the OSD Options. + operationId: GetOSDOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDOptionsRequest' + - xml: + name: GetOSDOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetOSDOptionsResponse' + - xml: + name: GetOSDOptionsResponse + attribute: false + wrapped: false + deprecated: false + /SetOSD: + post: + tags: + - Media2Binding + summary: SetOSD + description: Set the OSD + operationId: SetOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetOSDRequest' + - xml: + name: SetOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetOSDResponse' + - xml: + name: SetOSDResponse + attribute: false + wrapped: false + deprecated: false + /CreateOSD: + post: + tags: + - Media2Binding + summary: CreateOSD + description: Create the OSD. + operationId: CreateOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateOSDRequest' + - xml: + name: CreateOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateOSDResponse' + - xml: + name: CreateOSDResponse + attribute: false + wrapped: false + deprecated: false + /DeleteOSD: + post: + tags: + - Media2Binding + summary: DeleteOSD + description: Delete the OSD. + operationId: DeleteOSD + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteOSDRequest' + - xml: + name: DeleteOSDRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteOSDResponse' + - xml: + name: DeleteOSDResponse + attribute: false + wrapped: false + deprecated: false + /GetMasks: + post: + tags: + - Media2Binding + summary: GetMasks + description: This operation lists existing Mask configurations for the device. + operationId: GetMasks + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMasksRequest' + - xml: + name: GetMasksRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMasksResponse' + - xml: + name: GetMasksResponse + attribute: false + wrapped: false + deprecated: false + /GetMaskOptions: + post: + tags: + - Media2Binding + summary: GetMaskOptions + description: Get the Mask Options. + operationId: GetMaskOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMaskOptionsRequest' + - xml: + name: GetMaskOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetMaskOptionsResponse' + - xml: + name: GetMaskOptionsResponse + attribute: false + wrapped: false + deprecated: false + /SetMask: + post: + tags: + - Media2Binding + summary: SetMask + description: Set the Mask + operationId: SetMask + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetMaskRequest' + - xml: + name: SetMaskRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetMaskResponse' + - xml: + name: SetMaskResponse + attribute: false + wrapped: false + deprecated: false + /CreateMask: + post: + tags: + - Media2Binding + summary: CreateMask + description: Create the Mask. + operationId: CreateMask + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateMaskRequest' + - xml: + name: CreateMaskRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreateMaskResponse' + - xml: + name: CreateMaskResponse + attribute: false + wrapped: false + deprecated: false + /DeleteMask: + post: + tags: + - Media2Binding + summary: DeleteMask + description: Delete the Mask. + operationId: DeleteMask + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteMaskRequest' + - xml: + name: DeleteMaskRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/DeleteMaskResponse' + - xml: + name: DeleteMaskResponse + attribute: false + wrapped: false + deprecated: false +components: + schemas: + tns_GetServiceCapabilities: + title: tns_GetServiceCapabilities + type: object + description: '' + xml: + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetServiceCapabilitiesResponse: + title: tns_GetServiceCapabilitiesResponse + required: + - Capabilities + type: object + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities2' + - description: The capabilities for the media service is returned in the Capabilities element. + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Capabilities2: + title: tns_Capabilities2 + required: + - ProfileCapabilities + - StreamingCapabilities + type: object + properties: + SnapshotUri: + type: boolean + description: Indicates if GetSnapshotUri is supported. + xml: + name: SnapshotUri + prefix: tns + attribute: true + wrapped: false + Rotation: + type: boolean + description: Indicates whether or not Rotation feature is supported. + xml: + name: Rotation + prefix: tns + attribute: true + wrapped: false + VideoSourceMode: + type: boolean + description: Indicates the support for changing video source mode. + xml: + name: VideoSourceMode + prefix: tns + attribute: true + wrapped: false + OSD: + type: boolean + description: Indicates if OSD is supported. + xml: + name: OSD + prefix: tns + attribute: true + wrapped: false + TemporaryOSDText: + type: boolean + description: Indicates the support for temporary osd text configuration. + xml: + name: TemporaryOSDText + prefix: tns + attribute: true + wrapped: false + Mask: + type: boolean + description: Indicates if Masking is supported. + xml: + name: Mask + prefix: tns + attribute: true + wrapped: false + SourceMask: + type: boolean + description: "Indicates that privacy masks are only supported at the video source level and not the video source configuration level. \n If this is true any addition, deletion or change of a privacy mask done for one video source configuration will automatically be \n applied by the device to a corresponding privacy mask for all other video source configuration associated with the same video source." + xml: + name: SourceMask + prefix: tns + attribute: true + wrapped: false + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tns_ProfileCapabilities' + - description: Media profile capabilities. + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tns_StreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities2 + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ProfileCapabilities: + title: tns_ProfileCapabilities + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles supported. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tns + attribute: true + wrapped: false + ConfigurationsSupported: + type: string + description: The configurations supported by the device as defined by tr2:ConfigurationEnumeration. The enumeration value "All" shall not be included in this list. + xml: + name: ConfigurationsSupported + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StreamingCapabilities: + title: tns_StreamingCapabilities + type: object + properties: + RTSPStreaming: + type: boolean + description: Indicates support for live media streaming via RTSP. + xml: + name: RTSPStreaming + prefix: tns + attribute: true + wrapped: false + RTPMulticast: + type: boolean + description: Indicates support for RTP multicast. + xml: + name: RTPMulticast + prefix: tns + attribute: true + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates support for RTP/RTSP/TCP. + xml: + name: RTP_RTSP_TCP + prefix: tns + attribute: true + wrapped: false + NonAggregateControl: + type: boolean + description: Indicates support for non aggregate RTSP control. + xml: + name: NonAggregateControl + prefix: tns + attribute: true + wrapped: false + RTSPWebSocketUri: + type: string + description: If streaming over WebSocket is supported, this shall return the RTSP WebSocket URI as described in Streaming Specification Section 5.1.1.5. + xml: + name: RTSPWebSocketUri + prefix: tns + attribute: true + wrapped: false + AutoStartMulticast: + type: boolean + description: Indicates support for non-RTSP controlled multicast streaming. + xml: + name: AutoStartMulticast + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ConfigurationEnumeration: + title: tns_ConfigurationEnumeration + enum: + - All + - VideoSource + - VideoEncoder + - AudioSource + - AudioEncoder + - AudioOutput + - AudioDecoder + - Metadata + - Analytics + - PTZ + - Receiver + type: string + description: '' + xml: + name: ConfigurationEnumeration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ConfigurationRef: + title: tns_ConfigurationRef + required: + - Type + type: object + properties: + Type: + type: string + description: Type of the configuration as defined by tr2:ConfigurationEnumeration. + xml: + name: Type + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: >- + Reference token of an existing configuration. + Token shall be included in the AddConfiguration request along with the type. + Token shall be included in the CreateProfile request when Configuration elements are included and type is selected. + Token is optional for RemoveConfiguration request. If no token is provided in RemoveConfiguration request, device shall + remove the configuration of the type included in the profile. + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: ConfigurationRef + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ReceiverConfiguration: + title: tns_ReceiverConfiguration + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - type: object + properties: + token: + maxLength: 64 + type: string + xml: + name: token + prefix: tns + attribute: true + wrapped: false + xml: + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + tns_ConfigurationSet: + title: tns_ConfigurationSet + type: object + properties: + VideoSource: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + name: VideoSource + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + AudioSource: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + name: AudioSource + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + VideoEncoder: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoder2Configuration' + - description: Optional configuration of the Video encoder. + xml: + name: VideoEncoder + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + AudioEncoder: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoder2Configuration' + - description: Optional configuration of the Audio encoder. + xml: + name: AudioEncoder + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Analytics: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the analytics module and rule engine. + xml: + name: Analytics + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + name: PTZ + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + name: Metadata + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + AudioOutput: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + name: AudioOutput + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + AudioDecoder: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + name: AudioDecoder + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tns_ReceiverConfiguration' + - description: Optional configuration of the Receiver. + xml: + name: Receiver + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: A set of media configurations. + xml: + name: ConfigurationSet + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MediaProfile: + title: tns_MediaProfile + required: + - token + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of the profile. + xml: + name: token + prefix: tns + attribute: true + wrapped: false + fixed: + type: boolean + description: A value of true signals that the profile cannot be deleted. Default is false. + xml: + name: fixed + prefix: tns + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Configurations: + allOf: + - $ref: '#/components/schemas/tns_ConfigurationSet' + - description: The configurations assigned to the profile. + xml: + name: Configurations + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: A media profile consists of a set of media configurations. + xml: + name: MediaProfile + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateProfile: + title: tns_CreateProfile + required: + - Name + type: object + properties: + Name: + maxLength: 64 + type: string + description: friendly name of the profile to be created + xml: + name: Name + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Configuration: + type: array + items: + $ref: '#/components/schemas/tns_ConfigurationRef' + description: Optional set of configurations to be assigned to the profile. List entries with tr2:ConfigurationEnumeration value "All" shall be ignored. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateProfile + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateProfileResponse: + title: tns_CreateProfileResponse + required: + - Token + type: object + properties: + Token: + maxLength: 64 + type: string + description: Token assigned by the device for the newly created profile. + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateProfileResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetProfiles: + title: tns_GetProfiles + type: object + properties: + Token: + maxLength: 64 + type: string + description: Optional token of the requested profile. + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Type: + type: array + items: + type: string + xml: + name: Type + attribute: false + wrapped: false + description: The types shall be provided as defined by tr2:ConfigurationEnumeration. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetProfiles + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetProfilesResponse: + title: tns_GetProfilesResponse + type: object + properties: + Profiles: + type: array + items: + $ref: '#/components/schemas/tns_MediaProfile' + description: "Lists all profiles that exist in the media service. The response provides the requested types of Configurations as far as available. \n If a profile doesn't contain a type no error shall be provided." + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetProfilesResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddConfiguration: + title: tns_AddConfiguration + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Reference to the profile where the configuration should be added + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Name: + maxLength: 64 + type: string + description: Optional item. If present updates the Name property of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Configuration: + type: array + items: + $ref: '#/components/schemas/tns_ConfigurationRef' + 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. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AddConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AddConfigurationResponse: + title: tns_AddConfigurationResponse + type: object + description: '' + xml: + name: AddConfigurationResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveConfiguration: + title: tns_RemoveConfiguration + required: + - ProfileToken + - Configuration + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: This element contains a reference to the media profile from which the AudioDecoderConfiguration shall be removed. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Configuration: + type: array + items: + $ref: '#/components/schemas/tns_ConfigurationRef' + 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. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemoveConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemoveConfigurationResponse: + title: tns_RemoveConfigurationResponse + type: object + description: '' + xml: + name: RemoveConfigurationResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteProfile: + title: tns_DeleteProfile + required: + - Token + type: object + properties: + Token: + maxLength: 64 + type: string + description: This element contains a reference to the profile that should be deleted. + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteProfile + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteProfileResponse: + title: tns_DeleteProfileResponse + type: object + description: '' + xml: + name: DeleteProfileResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfiguration: + title: tns_GetConfiguration + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurationsResponse: + title: tns_GetVideoEncoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoEncoder2Configuration' + description: This element contains a list of video encoder configurations. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurationsResponse: + title: tns_GetVideoSourceConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoSourceConfiguration' + description: This element contains a list of video source configurations. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurationsResponse: + title: tns_GetAudioEncoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoder2Configuration' + description: This element contains a list of audio encoder configurations. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurationsResponse: + title: tns_GetAudioSourceConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioSourceConfiguration' + description: This element contains a list of audio source configurations. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAnalyticsConfigurationsResponse: + title: tns_GetAnalyticsConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + description: This element contains a list of Analytics configurations. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAnalyticsConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurationsResponse: + title: tns_GetMetadataConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_MetadataConfiguration' + description: This element contains a list of metadata configurations + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurationsResponse: + title: tns_GetAudioOutputConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioOutputConfiguration' + description: This element contains a list of audio output configurations + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurationsResponse: + title: tns_GetAudioDecoderConfigurationsResponse + type: object + properties: + Configurations: + type: array + items: + $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + description: This element contains a list of audio decoder configurations + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfigurationsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoEncoderConfiguration: + title: tns_SetVideoEncoderConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoder2Configuration' + - description: Contains the modified video encoder configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoEncoderConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetConfigurationResponse: + title: tns_SetConfigurationResponse + type: object + description: '' + xml: + name: SetConfigurationResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceConfiguration: + title: tns_SetVideoSourceConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Contains the modified video source configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoSourceConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioEncoderConfiguration: + title: tns_SetAudioEncoderConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoder2Configuration' + - description: Contains the modified audio encoder configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioEncoderConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioSourceConfiguration: + title: tns_SetAudioSourceConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Contains the modified audio source configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioSourceConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetMetadataConfiguration: + title: tns_SetMetadataConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Contains the modified metadata configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetMetadataConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioOutputConfiguration: + title: tns_SetAudioOutputConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Contains the modified audio output configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioOutputConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetAudioDecoderConfiguration: + title: tns_SetAudioDecoderConfiguration + required: + - Configuration + type: object + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Contains the modified audio decoder configuration. The configuration shall exist in the device. + xml: + name: Configuration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetAudioDecoderConfiguration + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceConfigurationOptionsResponse: + title: tns_GetVideoSourceConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderConfigurationOptionsResponse: + title: tns_GetVideoEncoderConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_VideoEncoder2ConfigurationOptions' + description: '' + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioSourceConfigurationOptionsResponse: + title: tns_GetAudioSourceConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioSourceConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioEncoderConfigurationOptionsResponse: + title: tns_GetAudioEncoderConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoder2ConfigurationOptions' + 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. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioEncoderConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMetadataConfigurationOptionsResponse: + title: tns_GetMetadataConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMetadataConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioOutputConfigurationOptionsResponse: + title: tns_GetAudioOutputConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfigurationOptions' + - 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. + xml: + name: Options + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioOutputConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetAudioDecoderConfigurationOptionsResponse: + title: tns_GetAudioDecoderConfigurationOptionsResponse + required: + - Options + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoder2ConfigurationOptions' + 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. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetAudioDecoderConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_TransportProtocol: + title: tns_TransportProtocol + enum: + - RtspUnicast + - RtspMulticast + - RTSP + - RtspOverHttp + type: string + description: '' + xml: + name: TransportProtocol + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderInstances: + title: tns_GetVideoEncoderInstances + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the video source configuration + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderInstances + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_EncoderInstance: + title: tns_EncoderInstance + required: + - Encoding + - Number + type: object + properties: + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Number: + type: integer + description: The minimum guaranteed number of encoder instances (applications) for the VideoSourceConfiguration. + format: int32 + xml: + name: Number + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: EncoderInstance + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_EncoderInstanceInfo: + title: tns_EncoderInstanceInfo + required: + - Total + type: object + properties: + Codec: + type: array + items: + $ref: '#/components/schemas/tns_EncoderInstance' + 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. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Total: + type: integer + description: The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. The device is able to deliver the Total number of streams + format: int32 + xml: + name: Total + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: EncoderInstanceInfo + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoEncoderInstancesResponse: + title: tns_GetVideoEncoderInstancesResponse + required: + - Info + type: object + properties: + Info: + allOf: + - $ref: '#/components/schemas/tns_EncoderInstanceInfo' + - description: The minimum guaranteed total number of encoder instances (applications) per VideoSourceConfiguration. + xml: + name: Info + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoEncoderInstancesResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStreamUri: + title: tns_GetStreamUri + required: + - Protocol + - ProfileToken + type: object + properties: + Protocol: + type: string + description: Defines the network protocol for streaming as defined by tr2:TransportProtocol + xml: + name: Protocol + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + ProfileToken: + maxLength: 64 + type: string + description: The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStreamUri + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStreamUriResponse: + title: tns_GetStreamUriResponse + required: + - Uri + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting the media stream + xml: + name: Uri + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStreamUriResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetSynchronizationPoint: + title: tns_SetSynchronizationPoint + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains a Profile reference for which a Synchronization Point is requested. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetSynchronizationPoint + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetSynchronizationPointResponse: + title: tns_SetSynchronizationPointResponse + type: object + description: '' + xml: + name: SetSynchronizationPointResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSnapshotUri: + title: tns_GetSnapshotUri + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: The ProfileToken element indicates the media profile to use and will define the source and dimensions of the snapshot. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSnapshotUri + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetSnapshotUriResponse: + title: tns_GetSnapshotUriResponse + required: + - Uri + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting snapshot images. + xml: + name: Uri + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetSnapshotUriResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StartStopMulticastStreaming: + title: tns_StartStopMulticastStreaming + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of the Profile that is used to define the multicast stream. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: StartStopMulticastStreaming + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceModes: + title: tns_GetVideoSourceModes + required: + - VideoSourceToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Contains a video source reference for which a video source mode is requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceModes + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetVideoSourceModesResponse: + title: tns_GetVideoSourceModesResponse + required: + - VideoSourceModes + type: object + properties: + VideoSourceModes: + type: array + items: + $ref: '#/components/schemas/tns_VideoSourceMode' + description: Return the information for specified video source mode. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetVideoSourceModesResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceMode: + title: tns_SetVideoSourceMode + required: + - VideoSourceToken + - VideoSourceModeToken + type: object + properties: + VideoSourceToken: + maxLength: 64 + type: string + description: Contains a video source reference for which a video source mode is requested. + xml: + name: VideoSourceToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + VideoSourceModeToken: + maxLength: 64 + type: string + description: Indicate video source mode. + xml: + name: VideoSourceModeToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoSourceMode + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetVideoSourceModeResponse: + title: tns_SetVideoSourceModeResponse + required: + - Reboot + type: object + properties: + Reboot: + type: boolean + description: The response contains information about rebooting after returning response. When Reboot is set true, a device will reboot automatically after setting mode. + xml: + name: Reboot + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetVideoSourceModeResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_VideoSourceMode: + title: tns_VideoSourceMode + required: + - token + - MaxFramerate + - MaxResolution + - Encodings + - Reboot + type: object + properties: + token: + maxLength: 64 + type: string + description: Indicate token for video source mode. + xml: + name: token + prefix: tns + attribute: true + wrapped: false + Enabled: + type: 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. + xml: + name: Enabled + prefix: tns + attribute: true + wrapped: false + MaxFramerate: + type: number + description: Max frame rate in frames per second for this video source mode. + xml: + name: MaxFramerate + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + MaxResolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Max horizontal and vertical resolution for this video source mode. + xml: + name: MaxResolution + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Encodings: + type: array + items: + type: string + xml: + name: Encodings + attribute: false + wrapped: false + description: List of one or more encodings supported for this video source. For name definitions see tt:VideoEncodingMimeNames, and see + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Reboot: + type: boolean + 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. + xml: + name: Reboot + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Description: + type: string + description: Informative description of this video source mode. This field should be described in English. + xml: + name: Description + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceMode + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDs: + title: tns_GetOSDs + type: object + properties: + OSDToken: + maxLength: 64 + type: string + description: The GetOSDs command fetches the OSD configuration if the OSD token is known. + xml: + name: OSDToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the Video Source Configuration, which has OSDs associated with are requested. If token not exist, request all available OSDs. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDs + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDsResponse: + title: tns_GetOSDsResponse + type: object + properties: + OSDs: + type: array + items: + $ref: '#/components/schemas/tt_OSDConfiguration' + description: This element contains a list of requested OSDs. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetOSD: + title: tns_SetOSD + required: + - OSD + type: object + properties: + OSD: + allOf: + - $ref: '#/components/schemas/tt_OSDConfiguration' + - description: Contains the modified OSD configuration. + xml: + name: OSD + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetOSD + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDOptions: + title: tns_GetOSDOptions + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDOptions + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetOSDOptionsResponse: + title: tns_GetOSDOptionsResponse + required: + - OSDOptions + type: object + properties: + OSDOptions: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptions' + - xml: + name: OSDOptions + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetOSDOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateOSD: + title: tns_CreateOSD + required: + - OSD + type: object + properties: + OSD: + allOf: + - $ref: '#/components/schemas/tt_OSDConfiguration' + - description: Contain the initial OSD configuration for create. + xml: + name: OSD + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateOSD + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateOSDResponse: + title: tns_CreateOSDResponse + required: + - OSDToken + type: object + properties: + OSDToken: + maxLength: 64 + type: string + description: Returns Token of the newly created OSD + xml: + name: OSDToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateOSDResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteOSD: + title: tns_DeleteOSD + required: + - OSDToken + type: object + properties: + OSDToken: + maxLength: 64 + type: string + description: This element contains a reference to the OSD configuration that should be deleted. + xml: + name: OSDToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteOSD + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MaskType: + title: tns_MaskType + enum: + - Color + - Pixelated + - Blurred + type: string + description: '' + xml: + name: MaskType + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Mask: + title: tns_Mask + required: + - ConfigurationToken + - Polygon + - Type + - Enabled + type: object + properties: + token: + maxLength: 64 + type: string + description: Token of the mask. + xml: + name: token + prefix: tns + attribute: true + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Token of the VideoSourceConfiguration the Mask is associated with. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Polygon: + allOf: + - $ref: '#/components/schemas/tt_Polygon' + - description: Geometric representation of the mask area. + xml: + name: Polygon + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Type: + type: string + description: 'Type of masking as defined by tr2:MaskType:' + xml: + name: Type + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - description: Color of the masked area. + xml: + name: Color + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Enabled: + type: boolean + description: If set the mask will cover the image, otherwise it will be fully transparent. + xml: + name: Enabled + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Mask + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMasks: + title: tns_GetMasks + type: object + properties: + Token: + maxLength: 64 + type: string + description: Optional mask token of an existing mask. + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + ConfigurationToken: + maxLength: 64 + type: string + description: Optional token of a Video Source Configuration. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMasks + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMasksResponse: + title: tns_GetMasksResponse + type: object + properties: + Masks: + type: array + items: + $ref: '#/components/schemas/tns_Mask' + description: List of Mask configurations. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMasksResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetMask: + title: tns_SetMask + required: + - Mask + type: object + properties: + Mask: + allOf: + - $ref: '#/components/schemas/tns_Mask' + - description: Mask to be updated. + xml: + name: Mask + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetMask + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMaskOptions: + title: tns_GetMaskOptions + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Video Source Configuration Token that specifies an existing video source configuration that the options shall be compatible with. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMaskOptions + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MaskOptions: + title: tns_MaskOptions + required: + - MaxMasks + - MaxPoints + - Types + - Color + type: object + properties: + RectangleOnly: + type: boolean + description: Information whether the polygon must have four points and a rectangular shape. + xml: + name: RectangleOnly + prefix: tns + attribute: true + wrapped: false + SingleColorOnly: + type: 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. + xml: + name: SingleColorOnly + prefix: tns + attribute: true + wrapped: false + MaxMasks: + type: integer + description: Maximum supported number of masks per VideoSourceConfiguration. + format: int32 + xml: + name: MaxMasks + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + MaxPoints: + type: integer + description: Maximum supported number of points per mask. + format: int32 + xml: + name: MaxPoints + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Types: + type: array + items: + type: string + xml: + name: Types + attribute: false + wrapped: false + description: Information which types of tr2:MaskType are supported. Valid values are 'Color', 'Pixelated' and 'Blurred'. + xml: + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorOptions' + - description: Colors supported. + xml: + name: Color + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: MaskOptions + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetMaskOptionsResponse: + title: tns_GetMaskOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tns_MaskOptions' + - xml: + name: Options + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetMaskOptionsResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateMask: + title: tns_CreateMask + required: + - Mask + type: object + properties: + Mask: + allOf: + - $ref: '#/components/schemas/tns_Mask' + - description: Contain the initial mask configuration for create. + xml: + name: Mask + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateMask + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreateMaskResponse: + title: tns_CreateMaskResponse + required: + - Token + type: object + properties: + Token: + maxLength: 64 + type: string + description: Returns Token of the newly created Mask + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreateMaskResponse + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tns_DeleteMask: + title: tns_DeleteMask + required: + - Token + type: object + properties: + Token: + maxLength: 64 + type: string + description: This element contains a reference to the Mask configuration that should be deleted. + xml: + name: Token + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: DeleteMask + namespace: http://www.onvif.org/ver20/media/wsdl + prefix: tns + attribute: false + wrapped: false + tt_IntRange: + title: tt_IntRange + required: + - Min + - Max + type: object + properties: + Min: + type: integer + format: int32 + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: integer + format: int32 + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: IntRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector2D: + title: tt_Vector2D + required: + - x + - y + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Pan/tilt coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector2D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector1D: + title: tt_Vector1D + required: + - x + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Zoom coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector1D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZVector: + title: tt_PTZVector + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan and the y component to tilt. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom position. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZVector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatus: + title: tt_PTZStatus + required: + - UtcTime + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - 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. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: States a current PTZ error. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UtcTime: + type: string + description: Specifies the UTC time when this status was generated. + format: date-time + xml: + name: UtcTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZMoveStatus: + title: tt_PTZMoveStatus + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZMoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveStatus: + title: tt_MoveStatus + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + description: '' + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector: + title: tt_Vector + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rectangle: + title: tt_Rectangle + type: object + properties: + bottom: + type: number + xml: + name: bottom + prefix: tt + attribute: true + wrapped: false + top: + type: number + xml: + name: top + prefix: tt + attribute: true + wrapped: false + right: + type: number + xml: + name: right + prefix: tt + attribute: true + wrapped: false + left: + type: number + xml: + name: left + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Rectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polygon: + title: tt_Polygon + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polygon + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Color: + title: tt_Color + required: + - X + - Y + - Z + type: object + properties: + X: + type: number + xml: + name: X + prefix: tt + attribute: true + wrapped: false + Y: + type: number + xml: + name: Y + prefix: tt + attribute: true + wrapped: false + Z: + type: number + xml: + name: Z + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: 'Acceptable values:' + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorCovariance: + title: tt_ColorCovariance + required: + - XX + - YY + - ZZ + type: object + properties: + XX: + type: number + xml: + name: XX + prefix: tt + attribute: true + wrapped: false + YY: + type: number + xml: + name: YY + prefix: tt + attribute: true + wrapped: false + ZZ: + type: number + xml: + name: ZZ + prefix: tt + attribute: true + wrapped: false + XY: + type: number + xml: + name: XY + prefix: tt + attribute: true + wrapped: false + XZ: + type: number + xml: + name: XZ + prefix: tt + attribute: true + wrapped: false + YZ: + type: number + xml: + name: YZ + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: ColorCovariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorDescriptor: + title: tt_ColorDescriptor + type: object + properties: + ColorCluster: + type: array + items: + $ref: '#/components/schemas/tt_ColorCluster' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transformation: + title: tt_Transformation + type: object + properties: + Translate: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Translate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Scale: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Scale + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TransformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransformationExtension: + title: tt_TransformationExtension + type: object + description: '' + xml: + name: TransformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoLocation: + title: tt_GeoLocation + type: object + properties: + lon: + type: number + description: East west location as angle. + xml: + name: lon + prefix: tt + attribute: true + wrapped: false + lat: + type: number + description: North south location as angle. + xml: + name: lat + prefix: tt + attribute: true + wrapped: false + elevation: + type: number + description: Hight in meters above sea level. + xml: + name: elevation + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoOrientation: + title: tt_GeoOrientation + type: object + properties: + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + pitch: + type: number + description: Rotation around the y axis. + xml: + name: pitch + prefix: tt + attribute: true + wrapped: false + yaw: + type: number + description: Rotation around the z axis. + xml: + name: yaw + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalLocation: + title: tt_LocalLocation + type: object + properties: + x: + type: number + description: East west location as angle. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: North south location as angle. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + z: + type: number + description: Offset in meters from the sea level. + xml: + name: z + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalOrientation: + title: tt_LocalOrientation + type: object + properties: + pan: + type: number + description: Rotation around the y axis. + xml: + name: pan + prefix: tt + attribute: true + wrapped: false + tilt: + type: number + description: Rotation around the z axis. + xml: + name: tilt + prefix: tt + attribute: true + wrapped: false + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Entity: + title: tt_Entity + enum: + - Device + - VideoSource + - AudioSource + type: string + description: '' + xml: + name: Entity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocationEntity: + title: tt_LocationEntity + type: object + properties: + Entity: + type: string + description: Entity type the entry refers to, use a value from the tt:Entity enumeration. + xml: + name: Entity + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + description: Optional entity token. + xml: + name: Token + prefix: tt + attribute: true + wrapped: false + Fixed: + type: boolean + description: If this value is true the entity cannot be deleted. + xml: + name: Fixed + prefix: tt + attribute: true + wrapped: false + GeoSource: + type: string + description: Optional reference to the XAddr of another devices DeviceManagement service. + xml: + name: GeoSource + prefix: tt + attribute: true + wrapped: false + AutoGeo: + type: boolean + description: If set the geo location is obtained internally. + xml: + name: AutoGeo + prefix: tt + attribute: true + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: Location on earth. + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GeoOrientation: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Orientation relative to earth. + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalLocation: + allOf: + - $ref: '#/components/schemas/tt_LocalLocation' + - description: Indoor location offset. + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalOrientation: + allOf: + - $ref: '#/components/schemas/tt_LocalOrientation' + - description: Indoor orientation offset. + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LocationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceEntity: + title: tt_DeviceEntity + required: + - token + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier referencing the physical entity. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + description: Base class for physical entities like inputs and outputs. + xml: + name: DeviceEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangle: + title: tt_IntRectangle + required: + - x + - y + - width + - height + type: object + properties: + x: + type: integer + format: int32 + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: integer + format: int32 + xml: + name: y + prefix: tt + attribute: true + wrapped: false + width: + type: integer + format: int32 + xml: + name: width + prefix: tt + attribute: true + wrapped: false + height: + type: integer + format: int32 + xml: + name: height + prefix: tt + attribute: true + wrapped: false + description: Rectangle defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangleRange: + title: tt_IntRectangleRange + required: + - XRange + - YRange + - WidthRange + - HeightRange + type: object + properties: + XRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of X-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of Y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WidthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of width. + xml: + name: WidthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HeightRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of height. + xml: + name: HeightRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangleRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatRange: + title: tt_FloatRange + required: + - Min + - Max + type: object + properties: + Min: + type: number + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: number + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: FloatRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DurationRange: + title: tt_DurationRange + required: + - Min + - Max + type: object + properties: + Min: + type: string + format: date-time + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: string + format: date-time + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of duration greater equal Min duration and less equal Max duration. + xml: + name: DurationRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntItems: + title: tt_IntItems + type: object + properties: + Items: + type: array + items: + type: integer + format: int32 + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: List of values. + xml: + name: IntItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatItems: + title: tt_FloatItems + type: object + properties: + Items: + type: array + items: + type: number + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FloatItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StringItems: + title: tt_StringItems + required: + - Item + type: object + properties: + Item: + type: array + items: + type: string + xml: + name: Item + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StringItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnyHolder: + title: tt_AnyHolder + type: object + description: '' + xml: + name: AnyHolder + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSource: + title: tt_VideoSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Framerate + - Resolution + type: object + properties: + Framerate: + type: number + description: Frame rate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Horizontal and vertical resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings' + - description: Optional configuration of the image sensor. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video input. + tt_VideoSourceExtension: + title: tt_VideoSourceExtension + type: object + properties: + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if imaging service 2.00 is supported. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceExtension2: + title: tt_VideoSourceExtension2 + type: object + description: '' + xml: + name: VideoSourceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSource: + title: tt_AudioSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Channels + type: object + properties: + Channels: + type: integer + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + xml: + name: Channels + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio input. + tt_Profile: + title: tt_Profile + required: + - token + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of the profile. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: A value of true signals that the profile cannot be deleted. Default is false. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and rule engine. + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + A media profile consists of a set of media configurations. Media profiles are used by a client + to configure properties of a media stream from an NVT. + xml: + name: Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension: + title: tt_ProfileExtension + type: object + properties: + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension2: + title: tt_ProfileExtension2 + type: object + description: '' + xml: + name: ProfileExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfiguration: + title: tt_VideoSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + - Bounds + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Reference to the physical input. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bounds: + allOf: + - $ref: '#/components/schemas/tt_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area. + xml: + name: Bounds + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ViewMode: + type: string + description: Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes. + xml: + name: ViewMode + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioSourceConfiguration: + title: tt_AudioSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Token of the Audio Source the configuration applies to + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncoderConfiguration: + title: tt_VideoEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Configuration' + - description: Optional element to configure H.264 related parameters. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related video stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoderConfiguration: + title: tt_AudioEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoAnalyticsConfiguration: + title: tt_VideoAnalyticsConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfiguration' + - xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZConfiguration: + title: tt_PTZConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - NodeToken + type: object + properties: + NodeToken: + maxLength: 64 + type: string + description: A mandatory reference to the PTZ Node that the PTZ Configuration belongs to. + xml: + name: NodeToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsolutePantTiltPositionSpace: + type: string + description: If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default. + xml: + name: DefaultAbsolutePantTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsoluteZoomPositionSpace: + type: string + description: If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default. + xml: + name: DefaultAbsoluteZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativePanTiltTranslationSpace: + type: string + description: If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default. + xml: + name: DefaultRelativePanTiltTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativeZoomTranslationSpace: + type: string + description: If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default. + xml: + name: DefaultRelativeZoomTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousPanTiltVelocitySpace: + type: string + description: If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default. + xml: + name: DefaultContinuousPanTiltVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousZoomVelocitySpace: + type: string + description: If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default. + xml: + name: DefaultContinuousZoomVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds. + xml: + name: DefaultPTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZTimeout: + type: string + description: If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops. + format: date-time + xml: + name: DefaultPTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/tt_PanTiltLimits' + - 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. + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomLimits: + allOf: + - $ref: '#/components/schemas/tt_ZoomLimits' + - 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. + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveRamp: + type: integer + description: The optional acceleration ramp used by the device when moving. + format: int32 + xml: + name: MoveRamp + prefix: tt + attribute: true + wrapped: false + PresetRamp: + type: integer + description: The optional acceleration ramp used by the device when recalling presets. + format: int32 + xml: + name: PresetRamp + prefix: tt + attribute: true + wrapped: false + PresetTourRamp: + type: integer + description: The optional acceleration ramp used by the device when executing PresetTours. + format: int32 + xml: + name: PresetTourRamp + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_MetadataConfiguration: + title: tt_MetadataConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Multicast + - SessionTimeout + type: object + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZFilter' + - description: optional element to configure which PTZ related data is to include in the metadata stream + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventSubscription' + - description: "Optional element to configure the streaming of events. A client might be interested in receiving all, \n none or some of the events produced by the device:" + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Analytics: + type: boolean + description: Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.) + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored) + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - description: >- + Indication which AnalyticsModules shall output metadata. + Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration. + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CompressionType: + type: string + description: Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType. + xml: + name: CompressionType + prefix: tt + attribute: true + wrapped: false + GeoLocation: + type: boolean + description: Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + ShapePolygon: + type: boolean + description: Optional parameter to configure if the generated metadata stream should contain shape information as polygon. + xml: + name: ShapePolygon + prefix: tt + attribute: true + wrapped: false + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioOutputConfiguration: + title: tt_AudioOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + - OutputLevel + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the phsycial Audio output. + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacy: + type: string + description: >- + An audio channel MAY support different types of audio transmission. While for full duplex + operation no special handling is required, in half duplex operation the transmission direction + needs to be switched. + The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which + direction is currently active. An NVC can switch between different modes by setting the + AudioOutputConfiguration. + xml: + name: SendPrimacy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevel: + type: integer + description: Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange. + format: int32 + xml: + name: OutputLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioDecoderConfiguration: + title: tt_AudioDecoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - type: object + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The Audio Decoder Configuration does not contain any that parameter to configure the + + decoding .A decoder shall decode every data it receives (according to its capabilities). + tt_ConfigurationEntity: + title: tt_ConfigurationEntity + required: + - token + - Name + - UseCount + type: object + properties: + token: + maxLength: 64 + type: string + description: Token that uniquely references this configuration. Length up to 64 characters. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name. Length up to 64 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseCount: + type: integer + description: Number of internal references currently using this configuration. + format: int32 + xml: + name: UseCount + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Base type defining the common properties of a configuration. + xml: + name: ConfigurationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension: + title: tt_VideoSourceConfigurationExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_Rotate' + - description: >- + Optional element to configure rotation of captured image. + What resolutions a device supports shall be unaffected by the Rotate parameters. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension2: + title: tt_VideoSourceConfigurationExtension2 + type: object + properties: + LensDescription: + type: array + items: + $ref: '#/components/schemas/tt_LensDescription' + description: Optional element describing the geometric lens distortion. Multiple instances for future variable lens support. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneOrientation: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientation' + - description: Optional element describing the scene orientation in the camera’s field of view. + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rotate: + title: tt_Rotate + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RotateMode' + - description: Parameter to enable/disable Rotation feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Degree: + type: integer + 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. + format: int32 + xml: + name: Degree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateExtension: + title: tt_RotateExtension + type: object + description: '' + xml: + name: RotateExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateMode: + title: tt_RotateMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: RotateMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensProjection: + title: tt_LensProjection + required: + - Angle + - Radius + type: object + properties: + Angle: + type: number + description: Angle of incidence. + xml: + name: Angle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Radius: + type: number + description: Mapping radius as a consequence of the emergent angle. + xml: + name: Radius + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transmittance: + type: number + description: Optional ray absorption at the given angle due to vignetting. A value of one means no absorption. + xml: + name: Transmittance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensProjection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensOffset: + title: tt_LensOffset + type: object + properties: + x: + type: number + description: Optional horizontal offset of the lens center in normalized coordinates. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: Optional vertical offset of the lens center in normalized coordinates. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LensOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensDescription: + title: tt_LensDescription + required: + - Offset + - Projection + - XFactor + type: object + properties: + FocalLength: + type: number + description: Optional focal length of the optical system. + xml: + name: FocalLength + prefix: tt + attribute: true + wrapped: false + Offset: + allOf: + - $ref: '#/components/schemas/tt_LensOffset' + - description: Offset of the lens center to the imager center in normalized coordinates. + xml: + name: Offset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Projection: + type: array + items: + $ref: '#/components/schemas/tt_LensProjection' + description: "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation \n over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. \n Items outside the last projection Radius shall be assumed to be invisible (black)." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XFactor: + type: number + description: Compensation of the x coordinate needed for the ONVIF normalized coordinate system. + xml: + name: XFactor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptions: + title: tt_VideoSourceConfigurationOptions + required: + - BoundsRange + - VideoSourceTokensAvailable + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tt + attribute: true + wrapped: false + BoundsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRectangleRange' + - description: >- + Supported range for the capturing area. + Device that does not support cropped streaming shall express BoundsRange option as mentioned below + BoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits. + xml: + name: BoundsRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: VideoSourceTokensAvailable + attribute: false + wrapped: false + description: List of physical inputs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension: + title: tt_VideoSourceConfigurationOptionsExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_RotateOptions' + - description: Options of parameters for Rotation feature. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension2: + title: tt_VideoSourceConfigurationOptionsExtension2 + type: object + properties: + SceneOrientationMode: + type: array + items: + $ref: '#/components/schemas/tt_SceneOrientationMode' + description: Scene orientation modes supported by the device for this configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptions: + title: tt_RotateOptions + required: + - Mode + type: object + properties: + Reboot: + type: boolean + description: >- + After setting the rotation, if a device starts to reboot this value is true. + If a device can handle rotation setting without rebooting this value is false. + xml: + name: Reboot + prefix: tt + attribute: true + wrapped: false + Mode: + type: array + items: + $ref: '#/components/schemas/tt_RotateMode' + description: Supported options of Rotate mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DegreeList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported degree value for rotation. + xml: + name: DegreeList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RotateOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptionsExtension: + title: tt_RotateOptionsExtension + type: object + description: '' + xml: + name: RotateOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationMode: + title: tt_SceneOrientationMode + enum: + - MANUAL + - AUTO + type: string + description: '' + xml: + name: SceneOrientationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationOption: + title: tt_SceneOrientationOption + enum: + - Below + - Horizon + - Above + type: string + description: Defines the acceptable values for the Orientation element of the SceneOrientation type + xml: + name: SceneOrientationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientation: + title: tt_SceneOrientation + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene orientation. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Orientation: + type: string + description: "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field \n is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required \n and the device will return an InvalidArgs fault if missing." + xml: + name: Orientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ViewModes: + title: tt_ViewModes + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + type: string + description: Source view modes supported by device. + xml: + name: ViewModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoding: + title: tt_VideoEncoding + enum: + - JPEG + - MPEG4 + - H264 + type: string + description: '' + xml: + name: VideoEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Profile: + title: tt_Mpeg4Profile + enum: + - SP + - ASP + type: string + description: '' + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Profile: + title: tt_H264Profile + enum: + - Baseline + - Main + - Extended + - High + type: string + description: '' + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoResolution: + title: tt_VideoResolution + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl: + title: tt_VideoRateControl + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + type: object + properties: + FrameRateLimit: + type: integer + description: Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor. + format: int32 + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingInterval: + type: integer + 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 ...) + format: int32 + xml: + name: EncodingInterval + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Configuration: + title: tt_Mpeg4Configuration + required: + - GovLength + - Mpeg4Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP) + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Configuration: + title: tt_H264Configuration + required: + - GovLength + - H264Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264Profile: + allOf: + - $ref: '#/components/schemas/tt_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderConfigurationOptions: + title: tt_VideoEncoderConfigurationOptions + required: + - QualityRange + type: object + properties: + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension element). + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension element). + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension element). + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension: + title: tt_VideoEncoderOptionsExtension + type: object + properties: + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options2' + - description: Optional H.264 encoder settings ranges. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension2: + title: tt_VideoEncoderOptionsExtension2 + type: object + description: '' + xml: + name: VideoEncoderOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions: + title: tt_JpegOptions + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions2: + title: tt_JpegOptions2 + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: JpegOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_Mpeg4Options: + title: tt_Mpeg4Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported MPEG-4 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Options2: + title: tt_Mpeg4Options2 + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Mpeg4Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_H264Options: + title: tt_H264Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H.264 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Options2: + title: tt_H264Options2 + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: H264Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncodingMimeNames: + title: tt_VideoEncodingMimeNames + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + type: string + description: Video Media Subtypes as referenced by IANA (without the leading "video/" Video Media Type). See also + xml: + name: VideoEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncodingProfiles: + title: tt_VideoEncodingProfiles + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + type: string + description: '' + xml: + name: VideoEncodingProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2Configuration: + title: tt_VideoEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + type: object + properties: + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution2' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + prefix: tt + attribute: true + wrapped: false + Profile: + type: string + description: The encoder profile as defined in tt:VideoEncodingProfiles. + xml: + name: Profile + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoResolution2: + title: tt_VideoResolution2 + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl2: + title: tt_VideoRateControl2 + required: + - FrameRateLimit + - BitrateLimit + type: object + properties: + ConstantBitRate: + type: boolean + description: Enforce constant bitrate. + xml: + name: ConstantBitRate + prefix: tt + attribute: true + wrapped: false + FrameRateLimit: + type: number + description: Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations. + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2ConfigurationOptions: + title: tt_VideoEncoder2ConfigurationOptions + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + type: object + properties: + GovLengthRange: + type: integer + 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. + format: int32 + xml: + name: GovLengthRange + prefix: tt + attribute: true + wrapped: false + FrameRatesSupported: + type: number + description: List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first. + xml: + name: FrameRatesSupported + prefix: tt + attribute: true + wrapped: false + ProfilesSupported: + type: string + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + xml: + name: ProfilesSupported + prefix: tt + attribute: true + wrapped: false + ConstantBitRateSupported: + type: boolean + description: Signal whether enforcing constant bitrate is supported. + xml: + name: ConstantBitRateSupported + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution2' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceConfigurationOptions: + title: tt_AudioSourceConfigurationOptions + required: + - InputTokensAvailable + type: object + properties: + InputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the audio source the configuration can be used for. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceOptionsExtension: + title: tt_AudioSourceOptionsExtension + type: object + description: '' + xml: + name: AudioSourceOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoding: + title: tt_AudioEncoding + enum: + - G711 + - G726 + - AAC + type: string + description: '' + xml: + name: AudioEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOptions: + title: tt_AudioEncoderConfigurationOptions + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfigurationOption' + description: list of supported AudioEncoderConfigurations + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOption: + title: tt_AudioEncoderConfigurationOption + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncodingMimeNames: + title: tt_AudioEncodingMimeNames + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + type: string + description: Audio Media Subtypes as referenced by IANA (without the leading "audio/" Audio Media Type and except for the audio types defined in the restriction). See also + xml: + name: AudioEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoder2Configuration: + title: tt_AudioEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoder2ConfigurationOptions: + title: tt_AudioEncoder2ConfigurationOptions + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationExtension: + title: tt_MetadataConfigurationExtension + type: object + description: '' + xml: + name: MetadataConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZFilter: + title: tt_PTZFilter + required: + - Status + - Position + type: object + properties: + Status: + type: boolean + description: True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN) + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + type: boolean + description: True if the metadata stream shall contain the PTZ position + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventSubscription: + title: tt_EventSubscription + type: object + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Subcription handling in the same way as base notification subscription. + xml: + name: EventSubscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptions: + title: tt_MetadataConfigurationOptions + required: + - PTZStatusFilterOptions + type: object + properties: + GeoLocation: + type: boolean + description: True if the device is able to stream the Geo Located positions of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + MaxContentFilterSize: + type: integer + description: A device signalling support for content filtering shall support expressions with the provided expression size. + format: int32 + xml: + name: MaxContentFilterSize + prefix: tt + attribute: true + wrapped: false + PTZStatusFilterOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptions' + - xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension: + title: tt_MetadataConfigurationOptionsExtension + type: object + properties: + CompressionType: + type: array + items: + type: string + xml: + name: CompressionType + attribute: false + wrapped: false + description: List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension2: + title: tt_MetadataConfigurationOptionsExtension2 + type: object + description: '' + xml: + name: MetadataConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataCompressionType: + title: tt_MetadataCompressionType + enum: + - None + - GZIP + - EXI + type: string + description: '' + xml: + name: MetadataCompressionType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptions: + title: tt_PTZStatusFilterOptions + required: + - PanTiltStatusSupported + - ZoomStatusSupported + type: object + properties: + PanTiltStatusSupported: + type: boolean + description: True if the device is able to stream pan or tilt status information. + xml: + name: PanTiltStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomStatusSupported: + type: boolean + description: True if the device is able to stream zoom status inforamtion. + xml: + name: ZoomStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSupported: + type: boolean + description: True if the device is able to stream the pan or tilt position. + xml: + name: PanTiltPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSupported: + type: boolean + description: True if the device is able to stream zoom position information. + xml: + name: ZoomPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptionsExtension: + title: tt_PTZStatusFilterOptionsExtension + type: object + description: '' + xml: + name: PTZStatusFilterOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutput: + title: tt_VideoOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Layout + type: object + properties: + Layout: + allOf: + - $ref: '#/components/schemas/tt_Layout' + - xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Resolution of the display in Pixel. + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RefreshRate: + type: number + description: Refresh rate of the display in Hertz. + xml: + name: RefreshRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AspectRatio: + type: number + description: Aspect ratio of the display as physical extent of width divided by height. + xml: + name: AspectRatio + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoOutputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video outputs. + tt_VideoOutputExtension: + title: tt_VideoOutputExtension + type: object + description: '' + xml: + name: VideoOutputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutputConfiguration: + title: tt_VideoOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the Video Output the configuration applies to + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoOutputConfigurationOptions: + title: tt_VideoOutputConfigurationOptions + type: object + description: '' + xml: + name: VideoOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptions: + title: tt_VideoDecoderConfigurationOptions + type: object + properties: + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/tt_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element describes the supported codecs and configurations + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264DecOptions: + allOf: + - $ref: '#/components/schemas/tt_H264DecOptions' + - description: If the device is able to decode H.264 streams this element describes the supported codecs and configurations + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264DecOptions: + title: tt_H264DecOptions + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported H.264 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedH264Profiles: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H264 Profiles (either baseline, main, extended or high) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegDecOptions: + title: tt_JpegDecOptions + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Jpeg Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4DecOptions: + title: tt_Mpeg4DecOptions + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Mpeg4 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedMpeg4Profiles: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported Mpeg4 Profiles (either SP or ASP) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptionsExtension: + title: tt_VideoDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: VideoDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioOutput: + title: tt_AudioOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + xml: + name: AudioOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio outputs. + tt_AudioOutputConfigurationOptions: + title: tt_AudioOutputConfigurationOptions + required: + - OutputTokensAvailable + - OutputLevelRange + type: object + properties: + OutputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: OutputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the physical Audio outputs (typically one). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacyOptions: + type: array + items: + type: string + xml: + name: SendPrimacyOptions + attribute: false + wrapped: false + description: An + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Minimum and maximum level range supported for this Output. + xml: + name: OutputLevelRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptions: + title: tt_AudioDecoderConfigurationOptions + type: object + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/tt_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section describes the supported configurations + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G711DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section describes the supported configurations + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G726DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section describes the supported configurations + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G711DecOptions: + title: tt_G711DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AACDecOptions: + title: tt_AACDecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G726DecOptions: + title: tt_G726DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptionsExtension: + title: tt_AudioDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: AudioDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MulticastConfiguration: + title: tt_MulticastConfiguration + required: + - Address + - Port + - TTL + - AutoStart + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/tt_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast streaming is enaled) + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: integer + description: The RTP mutlicast 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. + format: int32 + xml: + name: Port + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: integer + 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. + format: int32 + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Read only property signalling that streaming is persistant. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MulticastConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamSetup: + title: tt_StreamSetup + required: + - Stream + - Transport + type: object + properties: + Stream: + allOf: + - $ref: '#/components/schemas/tt_StreamType' + - description: Defines if a multicast or unicast stream is requested + xml: + name: Stream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transport: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamType: + title: tt_StreamType + enum: + - RTP-Unicast + - RTP-Multicast + type: string + description: '' + xml: + name: StreamType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transport: + title: tt_Transport + required: + - Protocol + type: object + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/tt_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + xml: + name: Protocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tunnel: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - description: Optional element to describe further tunnel options. This element is normally not needed + xml: + name: Tunnel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransportProtocol: + title: tt_TransportProtocol + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + description: '' + xml: + name: TransportProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaUri: + title: tt_MediaUri + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting the media stream + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterConnect: + type: boolean + description: Indicates if the Uri is only valid until the connection is established. The value shall be set to "false". + xml: + name: InvalidAfterConnect + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterReboot: + type: boolean + description: Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false". + xml: + name: InvalidAfterReboot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Timeout: + type: string + 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 + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ScopeDefinition: + title: tt_ScopeDefinition + enum: + - Fixed + - Configurable + type: string + description: '' + xml: + name: ScopeDefinition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Scope: + title: tt_Scope + required: + - ScopeDef + - ScopeItem + type: object + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/tt_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + xml: + name: ScopeDef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScopeItem: + type: string + description: Scope item URI. + xml: + name: ScopeItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Scope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DiscoveryMode: + title: tt_DiscoveryMode + enum: + - Discoverable + - NonDiscoverable + type: string + description: '' + xml: + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterface: + title: tt_NetworkInterface + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Info: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceInfo' + - description: Network interface information + xml: + name: Info + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceLink' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_NetworkInterfaceExtension: + title: tt_NetworkInterfaceExtension + required: + - InterfaceType + type: object + properties: + InterfaceType: + type: integer + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: Extension point prepared for future 802.3 configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot3Configuration: + title: tt_Dot3Configuration + type: object + description: '' + xml: + name: Dot3Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceExtension2: + title: tt_NetworkInterfaceExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceLink: + title: tt_NetworkInterfaceLink + required: + - AdminSettings + - OperSettings + - InterfaceType + type: object + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + xml: + name: AdminSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OperSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + xml: + name: OperSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InterfaceType: + type: integer + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceLink + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceConnectionSetting: + title: tt_NetworkInterfaceConnectionSetting + required: + - AutoNegotiation + - Speed + - Duplex + type: object + properties: + AutoNegotiation: + type: boolean + description: Auto negotiation on/off. + xml: + name: AutoNegotiation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: integer + description: Speed. + format: int32 + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Duplex: + allOf: + - $ref: '#/components/schemas/tt_Duplex' + - description: Duplex type, Half or Full. + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceConnectionSetting + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Duplex: + title: tt_Duplex + enum: + - Full + - Half + type: string + description: '' + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceInfo: + title: tt_NetworkInterfaceInfo + required: + - HwAddress + type: object + properties: + Name: + type: string + description: Network interface name, for example eth0. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HwAddress: + type: string + description: Network interface MAC address. + xml: + name: HwAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterface: + title: tt_IPv6NetworkInterface + required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv6Configuration' + - description: IPv6 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterface: + title: tt_IPv4NetworkInterface + required: + - Enabled + - Config + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv4Configuration' + - description: IPv4 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4Configuration: + title: tt_IPv4Configuration + required: + - DHCP + type: object + properties: + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: Link local address. + xml: + name: LinkLocal + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6Configuration: + title: tt_IPv6Configuration + required: + - DHCP + type: object + properties: + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually entered IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of link local IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromRA: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using router advertisment. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPv6ConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6ConfigurationExtension: + title: tt_IPv6ConfigurationExtension + type: object + description: '' + xml: + name: IPv6ConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6DHCPConfiguration: + title: tt_IPv6DHCPConfiguration + enum: + - Auto + - Stateful + - Stateless + - Off + type: string + description: '' + xml: + name: IPv6DHCPConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocol: + title: tt_NetworkProtocol + required: + - Name + - Enabled + - Port + type: object + properties: + Name: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolType' + - description: Network protocol type string. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates if the protocol is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: array + items: + type: integer + format: int32 + xml: + name: Port + attribute: false + wrapped: false + description: The port that is used by the protocol. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolExtension: + title: tt_NetworkProtocolExtension + type: object + description: '' + xml: + name: NetworkProtocolExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolType: + title: tt_NetworkProtocolType + enum: + - HTTP + - HTTPS + - RTSP + type: string + description: '' + xml: + name: NetworkProtocolType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostType: + title: tt_NetworkHostType + enum: + - IPv4 + - IPv6 + - DNS + type: string + description: '' + xml: + name: NetworkHostType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHost: + title: tt_NetworkHost + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address. + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSname: + type: string + description: DNS name. + xml: + name: DNSname + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkHost + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostExtension: + title: tt_NetworkHostExtension + type: object + description: '' + xml: + name: NetworkHostExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddress: + title: tt_IPAddress + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv4Address: + title: tt_PrefixedIPv4Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv4 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv6Address: + title: tt_PrefixedIPv6Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv6 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPType: + title: tt_IPType + enum: + - IPv4 + - IPv6 + type: string + description: '' + xml: + name: IPType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformation: + title: tt_HostnameInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether the hostname is obtained from DHCP or not. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: Indicates the hostname. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: HostnameInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformationExtension: + title: tt_HostnameInformationExtension + type: object + description: '' + xml: + name: HostnameInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformation: + title: tt_DNSInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether or not DNS information is retrieved from DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SearchDomain: + type: array + items: + type: string + xml: + name: SearchDomain + attribute: false + wrapped: false + description: Search domain. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of DNS addresses received from DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSManual: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of manually entered DNS addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformationExtension: + title: tt_DNSInformationExtension + type: object + description: '' + xml: + name: DNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformation: + title: tt_NTPInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates if NTP information is to be retrieved by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of NTP addresses retrieved by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPManual: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of manually entered NTP addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NTPInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NTPInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformationExtension: + title: tt_NTPInformationExtension + type: object + description: '' + xml: + name: NTPInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterType: + title: tt_IPAddressFilterType + enum: + - Allow + - Deny + type: string + description: '' + xml: + name: IPAddressFilterType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformation: + title: tt_DynamicDNSInformation + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: DNS name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: string + description: Time to live. + format: date-time + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformationExtension: + title: tt_DynamicDNSInformationExtension + type: object + description: '' + xml: + name: DynamicDNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSType: + title: tt_DynamicDNSType + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + type: string + description: '' + xml: + name: DynamicDNSType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfiguration: + title: tt_NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension: + title: tt_NetworkInterfaceSetConfigurationExtension + type: object + properties: + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterfaceSetConfiguration: + title: tt_IPv6NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually added IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterfaceSetConfiguration: + title: tt_IPv4NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkGateway: + title: tt_NetworkGateway + type: object + properties: + IPv4Address: + type: array + items: + type: string + xml: + name: IPv4Address + attribute: false + wrapped: false + description: IPv4 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + type: string + xml: + name: IPv6Address + attribute: false + wrapped: false + description: IPv6 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkGateway + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfiguration: + title: tt_NetworkZeroConfiguration + required: + - InterfaceToken + - Enabled + type: object + properties: + InterfaceToken: + maxLength: 64 + type: string + description: Unique identifier of network interface. + xml: + name: InterfaceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates whether the zero-configuration is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Addresses: + type: array + items: + type: string + xml: + name: Addresses + attribute: false + wrapped: false + description: The zero-configuration IPv4 address(es) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension: + title: tt_NetworkZeroConfigurationExtension + type: object + properties: + Additional: + type: array + items: + $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + description: Optional array holding the configuration for the second and possibly further interfaces. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension2: + title: tt_NetworkZeroConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkZeroConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilter: + title: tt_IPAddressFilter + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterExtension: + title: tt_IPAddressFilterExtension + type: object + description: '' + xml: + name: IPAddressFilterExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Configuration: + title: tt_Dot11Configuration + required: + - SSID + - Mode + - Alias + - Priority + - Security + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11StationMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Alias: + maxLength: 64 + type: string + xml: + name: Alias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + maximum: 31 + minimum: 0 + type: integer + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfiguration' + - xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11StationMode: + title: tt_Dot11StationMode + enum: + - Ad-hoc + - Infrastructure + - Extended + type: string + description: '' + xml: + name: Dot11StationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfiguration: + title: tt_Dot11SecurityConfiguration + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Algorithm: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: Algorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PSK: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSet' + - xml: + name: PSK + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot1X: + maxLength: 64 + type: string + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11SecurityConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfigurationExtension: + title: tt_Dot11SecurityConfigurationExtension + type: object + description: '' + xml: + name: Dot11SecurityConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityMode: + title: tt_Dot11SecurityMode + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + type: string + description: '' + xml: + name: Dot11SecurityMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Cipher: + title: tt_Dot11Cipher + enum: + - CCMP + - TKIP + - Any + - Extended + type: string + description: '' + xml: + name: Dot11Cipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSet: + title: tt_Dot11PSKSet + type: object + properties: + Key: + type: string + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex + format: binary + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Passphrase: + pattern: '[ -~]{8,63}' + type: string + description: >- + According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and + each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. + xml: + name: Passphrase + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSetExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11PSKSet + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSetExtension: + title: tt_Dot11PSKSetExtension + type: object + description: '' + xml: + name: Dot11PSKSetExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension2: + title: tt_NetworkInterfaceSetConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Capabilities: + title: tt_Dot11Capabilities + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + type: object + properties: + TKIP: + type: boolean + xml: + name: TKIP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScanAvailableNetworks: + type: boolean + xml: + name: ScanAvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MultipleConfiguration: + type: boolean + xml: + name: MultipleConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AdHocStationMode: + type: boolean + xml: + name: AdHocStationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WEP: + type: boolean + xml: + name: WEP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SignalStrength: + title: tt_Dot11SignalStrength + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + type: string + description: '' + xml: + name: Dot11SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Status: + title: tt_Dot11Status + required: + - SSID + - ActiveConfigAlias + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: PairCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: GroupCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ActiveConfigAlias: + maxLength: 64 + type: string + xml: + name: ActiveConfigAlias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AuthAndMangementSuite: + title: tt_Dot11AuthAndMangementSuite + enum: + - None + - Dot1X + - PSK + - Extended + type: string + description: '' + xml: + name: Dot11AuthAndMangementSuite + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworks: + title: tt_Dot11AvailableNetworks + required: + - SSID + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuthAndMangementSuite: + type: array + items: + $ref: '#/components/schemas/tt_Dot11AuthAndMangementSuite' + description: See IEEE802.11 7.3.2.25.2 for details. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11AvailableNetworksExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11AvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworksExtension: + title: tt_Dot11AvailableNetworksExtension + type: object + description: '' + xml: + name: Dot11AvailableNetworksExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilityCategory: + title: tt_CapabilityCategory + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + type: string + description: '' + xml: + name: CapabilityCategory + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Capabilities: + title: tt_Capabilities + type: object + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsCapabilities' + - description: Analytics capabilities + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Device: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilities' + - description: Device capabilities + xml: + name: Device + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventCapabilities' + - description: Event capabilities + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingCapabilities' + - description: Imaging capabilities + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Media: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilities' + - description: Media capabilities + xml: + name: Media + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZCapabilities' + - description: PTZ capabilities + xml: + name: PTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension: + title: tt_CapabilitiesExtension + type: object + properties: + DeviceIO: + allOf: + - $ref: '#/components/schemas/tt_DeviceIOCapabilities' + - xml: + name: DeviceIO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Display: + allOf: + - $ref: '#/components/schemas/tt_DisplayCapabilities' + - xml: + name: Display + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Recording: + allOf: + - $ref: '#/components/schemas/tt_RecordingCapabilities' + - xml: + name: Recording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Search: + allOf: + - $ref: '#/components/schemas/tt_SearchCapabilities' + - xml: + name: Search + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Replay: + allOf: + - $ref: '#/components/schemas/tt_ReplayCapabilities' + - xml: + name: Replay + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tt_ReceiverCapabilities' + - xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsDevice: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceCapabilities' + - xml: + name: AnalyticsDevice + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extensions: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension2' + - xml: + name: Extensions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension2: + title: tt_CapabilitiesExtension2 + type: object + description: '' + xml: + name: CapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsCapabilities: + title: tt_AnalyticsCapabilities + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + type: object + properties: + XAddr: + type: string + description: Analytics service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Indicates whether or not rules are supported. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleSupport: + type: boolean + description: Indicates whether or not modules are supported. + xml: + name: AnalyticsModuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilities: + title: tt_DeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Device service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilities' + - description: Network capabilities. + xml: + name: Network + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilities' + - description: System capabilities. + xml: + name: System + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IO: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilities' + - description: I/O capabilities. + xml: + name: IO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilities' + - description: Security capabilities. + xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilitiesExtension: + title: tt_DeviceCapabilitiesExtension + type: object + description: '' + xml: + name: DeviceCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventCapabilities: + title: tt_EventCapabilities + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + type: object + properties: + XAddr: + type: string + description: Event service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSSubscriptionPolicySupport: + type: boolean + description: Indicates whether or not WS Subscription policy is supported. + xml: + name: WSSubscriptionPolicySupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPullPointSupport: + type: boolean + description: Indicates whether or not WS Pull Point is supported. + xml: + name: WSPullPointSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPausableSubscriptionManagerInterfaceSupport: + type: boolean + description: Indicates whether or not WS Pausable Subscription Manager Interface is supported. + xml: + name: WSPausableSubscriptionManagerInterfaceSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EventCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilities: + title: tt_IOCapabilities + type: object + properties: + InputConnectors: + type: integer + description: Number of input connectors. + format: int32 + xml: + name: InputConnectors + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + description: Number of relay outputs. + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension: + title: tt_IOCapabilitiesExtension + required: + - Extension + type: object + properties: + Auxiliary: + type: boolean + xml: + name: Auxiliary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension2: + title: tt_IOCapabilitiesExtension2 + type: object + description: '' + xml: + name: IOCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilities: + title: tt_MediaCapabilities + required: + - XAddr + - StreamingCapabilities + type: object + properties: + XAddr: + type: string + description: Media service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilitiesExtension: + title: tt_MediaCapabilitiesExtension + required: + - ProfileCapabilities + type: object + properties: + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tt_ProfileCapabilities' + - xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilities: + title: tt_RealTimeStreamingCapabilities + type: object + properties: + RTPMulticast: + type: boolean + description: Indicates whether or not RTP multicast is supported. + xml: + name: RTPMulticast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether or not RTP over TCP is supported. + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether or not RTP/RTSP/TCP is supported. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RealTimeStreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilitiesExtension: + title: tt_RealTimeStreamingCapabilitiesExtension + type: object + description: '' + xml: + name: RealTimeStreamingCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileCapabilities: + title: tt_ProfileCapabilities + required: + - MaximumNumberOfProfiles + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilities: + title: tt_NetworkCapabilities + type: object + properties: + IPFilter: + type: boolean + description: Indicates whether or not IP filtering is supported. + xml: + name: IPFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZeroConfiguration: + type: boolean + description: Indicates whether or not zeroconf is supported. + xml: + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPVersion6: + type: boolean + description: Indicates whether or not IPv6 is supported. + xml: + name: IPVersion6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynDNS: + type: boolean + description: Indicates whether or not is supported. + xml: + name: DynDNS + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension: + title: tt_NetworkCapabilitiesExtension + type: object + properties: + Dot11Configuration: + type: boolean + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension2: + title: tt_NetworkCapabilitiesExtension2 + type: object + description: '' + xml: + name: NetworkCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilities: + title: tt_SecurityCapabilities + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + type: object + properties: + TLS1.1: + type: boolean + description: Indicates whether or not TLS 1.1 is supported. + xml: + name: TLS1.1 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TLS1.2: + type: boolean + description: Indicates whether or not TLS 1.2 is supported. + xml: + name: TLS1.2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OnboardKeyGeneration: + type: boolean + description: Indicates whether or not onboard key generation is supported. + xml: + name: OnboardKeyGeneration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AccessPolicyConfig: + type: boolean + description: Indicates whether or not access policy configuration is supported. + xml: + name: AccessPolicyConfig + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + X.509Token: + type: boolean + description: Indicates whether or not WS-Security X.509 token is supported. + xml: + name: X.509Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SAMLToken: + type: boolean + description: Indicates whether or not WS-Security SAML token is supported. + xml: + name: SAMLToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KerberosToken: + type: boolean + description: Indicates whether or not WS-Security Kerberos token is supported. + xml: + name: KerberosToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RELToken: + type: boolean + description: Indicates whether or not WS-Security REL token is supported. + xml: + name: RELToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension: + title: tt_SecurityCapabilitiesExtension + required: + - TLS1.0 + type: object + properties: + TLS1.0: + type: boolean + xml: + name: TLS1.0 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension2: + title: tt_SecurityCapabilitiesExtension2 + required: + - Dot1X + - RemoteUserHandling + type: object + properties: + Dot1X: + type: boolean + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedEAPMethod: + type: array + items: + type: integer + format: int32 + xml: + name: SupportedEAPMethod + attribute: false + wrapped: false + description: EAP Methods supported by the device. The int values refer to the + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteUserHandling: + type: boolean + xml: + name: RemoteUserHandling + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilities: + title: tt_SystemCapabilities + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + type: object + properties: + DiscoveryResolve: + type: boolean + description: Indicates whether or not WS Discovery resolve requests are supported. + xml: + name: DiscoveryResolve + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DiscoveryBye: + type: boolean + description: Indicates whether or not WS-Discovery Bye is supported. + xml: + name: DiscoveryBye + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteDiscovery: + type: boolean + description: Indicates whether or not remote discovery is supported. + xml: + name: RemoteDiscovery + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemBackup: + type: boolean + description: Indicates whether or not system backup is supported. + xml: + name: SystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemLogging: + type: boolean + description: Indicates whether or not system logging is supported. + xml: + name: SystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FirmwareUpgrade: + type: boolean + description: Indicates whether or not firmware upgrade is supported. + xml: + name: FirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedVersions: + type: array + items: + $ref: '#/components/schemas/tt_OnvifVersion' + description: Indicates supported ONVIF version(s). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension: + title: tt_SystemCapabilitiesExtension + type: object + properties: + HttpFirmwareUpgrade: + type: boolean + xml: + name: HttpFirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemBackup: + type: boolean + xml: + name: HttpSystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemLogging: + type: boolean + xml: + name: HttpSystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSupportInformation: + type: boolean + xml: + name: HttpSupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension2: + title: tt_SystemCapabilitiesExtension2 + type: object + description: '' + xml: + name: SystemCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OnvifVersion: + title: tt_OnvifVersion + required: + - Major + - Minor + type: object + properties: + Major: + type: integer + description: Major version number. + format: int32 + xml: + name: Major + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minor: + type: integer + description: >- + Two digit minor version number. + If 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. + Otherwise, minor number is month of release, such as "06" for June. + format: int32 + xml: + name: Minor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OnvifVersion + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingCapabilities: + title: tt_ImagingCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Imaging service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZCapabilities: + title: tt_PTZCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: PTZ service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceIOCapabilities: + title: tt_DeviceIOCapabilities + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSources: + type: integer + format: int32 + xml: + name: VideoSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoOutputs: + type: integer + format: int32 + xml: + name: VideoOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSources: + type: integer + format: int32 + xml: + name: AudioSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputs: + type: integer + format: int32 + xml: + name: AudioOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceIOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DisplayCapabilities: + title: tt_DisplayCapabilities + required: + - XAddr + - FixedLayout + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedLayout: + type: boolean + description: Indication that the SetLayout command supports only predefined layouts. + xml: + name: FixedLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DisplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingCapabilities: + title: tt_RecordingCapabilities + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverSource: + type: boolean + xml: + name: ReceiverSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaProfileSource: + type: boolean + xml: + name: MediaProfileSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicRecordings: + type: boolean + xml: + name: DynamicRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicTracks: + type: boolean + xml: + name: DynamicTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxStringLength: + type: integer + format: int32 + xml: + name: MaxStringLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchCapabilities: + title: tt_SearchCapabilities + required: + - XAddr + - MetadataSearch + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataSearch: + type: boolean + xml: + name: MetadataSearch + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SearchCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayCapabilities: + title: tt_ReplayCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: The address of the replay service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverCapabilities: + title: tt_ReceiverCapabilities + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + type: object + properties: + XAddr: + type: string + description: The address of the receiver service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_Multicast: + type: boolean + description: Indicates whether the device can receive RTP multicast streams. + xml: + name: RTP_Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/TCP streams + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedReceivers: + type: integer + description: The maximum number of receivers supported by the device. + format: int32 + xml: + name: SupportedReceivers + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRTSPURILength: + type: integer + description: The maximum allowed length for RTSP URIs. + format: int32 + xml: + name: MaximumRTSPURILength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReceiverCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceCapabilities: + title: tt_AnalyticsDeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Obsolete property. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceExtension: + title: tt_AnalyticsDeviceExtension + type: object + description: '' + xml: + name: AnalyticsDeviceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogType: + title: tt_SystemLogType + enum: + - System + - Access + type: string + description: Enumeration describing the available system log modes. + xml: + name: SystemLogType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLog: + title: tt_SystemLog + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The log information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The log information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLog + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportInformation: + title: tt_SupportInformation + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The support information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The support information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BinaryData: + title: tt_BinaryData + required: + - Data + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Data: + type: string + description: base64 encoded binary data. + format: binary + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BinaryData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AttachmentData: + title: tt_AttachmentData + required: + - Include + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Include: + allOf: + - $ref: '#/components/schemas/xop_Include' + - xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + description: '' + xml: + name: AttachmentData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BackupFile: + title: tt_BackupFile + required: + - Name + - Data + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BackupFile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUriList: + title: tt_SystemLogUriList + type: object + properties: + SystemLog: + type: array + items: + $ref: '#/components/schemas/tt_SystemLogUri' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUriList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUri: + title: tt_SystemLogUri + required: + - Type + - Uri + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Uri: + type: string + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FactoryDefaultType: + title: tt_FactoryDefaultType + enum: + - Hard + - Soft + type: string + description: Enumeration describing the available factory default modes. + xml: + name: FactoryDefaultType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SetDateTimeType: + title: tt_SetDateTimeType + enum: + - Manual + - NTP + type: string + description: '' + xml: + name: SetDateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTime: + title: tt_SystemDateTime + required: + - DateTimeType + - DaylightSavings + type: object + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + xml: + name: DateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DaylightSavings: + type: boolean + description: Informative indicator whether daylight savings is currently on/off. + xml: + name: DaylightSavings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: Timezone information in Posix format. + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Current system date and time in UTC format. This field is mandatory since version 2.0. + xml: + name: UTCDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in local format. + xml: + name: LocalDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTimeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: General date time inforamtion returned by the GetSystemDateTime method. + xml: + name: SystemDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTimeExtension: + title: tt_SystemDateTimeExtension + type: object + description: '' + xml: + name: SystemDateTimeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTime: + title: tt_DateTime + required: + - Time + - Date + type: object + properties: + Time: + allOf: + - $ref: '#/components/schemas/tt_Time' + - xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Date: + allOf: + - $ref: '#/components/schemas/tt_Date' + - xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Date: + title: tt_Date + required: + - Year + - Month + - Day + type: object + properties: + Year: + type: integer + format: int32 + xml: + name: Year + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Month: + type: integer + description: Range is 1 to 12. + format: int32 + xml: + name: Month + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Day: + type: integer + description: Range is 1 to 31. + format: int32 + xml: + name: Day + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Time: + title: tt_Time + required: + - Hour + - Minute + - Second + type: object + properties: + Hour: + type: integer + description: Range is 0 to 23. + format: int32 + xml: + name: Hour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minute: + type: integer + description: Range is 0 to 59. + format: int32 + xml: + name: Minute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Second: + type: integer + description: Range is 0 to 61 (typically 59). + format: int32 + xml: + name: Second + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TimeZone: + title: tt_TimeZone + required: + - TZ + type: object + properties: + TZ: + type: string + description: Posix timezone string. + xml: + name: TZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3 + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RemoteUser: + title: tt_RemoteUser + required: + - Username + - UseDerivedPassword + type: object + properties: + Username: + type: string + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseDerivedPassword: + type: boolean + xml: + name: UseDerivedPassword + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RemoteUser + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserLevel: + title: tt_UserLevel + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + description: '' + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_User: + title: tt_User + required: + - Username + - UserLevel + type: object + properties: + Username: + type: string + description: Username string. + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password string. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UserLevel: + allOf: + - $ref: '#/components/schemas/tt_UserLevel' + - description: User level string. + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_UserExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: User + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserExtension: + title: tt_UserExtension + type: object + description: '' + xml: + name: UserExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParameters: + title: tt_CertificateGenerationParameters + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subject: + type: string + xml: + name: Subject + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotBefore: + type: string + xml: + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotAfter: + type: string + xml: + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateGenerationParametersExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateGenerationParameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParametersExtension: + title: tt_CertificateGenerationParametersExtension + type: object + description: '' + xml: + name: CertificateGenerationParametersExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Certificate: + title: tt_Certificate + required: + - CertificateID + - Certificate + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateStatus: + title: tt_CertificateStatus + required: + - CertificateID + - Status + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + type: boolean + description: Indicates whether or not a certificate is used in a HTTPS configuration. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateWithPrivateKey: + title: tt_CertificateWithPrivateKey + required: + - Certificate + - PrivateKey + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrivateKey: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: PrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformation: + title: tt_CertificateInformation + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IssuerDN: + type: string + xml: + name: IssuerDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubjectDN: + type: string + xml: + name: SubjectDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: KeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExtendedKeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: ExtendedKeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyLength: + type: integer + format: int32 + xml: + name: KeyLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Version: + type: string + xml: + name: Version + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SerialNum: + type: string + xml: + name: SerialNum + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignatureAlgorithm: + type: string + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding DateTimeRange is from "From" to "Until" + xml: + name: SignatureAlgorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Validity: + allOf: + - $ref: '#/components/schemas/tt_DateTimeRange' + - xml: + name: Validity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateUsage: + title: tt_CertificateUsage + required: + - Critical + type: object + properties: + Critical: + type: boolean + xml: + name: Critical + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: CertificateUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformationExtension: + title: tt_CertificateInformationExtension + type: object + description: '' + xml: + name: CertificateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfiguration: + title: tt_Dot1XConfiguration + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + type: object + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Identity: + type: string + xml: + name: Identity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnonymousID: + type: string + xml: + name: AnonymousID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethod: + type: integer + description: EAP Method type as defined in + format: int32 + xml: + name: EAPMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CACertificateID: + type: array + items: + type: string + xml: + name: CACertificateID + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethodConfiguration: + allOf: + - $ref: '#/components/schemas/tt_EAPMethodConfiguration' + - xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfigurationExtension: + title: tt_Dot1XConfigurationExtension + type: object + description: '' + xml: + name: Dot1XConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EAPMethodConfiguration: + title: tt_EAPMethodConfiguration + type: object + properties: + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/tt_TLSConfiguration' + - description: Confgiuration information for TLS Method. + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password for those EAP Methods that require a password. The password shall never be returned on a get method. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EapMethodExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EapMethodExtension: + title: tt_EapMethodExtension + type: object + description: '' + xml: + name: EapMethodExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TLSConfiguration: + title: tt_TLSConfiguration + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GenericEapPwdConfigurationExtension: + title: tt_GenericEapPwdConfigurationExtension + type: object + description: '' + xml: + name: GenericEapPwdConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayLogicalState: + title: tt_RelayLogicalState + enum: + - active + - inactive + type: string + description: '' + xml: + name: RelayLogicalState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayIdleState: + title: tt_RelayIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: RelayIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutputSettings: + title: tt_RelayOutputSettings + required: + - Mode + - DelayTime + - IdleState + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RelayMode' + - description: "'Bistable' or 'Monostable'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DelayTime: + type: string + 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. + format: date-time + xml: + name: DelayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IdleState: + allOf: + - $ref: '#/components/schemas/tt_RelayIdleState' + - description: "'open' or 'closed'" + xml: + name: IdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelayOutputSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayMode: + title: tt_RelayMode + enum: + - Monostable + - Bistable + type: string + description: '' + xml: + name: RelayMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutput: + title: tt_RelayOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Properties + type: object + properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + name: Properties + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: RelayOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_DigitalIdleState: + title: tt_DigitalIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: DigitalIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DigitalInput: + title: tt_DigitalInput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + properties: + IdleState: + allOf: + - $ref: '#/components/schemas/tt_DigitalIdleState' + - description: Indicate the Digital IdleState status. + xml: + name: IdleState + prefix: tt + attribute: true + wrapped: false + xml: + name: DigitalInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNode: + title: tt_PTZNode + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + properties: + Name: + maxLength: 64 + type: string + description: A unique identifier that is used to reference PTZ Nodes. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range. + xml: + name: SupportedPTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumNumberOfPresets: + type: integer + description: All preset operations MUST be available for this PTZ Node if one preset is supported. + format: int32 + xml: + name: MaximumNumberOfPresets + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HomeSupported: + type: boolean + 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. + xml: + name: HomeSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedHomePosition: + type: boolean + description: Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command. + xml: + name: FixedHomePosition + prefix: tt + attribute: true + wrapped: false + GeoMove: + type: boolean + description: Indication whether the Node supports the geo-referenced move command. + xml: + name: GeoMove + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZNode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNodeExtension: + title: tt_PTZNodeExtension + type: object + properties: + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + xml: + name: SupportedPresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZNodeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZNodeExtension2: + title: tt_PTZNodeExtension2 + type: object + description: '' + xml: + name: PTZNodeExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupported: + title: tt_PTZPresetTourSupported + required: + - MaximumNumberOfPresetTours + type: object + properties: + MaximumNumberOfPresetTours: + type: integer + 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. + format: int32 + xml: + name: MaximumNumberOfPresetTours + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPresetTourOperation: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourOperation' + description: Indicates which preset tour operations are available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupportedExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupportedExtension: + title: tt_PTZPresetTourSupportedExtension + type: object + description: '' + xml: + name: PTZPresetTourSupportedExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension: + title: tt_PTZConfigurationExtension + type: object + properties: + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirection' + - description: Optional element to configure PT Control Direction related features. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension2: + title: tt_PTZConfigurationExtension2 + type: object + description: '' + xml: + name: PTZConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirection: + title: tt_PTControlDirection + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlip' + - description: Optional element to configure related parameters for E-Flip. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_Reverse' + - description: Optional element to configure related parameters for reversing of PT Control Direction. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionExtension: + title: tt_PTControlDirectionExtension + type: object + description: '' + xml: + name: PTControlDirectionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlip: + title: tt_EFlip + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Reverse: + title: tt_Reverse + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipMode: + title: tt_EFlipMode + enum: + - OFF + - ON + - Extended + type: string + description: '' + xml: + name: EFlipMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseMode: + title: tt_ReverseMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ReverseMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions: + title: tt_PTZConfigurationOptions + required: + - Spaces + - PTZTimeout + type: object + properties: + PTZRamps: + type: integer + description: >- + The list of acceleration ramps supported by the device. The + smallest acceleration value corresponds to the minimal index, the + highest acceleration corresponds to the maximum index. + format: int32 + xml: + name: PTZRamps + prefix: tt + attribute: true + wrapped: false + Spaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of supported coordinate systems including their range limitations. + xml: + name: Spaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZTimeout: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the PTZ Node. + xml: + name: PTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions2: + title: tt_PTZConfigurationOptions2 + type: object + description: '' + xml: + name: PTZConfigurationOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptions: + title: tt_PTControlDirectionOptions + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptions' + - description: Supported options for EFlip feature. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptions' + - description: Supported options for Reverse feature. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirectionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptionsExtension: + title: tt_PTControlDirectionOptionsExtension + type: object + description: '' + xml: + name: PTControlDirectionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptions: + title: tt_EFlipOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_EFlipMode' + description: Options of EFlip mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlipOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptionsExtension: + title: tt_EFlipOptionsExtension + type: object + description: '' + xml: + name: EFlipOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptions: + title: tt_ReverseOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ReverseMode' + description: Options of Reverse mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReverseOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptionsExtension: + title: tt_ReverseOptionsExtension + type: object + description: '' + xml: + name: ReverseOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PanTiltLimits: + title: tt_PanTiltLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: A range of pan tilt limits. + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ZoomLimits: + title: tt_ZoomLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: A range of zoom limit + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpaces: + title: tt_PTZSpaces + type: object + properties: + AbsolutePanTiltPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AbsoluteZoomPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). \n There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePanTiltTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativeZoomTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, 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 where 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 There 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousPanTiltVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 rotation 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousZoomVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt \n movement is represented by a single non-negative scalar value." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZSpacesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpacesExtension: + title: tt_PTZSpacesExtension + type: object + description: '' + xml: + name: PTZSpacesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space2DDescription: + title: tt_Space2DDescription + required: + - URI + - XRange + - YRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space2DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space1DDescription: + title: tt_Space1DDescription + required: + - URI + - XRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space1DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpeed: + title: tt_PTZSpeed + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - 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. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPreset: + title: tt_PTZPreset + type: object + properties: + token: + maxLength: 64 + type: string + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: A list of preset position name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A list of preset position. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPreset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourState: + title: tt_PTZPresetTourState + enum: + - Idle + - Touring + - Paused + - Extended + type: string + description: '' + xml: + name: PTZPresetTourState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourDirection: + title: tt_PTZPresetTourDirection + enum: + - Forward + - Backward + - Extended + type: string + description: '' + xml: + name: PTZPresetTourDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOperation: + title: tt_PTZPresetTourOperation + enum: + - Start + - Stop + - Pause + - Extended + type: string + description: '' + xml: + name: PTZPresetTourOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PresetTour: + title: tt_PresetTour + required: + - Status + - AutoStart + - StartingCondition + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of this preset tour. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: Readable name of the preset tour. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset tour. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Auto Start flag of the preset tour. True allows the preset tour to be activated always. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourSpot' + description: A list of detail of touring spots including preset positions. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourExtension: + title: tt_PTZPresetTourExtension + type: object + description: '' + xml: + name: PTZPresetTourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpot: + title: tt_PTZPresetTourSpot + required: + - PresetDetail + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + type: string + description: Optional parameter to specify time duration of staying on this tour sport. + format: date-time + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotExtension: + title: tt_PTZPresetTourSpotExtension + type: object + description: '' + xml: + name: PTZPresetTourSpotExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetail: + title: tt_PTZPresetTourPresetDetail + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourTypeExtension: + title: tt_PTZPresetTourTypeExtension + type: object + description: '' + xml: + name: PTZPresetTourTypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatus: + title: tt_PTZPresetTourStatus + required: + - State + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + xml: + name: CurrentTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatusExtension: + title: tt_PTZPresetTourStatusExtension + type: object + description: '' + xml: + name: PTZPresetTourStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingCondition: + title: tt_PTZPresetTourStartingCondition + type: object + properties: + RandomPresetOrder: + type: 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. + xml: + name: RandomPresetOrder + prefix: tt + attribute: true + wrapped: false + RecurringTime: + type: integer + description: Optional parameter to specify how many times the preset tour is recurred. + format: int32 + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + type: string + description: Optional parameter to specify how long time duration the preset tour is recurred. + format: date-time + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted. + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionExtension: + title: tt_PTZPresetTourStartingConditionExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOptions: + title: tt_PTZPresetTourOptions + required: + - AutoStart + - StartingCondition + - TourSpot + type: object + properties: + AutoStart: + type: boolean + description: Indicates whether or not the AutoStart is supported. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + xml: + name: TourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotOptions: + title: tt_PTZPresetTourSpotOptions + required: + - PresetDetail + - StayTime + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of stay time for a tour spot. + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpotOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptions: + title: tt_PTZPresetTourPresetDetailOptions + type: object + properties: + PresetToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: PresetToken + attribute: false + wrapped: false + description: A list of available Preset Tokens for tour spots. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + description: An option to indicate Home postion for tour spots. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + xml: + name: PanTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + xml: + name: ZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetailOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptionsExtension: + title: tt_PTZPresetTourPresetDetailOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourPresetDetailOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptions: + title: tt_PTZPresetTourStartingConditionOptions + type: object + properties: + RecurringTime: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of Recurring Time. + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of Recurring Duration. + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourDirection' + description: Supported options for Direction of Preset Tour. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingConditionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptionsExtension: + title: tt_PTZPresetTourStartingConditionOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveAndTrackMethod: + title: tt_MoveAndTrackMethod + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + type: string + description: '' + xml: + name: MoveAndTrackMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus: + title: tt_ImagingStatus + required: + - FocusStatus + type: object + properties: + FocusStatus: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus' + - xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus: + title: tt_FocusStatus + required: + - Position + - MoveStatus + - Error + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration: + title: tt_FocusConfiguration + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: >- + Parameter to set autofocus far limit (unit: meter). + + If set to 0.0, infinity will be used. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AutoFocusMode: + title: tt_AutoFocusMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AFModes: + title: tt_AFModes + enum: + - OnceAfterMove + type: string + description: '' + xml: + name: AFModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings: + title: tt_ImagingSettings + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension: + title: tt_ImagingSettingsExtension + type: object + description: '' + xml: + name: ImagingSettingsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure: + title: tt_Exposure + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + description: Minimum value of the iris range allowed to be used by the algorithm. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + description: Maximum value of the iris range allowed to be used by the algorithm. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + description: The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicMode: + title: tt_WideDynamicMode + enum: + - OFF + - ON + type: string + description: '' + xml: + name: WideDynamicMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange: + title: tt_WideDynamicRange + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: White dynamic range (on/off) + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unitless) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationMode: + title: tt_BacklightCompensationMode + enum: + - OFF + - ON + type: string + description: Enumeration describing the available backlight compenstation modes. + xml: + name: BacklightCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation: + title: tt_BacklightCompensation + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposurePriority: + title: tt_ExposurePriority + enum: + - LowNoise + - FrameRate + type: string + description: '' + xml: + name: ExposurePriority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions: + title: tt_ImagingOptions + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions' + - xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions' + - xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions' + - xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions' + - xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions' + - xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions: + title: tt_WideDynamicRangeOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions: + title: tt_BacklightCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions: + title: tt_FocusOptions + required: + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions: + title: tt_ExposureOptions + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions: + title: tt_WhiteBalanceOptions + required: + - Mode + - YrGain + - YbGain + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusMove: + title: tt_FocusMove + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocus' + - description: Parameters for the absolute focus control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocus' + - description: Parameters for the relative focus control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocus' + - description: Parameter for the continuous focus control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusMove + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocus: + title: tt_AbsoluteFocus + required: + - Position + type: object + properties: + Position: + type: number + description: Position parameter for the absolute focus control. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the absolute focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocus: + title: tt_RelativeFocus + required: + - Distance + type: object + properties: + Distance: + type: number + description: Distance parameter for the relative focus control. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the relative focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocus: + title: tt_ContinuousFocus + required: + - Speed + type: object + properties: + Speed: + type: number + description: Speed parameter for the Continuous focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions: + title: tt_MoveOptions + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions' + - xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocusOptions: + title: tt_AbsoluteFocusOptions + required: + - Position + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions: + title: tt_RelativeFocusOptions + required: + - Distance + - Speed + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocusOptions: + title: tt_ContinuousFocusOptions + required: + - Speed + type: object + properties: + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureMode: + title: tt_ExposureMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: ExposureMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Enabled: + title: tt_Enabled + enum: + - ENABLED + - DISABLED + type: string + description: '' + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceMode: + title: tt_WhiteBalanceMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: WhiteBalanceMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterMode: + title: tt_IrCutFilterMode + enum: + - ON + - OFF + - AUTO + type: string + description: '' + xml: + name: IrCutFilterMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance: + title: tt_WhiteBalance + required: + - Mode + - CrGain + - CbGain + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20: + title: tt_ImagingStatus20 + type: object + properties: + FocusStatus20: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20' + - description: Status of focus. + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20Extension: + title: tt_ImagingStatus20Extension + type: object + description: '' + xml: + name: ImagingStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20: + title: tt_FocusStatus20 + required: + - Position + - MoveStatus + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20Extension: + title: tt_FocusStatus20Extension + type: object + description: '' + xml: + name: FocusStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings20: + title: tt_ImagingSettings20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure20' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange20' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension20' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command. + xml: + name: ImagingSettings20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension20: + title: tt_ImagingSettingsExtension20 + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension202' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension202: + title: tt_ImagingSettingsExtension202 + type: object + properties: + IrCutFilterAutoAdjustment: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustment' + description: An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension203' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension202 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension203: + title: tt_ImagingSettingsExtension203 + type: object + properties: + ToneCompensation: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Defogging: + allOf: + - $ref: '#/components/schemas/tt_Defogging' + - description: Optional element to configure Image Defogging. + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReduction: + allOf: + - $ref: '#/components/schemas/tt_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension204' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension203 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension204: + title: tt_ImagingSettingsExtension204 + type: object + description: '' + xml: + name: ImagingSettingsExtension204 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilization: + title: tt_ImageStabilization + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationExtension: + title: tt_ImageStabilizationExtension + type: object + description: '' + xml: + name: ImageStabilizationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationMode: + title: tt_ImageStabilizationMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ImageStabilizationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustment: + title: tt_IrCutFilterAutoAdjustment + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: string + description: Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + name: BoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: number + 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). + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTime: + type: string + description: Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels. + format: date-time + xml: + name: ResponseTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentExtension: + title: tt_IrCutFilterAutoAdjustmentExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoBoundaryType: + title: tt_IrCutFilterAutoBoundaryType + enum: + - Common + - ToOn + - ToOff + - Extended + type: string + description: '' + xml: + name: IrCutFilterAutoBoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange20: + title: tt_WideDynamicRange20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether WDR mode is enabled or disabled (on/off). + xml: + name: WideDynamicRange20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation20: + title: tt_BacklightCompensation20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether BLC mode is enabled or disabled (on/off). + xml: + name: BacklightCompensation20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure20: + title: tt_Exposure20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + 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. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + 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. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + 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. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the exposure settings. + xml: + name: Exposure20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensation: + title: tt_ToneCompensation + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationExtension: + title: tt_ToneCompensationExtension + type: object + description: '' + xml: + name: ToneCompensationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationMode: + title: tt_ToneCompensationMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: ToneCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Defogging: + title: tt_Defogging + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DefoggingExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingExtension: + title: tt_DefoggingExtension + type: object + description: '' + xml: + name: DefoggingExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingMode: + title: tt_DefoggingMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: DefoggingMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReduction: + title: tt_NoiseReduction + required: + - Level + type: object + properties: + Level: + type: number + description: Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20: + title: tt_ImagingOptions20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Brightness. + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Color Saturation. + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Contrast. + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions20' + - description: Valid range of Exposure. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20' + - description: Valid range of Focus. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: Valid range of IrCutFilterModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Sharpness. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension: + title: tt_ImagingOptions20Extension + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension2: + title: tt_ImagingOptions20Extension2 + type: object + properties: + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto mode. + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension3' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension3: + title: tt_ImagingOptions20Extension3 + type: object + properties: + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/tt_DefoggingOptions' + - description: Options of parameters for Defogging feature. + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/tt_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension4' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension3 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension4: + title: tt_ImagingOptions20Extension4 + type: object + description: '' + xml: + name: ImagingOptions20Extension4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptions: + title: tt_ImageStabilizationOptions + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ImageStabilizationMode' + description: Supported options of Image Stabilization mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Image Stabilization. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilizationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptionsExtension: + title: tt_ImageStabilizationOptionsExtension + type: object + description: '' + xml: + name: ImageStabilizationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptions: + title: tt_IrCutFilterAutoAdjustmentOptions + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: array + items: + type: string + xml: + name: BoundaryType + attribute: false + wrapped: false + description: Supported options of boundary types for adjustment of Ir cut filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: boolean + description: Indicates whether or not boundary offset for toggling Ir cut filter is supported. + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + xml: + name: ResponseTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptionsExtension: + title: tt_IrCutFilterAutoAdjustmentOptionsExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions20: + title: tt_WideDynamicRangeOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions20: + title: tt_BacklightCompensationOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_BacklightCompensationMode' + description: "'ON' or 'OFF'" + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Level range of BacklightCompensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions20: + title: tt_ExposureOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: Exposure Mode + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: The exposure priority mode (low noise/framerate). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum ExposureTime. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum ExposureTime. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Gain. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Gain. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Iris. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Iris. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the ExposureTime. + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Gain. + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions20: + title: tt_MoveOptions20 + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions20: + title: tt_RelativeFocusOptions20 + required: + - Distance + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20: + title: tt_WhiteBalance20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: "'AUTO' or 'MANUAL'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20Extension: + title: tt_WhiteBalance20Extension + type: object + description: '' + xml: + name: WhiteBalance20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20: + title: tt_FocusConfiguration20 + required: + - AutoFocusMode + type: object + properties: + AFMode: + type: string + description: Zero or more modes as defined in enumeration tt:AFModes. + xml: + name: AFMode + prefix: tt + attribute: true + wrapped: false + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - description: Mode of auto focus. + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: 'Parameter to set autofocus far limit (unit: meter).' + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20Extension: + title: tt_FocusConfiguration20Extension + type: object + description: '' + xml: + name: FocusConfiguration20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20: + title: tt_WhiteBalanceOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: Mode of WhiteBalance. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20Extension: + title: tt_WhiteBalanceOptions20Extension + type: object + description: '' + xml: + name: WhiteBalanceOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20: + title: tt_FocusOptions20 + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: Supported modes for auto focus. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of DefaultSpeed. + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of NearLimit. + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of FarLimit. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20Extension: + title: tt_FocusOptions20Extension + type: object + properties: + AFModes: + type: array + items: + type: string + xml: + name: AFModes + attribute: false + wrapped: false + description: Supported options for auto focus. Options shall be chosen from tt:AFModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationOptions: + title: tt_ToneCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Tone Compensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingOptions: + title: tt_DefoggingOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Defogging. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReductionOptions: + title: tt_NoiseReductionOptions + required: + - Level + type: object + properties: + Level: + type: boolean + description: Indicates whether or not support Level parameter for NoiseReduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageSendingType: + title: tt_ImageSendingType + enum: + - Embedded + - LocalStorage + - RemoteStorage + type: string + description: '' + xml: + name: ImageSendingType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PropertyOperation: + title: tt_PropertyOperation + enum: + - Initialized + - Deleted + - Changed + type: string + description: '' + xml: + name: PropertyOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Message: + title: tt_Message + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + PropertyOperation: + allOf: + - $ref: '#/components/schemas/tt_PropertyOperation' + - xml: + name: PropertyOperation + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: Token value pairs that triggered this message. Typically only one item is present. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Message + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageExtension: + title: tt_MessageExtension + type: object + description: '' + xml: + name: MessageExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemList: + title: tt_ItemList + type: object + properties: + SimpleItem: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItem' + description: Value name pair as defined by the corresponding description. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItem: + type: array + items: + $ref: '#/components/schemas/tt_ElementItem' + description: Complex value structure. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ItemList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListExtension: + title: tt_ItemListExtension + type: object + description: '' + xml: + name: ItemListExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescription: + title: tt_MessageDescription + type: object + properties: + IsProperty: + type: 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. + xml: + name: IsProperty + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + Set of tokens producing this message. The list may only contain SimpleItemDescription items. + The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key. + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes the payload of the message. + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MessageDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescriptionExtension: + title: tt_MessageDescriptionExtension + type: object + description: '' + xml: + name: MessageDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescription: + title: tt_ItemListDescription + type: object + properties: + SimpleItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItemDescription' + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_ElementItemDescription' + description: Description of a complex type. The Type must reference a defined type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + Describes a list of items. Each item in the list shall have a unique name. + The list is designed as linear structure without optional or unbounded elements. + Use ElementItems only when complex structures are inevitable. + xml: + name: ItemListDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescriptionExtension: + title: tt_ItemListDescriptionExtension + type: object + description: '' + xml: + name: ItemListDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polyline: + title: tt_Polyline + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polyline + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Direction: + title: tt_Direction + enum: + - Left + - Right + - Any + type: string + description: '' + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfiguration: + title: tt_AnalyticsEngineConfiguration + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfigurationExtension: + title: tt_AnalyticsEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfiguration: + title: tt_RuleEngineConfiguration + type: object + properties: + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfigurationExtension: + title: tt_RuleEngineConfigurationExtension + type: object + description: '' + xml: + name: RuleEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Config: + title: tt_Config + required: + - Name + - Type + - Parameters + type: object + properties: + Name: + type: string + description: Name of the configuration. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + 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. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: List of configuration parameters as defined in the corresponding description. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescription: + title: tt_ConfigDescription + required: + - Name + - Parameters + type: object + properties: + Name: + type: string + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies the type of rule, not a type definition in a schema. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: The fixed attribute signals that it is not allowed to add or remove this type of configuration. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + maxInstances: + type: integer + description: The maxInstances attribute signals the maximum number of instances per configuration. + format: int32 + xml: + name: maxInstances + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems + should be used to transport the information to ease parsing of dynamically defined messages by a client + application. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Messages: + type: array + items: + $ref: '#/components/schemas/tt_Messages' + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ConfigDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ConfigDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescriptionExtension: + title: tt_ConfigDescriptionExtension + type: object + description: '' + xml: + name: ConfigDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRules: + title: tt_SupportedRules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + RuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: RuleContentSchemaLocation + attribute: false + wrapped: false + description: Lists the location of all schemas that are referenced in the rules. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: List of rules supported by the Video Analytics configuration.. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedRulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedRules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRulesExtension: + title: tt_SupportedRulesExtension + type: object + description: '' + xml: + name: SupportedRulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModules: + title: tt_SupportedAnalyticsModules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + AnalyticsModuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: AnalyticsModuleContentSchemaLocation + attribute: false + wrapped: false + description: >- + It optionally contains a list of URLs that provide the location of schema files. + These schema files describe the types and elements used in the analytics module descriptions. + Analytics module descriptions that reference types or elements imported from any ONVIF defined schema files + need not explicitly list those schema files. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModulesExtension: + title: tt_SupportedAnalyticsModulesExtension + type: object + description: '' + xml: + name: SupportedAnalyticsModulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArray: + title: tt_PolylineArray + required: + - Segment + type: object + properties: + Segment: + type: array + items: + $ref: '#/components/schemas/tt_Polyline' + description: Contains array of Polyline + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PolylineArrayExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayExtension: + title: tt_PolylineArrayExtension + type: object + description: '' + xml: + name: PolylineArrayExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayConfiguration: + title: tt_PolylineArrayConfiguration + required: + - PolylineArray + type: object + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/tt_PolylineArray' + - description: Contains PolylineArray configuration data + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArrayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpression: + title: tt_MotionExpression + required: + - Expression + type: object + properties: + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Expression: + type: string + description: Motion Expression data structure contains motion expression which is based on Scene Descriptor schema with XPATH syntax. The Type argument could allow introduction of different dialects + xml: + name: Expression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpressionConfiguration: + title: tt_MotionExpressionConfiguration + required: + - MotionExpression + type: object + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/tt_MotionExpression' + - description: Contains Rule MotionExpression configuration + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpressionConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CellLayout: + title: tt_CellLayout + required: + - Columns + - Rows + - Transformation + type: object + properties: + Columns: + type: integer + description: Number of columns of the cell grid (x dimension) + format: int32 + xml: + name: Columns + prefix: tt + attribute: true + wrapped: false + Rows: + type: integer + description: Number of rows of the cell grid (y dimension) + format: int32 + xml: + name: Rows + prefix: tt + attribute: true + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid is starting from the upper left corner and x dimension is going from left to right and the y dimension from up to down. + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CellLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneConfiguration: + title: tt_PaneConfiguration + required: + - Token + type: object + properties: + PaneName: + type: string + description: Optional name of the pane configuration. + xml: + name: PaneName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputToken: + maxLength: 64 + type: string + description: >- + If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client + + can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. + xml: + name: AudioOutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceToken: + maxLength: 64 + type: string + description: >- + If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. + + The 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 + + DeviceIO service. + xml: + name: AudioSourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: >- + The configuration of the audio encoder including codec, bitrate + + and sample rate. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + maxLength: 64 + type: string + description: >- + A pointer to a Receiver that has the necessary information to receive + data 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 + GetReceivers command of the Receiver Service. + xml: + name: ReceiverToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: A unique identifier in the display device. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration of the streaming and coding settings of a Video window. + xml: + name: PaneConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayout: + title: tt_PaneLayout + required: + - Pane + - Area + type: object + properties: + Pane: + maxLength: 64 + type: string + description: Reference to the configuration of the streaming and coding parameters. + xml: + name: Pane + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Area: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Describes the location and size of the area on the monitor. The area coordinate values are espressed in normalized units [-1.0, 1.0]. + xml: + name: Area + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen. + xml: + name: PaneLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Layout: + title: tt_Layout + required: + - PaneLayout + type: object + properties: + PaneLayout: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayout' + description: List of panes assembling the display layout. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A layout describes a set of Video windows that are displayed simultaniously on a display. + xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutExtension: + title: tt_LayoutExtension + type: object + description: '' + xml: + name: LayoutExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CodingCapabilities: + title: tt_CodingCapabilities + required: + - VideoDecodingCapabilities + type: object + properties: + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes the supported codecs and their configuration. + xml: + name: AudioEncodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes the supported codecs and their settings. + xml: + name: AudioDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their configuration. + xml: + name: VideoDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: This type contains the Audio and Video coding capabilities of a display service. + xml: + name: CodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptions: + title: tt_LayoutOptions + required: + - PaneLayoutOptions + type: object + properties: + PaneLayoutOptions: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayoutOptions' + description: Lists the possible Pane Layouts of the Video Output + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The options supported for a display layout. + xml: + name: LayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptionsExtension: + title: tt_LayoutOptionsExtension + type: object + description: '' + xml: + name: LayoutOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayoutOptions: + title: tt_PaneLayoutOptions + required: + - Area + type: object + properties: + Area: + type: array + items: + $ref: '#/components/schemas/tt_Rectangle' + description: List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PaneOptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a pane layout describing a complete display layout. + xml: + name: PaneLayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneOptionExtension: + title: tt_PaneOptionExtension + type: object + description: '' + xml: + name: PaneOptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Receiver: + title: tt_Receiver + required: + - Token + - Configuration + type: object + properties: + Token: + maxLength: 64 + type: string + description: Unique identifier of the receiver. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a receiver, including its token and configuration. + xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverConfiguration: + title: tt_ReceiverConfiguration + required: + - Mode + - MediaUri + - StreamSetup + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReceiverMode' + - description: 'The following connection modes are defined:' + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaUri: + type: string + description: Details of the URI to which the receiver should connect. + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream connection parameters. + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describes the configuration of a receiver. + xml: + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverMode: + title: tt_ReceiverMode + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + description: Specifies a receiver connection mode. + xml: + name: ReceiverMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverState: + title: tt_ReceiverState + enum: + - NotConnected + - Connecting + - Connected + - Unknown + type: string + description: Specifies the current connection state of the receiver. + xml: + name: ReceiverState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverStateInformation: + title: tt_ReceiverStateInformation + required: + - State + - AutoCreated + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_ReceiverState' + - description: 'The connection state of the receiver may have one of the following states:' + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreated: + type: boolean + description: Indicates whether or not the receiver was created automatically. + xml: + name: AutoCreated + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Contains information about a receiver's current state. + xml: + name: ReceiverStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceReference: + title: tt_SourceReference + required: + - Token + type: object + properties: + Type: + type: string + default: http://www.onvif.org/ver10/schema/Receiver + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTimeRange: + title: tt_DateTimeRange + required: + - From + - Until + type: object + properties: + From: + type: string + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSummary: + title: tt_RecordingSummary + required: + - DataFrom + - DataUntil + - NumberRecordings + type: object + properties: + DataFrom: + type: string + description: The earliest point in time where there is recorded data on the device. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataUntil: + type: string + description: The most recent point in time where there is recorded data on the device. + format: date-time + xml: + name: DataUntil + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NumberRecordings: + type: integer + description: The device contains this many recordings. + format: int32 + xml: + name: NumberRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingSummary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScope: + title: tt_SearchScope + type: object + properties: + IncludedSources: + type: array + items: + $ref: '#/components/schemas/tt_SourceReference' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IncludedRecordings: + type: array + items: + maxLength: 64 + type: string + xml: + name: IncludedRecordings + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformationFilter: + type: string + 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. + xml: + name: RecordingInformationFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SearchScopeExtension' + - description: Extension point + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A structure for defining a limited scope when searching in recorded data. + xml: + name: SearchScope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScopeExtension: + title: tt_SearchScopeExtension + type: object + description: '' + xml: + name: SearchScopeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventFilter: + title: tt_EventFilter + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + xml: + name: EventFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZPositionFilter: + title: tt_PTZPositionFilter + required: + - MinPosition + - MaxPosition + - EnterOrExit + type: object + properties: + MinPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + xml: + name: MinPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + xml: + name: MaxPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EnterOrExit: + type: boolean + description: If true, search for when entering the specified PTZ volume. + xml: + name: EnterOrExit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPositionFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataFilter: + title: tt_MetadataFilter + required: + - MetadataStreamFilter + type: object + properties: + MetadataStreamFilter: + type: string + xml: + name: MetadataStreamFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindRecordingResultList: + title: tt_FindRecordingResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformation: + type: array + items: + $ref: '#/components/schemas/tt_RecordingInformation' + description: A RecordingInformation structure for each found recording matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindRecordingResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResultList: + title: tt_FindEventResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindEventResult' + description: A FindEventResult structure for each found event matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResult: + title: tt_FindEventResult + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: The recording where this event was found. Empty string if no recording is associated with this event. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the track where this event was found. Empty string if no track is associated with this event. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the event occured. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + xml: + name: Event + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartStateEvent: + type: boolean + 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. + xml: + name: StartStateEvent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResultList: + title: tt_FindPTZPositionResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindPTZPositionResult' + description: A FindPTZPositionResult structure for each found PTZ position matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResult: + title: tt_FindPTZPositionResult + required: + - RecordingToken + - TrackToken + - Time + - Position + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the PTZ position. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the PTZ position. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the PTZ position was valid. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The PTZ position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResultList: + title: tt_FindMetadataResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindMetadataResult' + description: A FindMetadataResult structure for each found set of Metadata matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResult: + title: tt_FindMetadataResult + required: + - RecordingToken + - TrackToken + - Time + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the metadata. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the matching metadata. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The point in time when the matching metadata occurs in the metadata track. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchState: + title: tt_SearchState + enum: + - Queued + - Searching + - Completed + - Unknown + type: string + description: '' + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingInformation: + title: tt_RecordingInformation + required: + - RecordingToken + - Source + - Content + - RecordingStatus + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: >- + Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single + recording is intended to record related material, there is just one source. It is indicates the physical location or the + major data source for the recording. Currently the recordingconfiguration cannot describe each individual data source. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EarliestRecording: + type: string + format: date-time + xml: + name: EarliestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LatestRecording: + type: string + format: date-time + xml: + name: LatestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Track: + type: array + items: + $ref: '#/components/schemas/tt_TrackInformation' + description: Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingStatus: + allOf: + - $ref: '#/components/schemas/tt_RecordingStatus' + - xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSourceInformation: + title: tt_RecordingSourceInformation + required: + - SourceId + - Name + - Location + - Description + - Address + type: object + properties: + SourceId: + type: string + description: >- + Identifier for the source chosen by the client that creates the structure. + This identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters. + xml: + name: SourceId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + maxLength: 64 + type: string + description: Informative user readable name of the source, e.g. "Camera23". A device shall support at least 20 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Location: + type: string + description: Informative description of the physical location of the source, e.g. the coordinates on a map. + xml: + name: Location + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the source. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Address: + type: string + description: URI provided by the service supplying data to be recorded. A device shall support at least 128 characters. + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of informative desciptions of a data source. The Search searvice allows a client to filter on recordings based on information in this structure. + xml: + name: RecordingSourceInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingStatus: + title: tt_RecordingStatus + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + type: string + description: '' + xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackInformation: + title: tt_TrackInformation + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + type: object + properties: + TrackToken: + maxLength: 64 + type: string + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track: "Video", "Audio" or "Metadata". + The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the contents of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataFrom: + type: string + description: The start date and time of the oldest recorded data in the track. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataTo: + type: string + description: The stop date and time of the newest recorded data in the track. + format: date-time + xml: + name: DataTo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackType: + title: tt_TrackType + enum: + - Video + - Audio + - Metadata + - Extended + type: string + description: '' + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaAttributes: + title: tt_MediaAttributes + required: + - RecordingToken + - From + - Until + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording that has these attributes. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackAttributes: + type: array + items: + $ref: '#/components/schemas/tt_TrackAttributes' + description: A set of attributes for each track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + From: + type: string + description: The attributes are valid from this point in time in the recording. + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + 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. + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of media attributes valid for a recording at a point in time or for a time interval. + xml: + name: MediaAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributes: + title: tt_TrackAttributes + required: + - TrackInformation + type: object + properties: + TrackInformation: + allOf: + - $ref: '#/components/schemas/tt_TrackInformation' + - description: The basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAttributes: + allOf: + - $ref: '#/components/schemas/tt_VideoAttributes' + - description: If the track is a video track, exactly one of this structure shall be present and contain the video attributes. + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioAttributes: + allOf: + - $ref: '#/components/schemas/tt_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure shall be present and contain the audio attributes. + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/tt_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure shall be present and contain the metadata attributes. + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TrackAttributesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributesExtension: + title: tt_TrackAttributesExtension + type: object + description: '' + xml: + name: TrackAttributesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAttributes: + title: tt_VideoAttributes + required: + - Width + - Height + - Encoding + - Framerate + type: object + properties: + Bitrate: + type: integer + description: Average bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Width: + type: integer + description: The width of the video in pixels. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: The height of the video in pixels. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Video encoding of the track. Use value from tt:VideoEncoding for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Framerate: + type: number + description: Average framerate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAttributes: + title: tt_AudioAttributes + required: + - Encoding + - Samplerate + type: object + properties: + Bitrate: + type: integer + description: The bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Audio encoding of the track. Use values from tt:AudioEncoding for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Samplerate: + type: integer + description: The sample rate in kHz. + format: int32 + xml: + name: Samplerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataAttributes: + title: tt_MetadataAttributes + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + type: object + properties: + PtzSpaces: + type: 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. + xml: + name: PtzSpaces + prefix: tt + attribute: true + wrapped: false + CanContainPTZ: + type: boolean + description: Indicates that there can be PTZ data in the metadata track in the specified time interval. + xml: + name: CanContainPTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainAnalytics: + type: boolean + description: Indicates that there can be analytics data in the metadata track in the specified time interval. + xml: + name: CanContainAnalytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainNotifications: + type: boolean + description: Indicates that there can be notifications in the metadata track in the specified time interval. + xml: + name: CanContainNotifications + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingConfiguration: + title: tt_RecordingConfiguration + required: + - Source + - Content + - MaximumRetentionTime + type: object + properties: + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: Information about the source of the recording. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + description: Informative description of the source. + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRetentionTime: + type: string + description: >- + Sspecifies the maximum time that data in any track within the + recording shall be stored. The device shall delete any data older than the maximum retention + time. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0, + the device shall not limit the retention time of stored data, except by resource constraints. + Whatever the value of MaximumRetentionTime, the device may automatically delete + recordings to free up storage space for new recordings. + format: date-time + xml: + name: MaximumRetentionTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackConfiguration: + title: tt_TrackConfiguration + required: + - TrackType + - Description + type: object + properties: + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track. It shall be equal to the strings “Video”, + “Audio” or “Metadata”. The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingsResponseItem: + title: tt_GetRecordingsResponseItem + required: + - RecordingToken + - Configuration + - Tracks + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Token of the recording. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_RecordingConfiguration' + - description: Configuration of the recording. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_GetTracksResponseList' + - description: List of tracks. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseList: + title: tt_GetTracksResponseList + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_GetTracksResponseItem' + description: Configuration of a track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseItem: + title: tt_GetTracksResponseItem + required: + - TrackToken + - Configuration + type: object + properties: + TrackToken: + maxLength: 64 + type: string + description: Token of the track. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_TrackConfiguration' + - description: Configuration of the track. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfiguration: + title: tt_RecordingJobConfiguration + required: + - RecordingToken + - Mode + - Priority + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identifies the recording to which this job shall store the received data. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + type: string + description: >- + The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try + to obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: integer + description: >- + This shall be a non-negative number. If there are multiple recording jobs that store data to + the same track, the device will only store the data for the recording job with the highest + priority. The priority is specified per recording job, but the device shall determine the priority + of each track individually. If there are two recording jobs with the same priority, the device + shall record the data corresponding to the recording job that was activated the latest. + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobSource' + description: Source of the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfigurationExtension: + title: tt_RecordingJobConfigurationExtension + type: object + description: '' + xml: + name: RecordingJobConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSource: + title: tt_RecordingJobSource + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: >- + This field shall be a reference to the source of the data. The type of the source + is determined by the attribute Type in the SourceToken structure. If Type is + http://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case + the device shall receive the data over the network. If Type is + http://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, instructing the + device to obtain data from a profile that exists on the local device. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreateReceiver: + type: boolean + description: >- + If this field is TRUE, and if the SourceToken is omitted, the device + shall create a receiver object (through the receiver service) and assign the + ReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration + from the device, the AutoCreateReceiver field shall never be present. + xml: + name: AutoCreateReceiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobTrack' + description: List of tracks associated with the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSourceExtension: + title: tt_RecordingJobSourceExtension + type: object + description: '' + xml: + name: RecordingJobSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobTrack: + title: tt_RecordingJobTrack + required: + - SourceTag + - Destination + type: object + properties: + SourceTag: + type: string + description: >- + If the received RTSP stream contains multiple tracks of the same type, the + SourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: >- + The destination is the tracktoken of the track to which the device shall store the + received data. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformation: + title: tt_RecordingJobStateInformation + required: + - RecordingToken + - State + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identification of the recording that the recording job records to. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over the whole RecordingJobInformation structure. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sources: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateSource' + description: Identifies the data source of the recording job. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformationExtension: + title: tt_RecordingJobStateInformationExtension + type: object + description: '' + xml: + name: RecordingJobStateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateSource: + title: tt_RecordingJobStateSource + required: + - SourceToken + - State + - Tracks + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: Identifies the data source of the recording job. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateTracks' + - description: List of track items. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTracks: + title: tt_RecordingJobStateTracks + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateTrack' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTrack: + title: tt_RecordingJobStateTrack + required: + - SourceTag + - Destination + - State + type: object + properties: + SourceTag: + type: string + description: Identifies the track of the data source that provides the data. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: Indicates the destination track. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: >- + Optionally holds an implementation defined string value that describes the error. + The string should be in the English language. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: >- + Provides the job state of the track. The valid + values of state shall be “Idle”, “Active” and “Error”. If state equals “Error”, the Error field may be filled in with an implementation defined value. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingJobsResponseItem: + title: tt_GetRecordingJobsResponseItem + required: + - JobToken + - JobConfiguration + type: object + properties: + JobToken: + maxLength: 64 + type: string + xml: + name: JobToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JobConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfiguration' + - xml: + name: JobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingJobsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayConfiguration: + title: tt_ReplayConfiguration + required: + - SessionTimeout + type: object + properties: + SessionTimeout: + type: string + description: The RTSP session timeout. + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration parameters for the replay service. + xml: + name: ReplayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngine: + title: tt_AnalyticsEngine + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngine + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AnalyticsDeviceEngineConfiguration: + title: tt_AnalyticsDeviceEngineConfiguration + required: + - EngineConfiguration + type: object + properties: + EngineConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_EngineConfiguration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceEngineConfigurationExtension: + title: tt_AnalyticsDeviceEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsDeviceEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EngineConfiguration: + title: tt_EngineConfiguration + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + type: object + properties: + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineInputInfo: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfo' + - xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfo: + title: tt_AnalyticsEngineInputInfo + type: object + properties: + InputInfo: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: InputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfoExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfoExtension: + title: tt_AnalyticsEngineInputInfoExtension + type: object + description: '' + xml: + name: AnalyticsEngineInputInfoExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInput: + title: tt_AnalyticsEngineInput + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + properties: + SourceIdentification: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentification' + - xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoInput: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - xml: + name: VideoInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataInput: + allOf: + - $ref: '#/components/schemas/tt_MetadataInput' + - xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_SourceIdentification: + title: tt_SourceIdentification + required: + - Name + - Token + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + type: array + items: + maxLength: 64 + type: string + xml: + name: Token + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentificationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceIdentificationExtension: + title: tt_SourceIdentificationExtension + type: object + description: '' + xml: + name: SourceIdentificationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInput: + title: tt_MetadataInput + type: object + properties: + MetadataConfig: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataInputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInputExtension: + title: tt_MetadataInputExtension + type: object + description: '' + xml: + name: MetadataInputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineControl: + title: tt_AnalyticsEngineControl + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + properties: + EngineToken: + maxLength: 64 + type: string + description: Token of the analytics engine (AnalyticsEngine) being controlled. + xml: + name: EngineToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EngineConfigToken: + maxLength: 64 + type: string + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect. + xml: + name: EngineConfigToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InputToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputToken + attribute: false + wrapped: false + description: Tokens of the input (AnalyticsEngineInput) configuration applied. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: ReceiverToken + attribute: false + wrapped: false + description: Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subscription: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: Subscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ModeOfOperation' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_ModeOfOperation: + title: tt_ModeOfOperation + enum: + - Idle + - Active + - Unknown + type: string + description: '' + xml: + name: ModeOfOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsStateInformation: + title: tt_AnalyticsStateInformation + required: + - AnalyticsEngineControlToken + - State + type: object + properties: + AnalyticsEngineControlToken: + maxLength: 64 + type: string + description: Token of the control object whose status is requested. + xml: + name: AnalyticsEngineControlToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsState' + - xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsState: + title: tt_AnalyticsState + required: + - State + type: object + properties: + Error: + type: string + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayload: + title: tt_ActionEngineEventPayload + type: object + properties: + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + xml: + name: RequestInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + xml: + name: ResponseInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + xml: + name: Fault + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ActionEngineEventPayloadExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Action Engine Event Payload data structure contains the information about the ONVIF command invocations. Since this event could be generated by other or proprietary actions, the command invocation specific fields are defined as optional and additional extension mechanism is provided for future or additional action definitions. + xml: + name: ActionEngineEventPayload + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayloadExtension: + title: tt_ActionEngineEventPayloadExtension + type: object + description: '' + xml: + name: ActionEngineEventPayloadExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassType: + title: tt_AudioClassType + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + type: string + description: >- + AudioClassType acceptable values are; + gun_shot, scream, glass_breaking, tire_screech + xml: + name: AudioClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassCandidate: + title: tt_AudioClassCandidate + required: + - Type + - Likelihood + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_AudioClassType' + - description: Indicates audio class label + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + description: A likelihood/probability that the corresponding audio event belongs to this class. The sum of the likelihoods shall NOT exceed 1 + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptor: + title: tt_AudioClassDescriptor + type: object + properties: + ClassCandidate: + type: array + items: + $ref: '#/components/schemas/tt_AudioClassCandidate' + description: Array of audio class label and class probability + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioClassDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptorExtension: + title: tt_AudioClassDescriptorExtension + type: object + description: '' + xml: + name: AudioClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActiveConnection: + title: tt_ActiveConnection + required: + - CurrentBitrate + - CurrentFps + type: object + properties: + CurrentBitrate: + type: number + xml: + name: CurrentBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentFps: + type: number + xml: + name: CurrentFps + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ActiveConnection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatus: + title: tt_ProfileStatus + type: object + properties: + ActiveConnections: + type: array + items: + $ref: '#/components/schemas/tt_ActiveConnection' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatusExtension: + title: tt_ProfileStatusExtension + type: object + description: '' + xml: + name: ProfileStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDReference: + title: tt_OSDReference + type: object + description: '' + xml: + name: OSDReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDType: + title: tt_OSDType + enum: + - Text + - Image + - Extended + type: string + description: '' + xml: + name: OSDType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfiguration: + title: tt_OSDPosConfiguration + required: + - Type + type: object + properties: + Type: + type: string + description: 'For OSD position type, following are the pre-defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Pos: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Pos + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDPosConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfigurationExtension: + title: tt_OSDPosConfigurationExtension + type: object + description: '' + xml: + name: OSDPosConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColor: + title: tt_OSDColor + required: + - Color + type: object + properties: + Transparent: + type: integer + format: int32 + xml: + name: Transparent + prefix: tt + attribute: true + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: 'The value range of "Transparent" could be defined by vendors only should follow this rule: the minimum value means non-transparent and the maximum value maens fully transparent.' + xml: + name: OSDColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfiguration: + title: tt_OSDTextConfiguration + required: + - Type + type: object + properties: + IsPersistentText: + type: 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. + xml: + name: IsPersistentText + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: 'The following OSD Text Type are defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: string + 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:' + xml: + name: DateFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: string + 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:' + xml: + name: TimeFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSize: + type: integer + description: Font size of the text in pt. + format: int32 + xml: + name: FontSize + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Font color of the text. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Background color of the text. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PlainText: + type: string + description: The content of text to be displayed. + xml: + name: PlainText + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfigurationExtension: + title: tt_OSDTextConfigurationExtension + type: object + description: '' + xml: + name: OSDTextConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfiguration: + title: tt_OSDImgConfiguration + required: + - ImgPath + type: object + properties: + ImgPath: + type: string + description: The URI of the image which to be displayed. + xml: + name: ImgPath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfigurationExtension: + title: tt_OSDImgConfigurationExtension + type: object + description: '' + xml: + name: OSDImgConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorspaceRange: + title: tt_ColorspaceRange + required: + - X + - Y + - Z + - Colorspace + type: object + properties: + X: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Y: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Y + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Z: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Z + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorspaceRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptions: + title: tt_ColorOptions + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the colors supported. Either list each color or define the range of color values. + xml: + name: ColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptions: + title: tt_OSDColorOptions + type: object + properties: + Color: + oneOf: + - $ref: '#/components/schemas/tt_ColorOptionsChoice0' + - $ref: '#/components/schemas/tt_ColorOptionsChoice1' + description: Optional list of supported colors. + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transparent: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + xml: + name: Transparent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the option of the color and its transparency. + xml: + name: OSDColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptionsExtension: + title: tt_OSDColorOptionsExtension + type: object + description: '' + xml: + name: OSDColorOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptions: + title: tt_OSDTextOptions + required: + - Type + type: object + properties: + Type: + type: array + items: + type: string + xml: + name: Type + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSizeRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the font size value. + xml: + name: FontSizeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: array + items: + type: string + xml: + name: DateFormat + attribute: false + wrapped: false + description: List of supported date format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: array + items: + type: string + xml: + name: TimeFormat + attribute: false + wrapped: false + description: List of supported time format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported font color. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported background color. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptionsExtension: + title: tt_OSDTextOptionsExtension + type: object + description: '' + xml: + name: OSDTextOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptions: + title: tt_OSDImgOptions + required: + - ImagePath + type: object + properties: + FormatsSupported: + type: string + description: List of supported image MIME types, such as "image/png". + xml: + name: FormatsSupported + prefix: tt + attribute: true + wrapped: false + MaxSize: + type: integer + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + xml: + name: MaxSize + prefix: tt + attribute: true + wrapped: false + MaxWidth: + type: integer + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxWidth + prefix: tt + attribute: true + wrapped: false + MaxHeight: + type: integer + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxHeight + prefix: tt + attribute: true + wrapped: false + ImagePath: + type: array + items: + type: string + xml: + name: ImagePath + attribute: false + wrapped: false + description: List of available image URIs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptionsExtension: + title: tt_OSDImgOptionsExtension + type: object + description: '' + xml: + name: OSDImgOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfiguration: + title: tt_OSDConfiguration + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + properties: + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/tt_OSDReference' + - description: Reference to the video source configuration. + xml: + name: VideoSourceConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_OSDType' + - description: Type of OSD. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfiguration' + - description: Position configuration of OSD. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextString: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the value of Type field is Text. + xml: + name: TextString + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Image: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the value of Type field is Image + xml: + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: OSDConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_OSDConfigurationExtension: + title: tt_OSDConfigurationExtension + type: object + description: '' + xml: + name: OSDConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MaximumNumberOfOSDs: + title: tt_MaximumNumberOfOSDs + required: + - Total + type: object + properties: + Total: + type: integer + format: int32 + xml: + name: Total + prefix: tt + attribute: true + wrapped: false + Image: + type: integer + format: int32 + xml: + name: Image + prefix: tt + attribute: true + wrapped: false + PlainText: + type: integer + format: int32 + xml: + name: PlainText + prefix: tt + attribute: true + wrapped: false + Date: + type: integer + format: int32 + xml: + name: Date + prefix: tt + attribute: true + wrapped: false + Time: + type: integer + format: int32 + xml: + name: Time + prefix: tt + attribute: true + wrapped: false + DateAndTime: + type: integer + format: int32 + xml: + name: DateAndTime + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptions: + title: tt_OSDConfigurationOptions + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + type: object + properties: + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/tt_MaximumNumberOfOSDs' + - 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. + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + type: array + items: + $ref: '#/components/schemas/tt_OSDType' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PositionOption: + type: array + items: + type: string + xml: + name: PositionOption + attribute: false + wrapped: false + description: 'List available OSD position type. Following are the pre-defined:' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextOption: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text. + xml: + name: TextOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ImageOption: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image. + xml: + name: ImageOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptionsExtension: + title: tt_OSDConfigurationOptionsExtension + type: object + description: '' + xml: + name: OSDConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FileProgress: + title: tt_FileProgress + required: + - FileName + - Progress + type: object + properties: + FileName: + type: string + description: Exported file name + xml: + name: FileName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Progress: + type: number + description: Normalized percentage completion for uploading the exported file + xml: + name: Progress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgress: + title: tt_ArrayOfFileProgress + type: object + properties: + FileProgress: + type: array + items: + $ref: '#/components/schemas/tt_FileProgress' + description: Exported file name and export progress information + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ArrayOfFileProgressExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ArrayOfFileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgressExtension: + title: tt_ArrayOfFileProgressExtension + type: object + description: '' + xml: + name: ArrayOfFileProgressExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePath: + title: tt_StorageReferencePath + required: + - StorageToken + type: object + properties: + StorageToken: + maxLength: 64 + type: string + description: identifier of an existing Storage Configuration. + xml: + name: StorageToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePath: + type: string + description: gives the relative directory path on the storage + xml: + name: RelativePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_StorageReferencePathExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StorageReferencePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePathExtension: + title: tt_StorageReferencePathExtension + type: object + description: '' + xml: + name: StorageReferencePathExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolygonOptions: + title: tt_PolygonOptions + type: object + properties: + RectangleOnly: + type: boolean + description: >- + True if the device supports defining a region only using Rectangle. + + The rectangle points are still passed using a Polygon element if the device does not support polygon regions. In this case, the points provided in the Polygon element shall represent a rectangle. + xml: + name: RectangleOnly + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VertexLimits: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: >- + Provides the minimum and maximum number of points that can be defined in the Polygon. + + If RectangleOnly is not set to true, this parameter is required. + xml: + name: VertexLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolygonOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xmime_base64Binary: + title: xmime_base64Binary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: base64Binary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + xmime_hexBinary: + title: xmime_hexBinary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: hexBinary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + soapenv_Envelope: + title: soapenv_Envelope + required: + - Body + type: object + properties: + Header: + allOf: + - $ref: '#/components/schemas/soapenv_Header' + - xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Body: + allOf: + - $ref: '#/components/schemas/soapenv_Body' + - xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: Envelope + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Header: + title: soapenv_Header + type: object + description: Elements replacing the wildcard MUST be namespace qualified, but can be in the targetNamespace + xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Body: + title: soapenv_Body + type: object + description: '' + xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Fault: + title: soapenv_Fault + required: + - Code + - Reason + type: object + properties: + Code: + allOf: + - $ref: '#/components/schemas/soapenv_faultcode' + - xml: + name: Code + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Reason: + allOf: + - $ref: '#/components/schemas/soapenv_faultreason' + - xml: + name: Reason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Node: + type: string + xml: + name: Node + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Role: + type: string + xml: + name: Role + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Detail: + allOf: + - $ref: '#/components/schemas/soapenv_detail' + - xml: + name: Detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: Fault reporting structure + xml: + name: Fault + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultreason: + title: soapenv_faultreason + required: + - Text + type: object + properties: + Text: + type: array + items: + $ref: '#/components/schemas/soapenv_reasontext' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultreason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_reasontext: + title: soapenv_reasontext + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: reasontext + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcode: + title: soapenv_faultcode + required: + - Value + type: object + properties: + Value: + allOf: + - $ref: '#/components/schemas/soapenv_faultcodeEnum' + - xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcodeEnum: + title: soapenv_faultcodeEnum + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + type: string + description: '' + xml: + name: faultcodeEnum + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_subcode: + title: soapenv_subcode + required: + - Value + type: object + properties: + Value: + type: string + xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_detail: + title: soapenv_detail + type: object + description: '' + xml: + name: detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_NotUnderstoodType: + title: soapenv_NotUnderstoodType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: NotUnderstoodType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_SupportedEnvType: + title: soapenv_SupportedEnvType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: SupportedEnvType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_UpgradeType: + title: soapenv_UpgradeType + required: + - SupportedEnvelope + type: object + properties: + SupportedEnvelope: + type: array + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: UpgradeType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + wsnt_QueryExpressionType: + title: wsnt_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_TopicExpressionType: + title: wsnt_TopicExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_FilterType: + title: wsnt_FilterType + type: object + description: '' + xml: + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicyType: + title: wsnt_SubscriptionPolicyType + type: object + description: '' + xml: + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationProducerRP: + title: wsnt_NotificationProducerRP + type: object + properties: + TopicExpression: + type: array + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + default: true + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsa_EndpointReferenceType: + title: wsa_EndpointReferenceType + required: + - Address + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsnt_SubscriptionManagerRP: + title: wsnt_SubscriptionManagerRP + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CreationTime: + type: string + format: date-time + xml: + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationMessageHolderType: + title: wsnt_NotificationMessageHolderType + required: + - Message + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Notify: + title: wsnt_Notify + required: + - NotificationMessage + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UseRaw: + title: wsnt_UseRaw + type: object + description: '' + xml: + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Subscribe: + title: wsnt_Subscribe + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeResponse: + title: wsnt_SubscribeResponse + required: + - SubscriptionReference + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessage: + title: wsnt_GetCurrentMessage + required: + - Topic + type: object + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessageResponse: + title: wsnt_GetCurrentMessageResponse + type: object + description: '' + xml: + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + title: wsnt_SubscribeCreationFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidFilterFaultType: + title: wsnt_InvalidFilterFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - UnknownFilter + type: object + properties: + UnknownFilter: + type: array + items: + type: string + xml: + name: UnknownFilter + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicExpressionDialectUnknownFaultType: + title: wsnt_TopicExpressionDialectUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidTopicExpressionFaultType: + title: wsnt_InvalidTopicExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicNotSupportedFaultType: + title: wsnt_TopicNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_MultipleTopicsSpecifiedFaultType: + title: wsnt_MultipleTopicsSpecifiedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidProducerPropertiesExpressionFaultType: + title: wsnt_InvalidProducerPropertiesExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidMessageContentExpressionFaultType: + title: wsnt_InvalidMessageContentExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnrecognizedPolicyRequestFaultType: + title: wsnt_UnrecognizedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnrecognizedPolicy: + type: array + items: + type: string + xml: + name: UnrecognizedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnsupportedPolicyRequestFaultType: + title: wsnt_UnsupportedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnsupportedPolicy: + type: array + items: + type: string + xml: + name: UnsupportedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NotifyMessageNotSupportedFaultType: + title: wsnt_NotifyMessageNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnacceptableInitialTerminationTimeFaultType: + title: wsnt_UnacceptableInitialTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NoCurrentMessageOnTopicFaultType: + title: wsnt_NoCurrentMessageOnTopicFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_GetMessages: + title: wsnt_GetMessages + type: object + properties: + MaximumNumber: + type: integer + format: int32 + xml: + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetMessagesResponse: + title: wsnt_GetMessagesResponse + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPoint: + title: wsnt_DestroyPullPoint + type: object + description: '' + xml: + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPointResponse: + title: wsnt_DestroyPullPointResponse + type: object + description: '' + xml: + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToGetMessagesFaultType: + title: wsnt_UnableToGetMessagesFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnableToDestroyPullPointFaultType: + title: wsnt_UnableToDestroyPullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_CreatePullPoint: + title: wsnt_CreatePullPoint + type: object + description: '' + xml: + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_CreatePullPointResponse: + title: wsnt_CreatePullPointResponse + required: + - PullPoint + type: object + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToCreatePullPointFaultType: + title: wsnt_UnableToCreatePullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Renew: + title: wsnt_Renew + required: + - TerminationTime + type: object + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_RenewResponse: + title: wsnt_RenewResponse + required: + - TerminationTime + type: object + properties: + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnacceptableTerminationTimeFaultType: + title: wsnt_UnacceptableTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Unsubscribe: + title: wsnt_Unsubscribe + type: object + description: '' + xml: + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnsubscribeResponse: + title: wsnt_UnsubscribeResponse + type: object + description: '' + xml: + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToDestroySubscriptionFaultType: + title: wsnt_UnableToDestroySubscriptionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_PauseSubscription: + title: wsnt_PauseSubscription + type: object + description: '' + xml: + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseSubscriptionResponse: + title: wsnt_PauseSubscriptionResponse + type: object + description: '' + xml: + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscription: + title: wsnt_ResumeSubscription + type: object + description: '' + xml: + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscriptionResponse: + title: wsnt_ResumeSubscriptionResponse + type: object + description: '' + xml: + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseFailedFaultType: + title: wsnt_PauseFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_ResumeFailedFaultType: + title: wsnt_ResumeFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xop_Include: + title: xop_Include + required: + - href + type: object + properties: + href: + type: string + xml: + name: href + prefix: xop + attribute: true + wrapped: false + description: '' + xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + wsa_ReferenceParametersType: + title: wsa_ReferenceParametersType + type: object + description: '' + xml: + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_MetadataType: + title: wsa_MetadataType + type: object + description: '' + xml: + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedURIType: + title: wsa_AttributedURIType + type: object + description: '' + xml: + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelatesToType: + title: wsa_RelatesToType + type: object + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + name: RelationshipType + attribute: true + wrapped: false + description: '' + xml: + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelationshipTypeOpenEnum: + title: wsa_RelationshipTypeOpenEnum + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + description: '' + xml: + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_FaultCodesOpenEnumType: + title: wsa_FaultCodesOpenEnumType + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + description: '' + xml: + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedQNameType: + title: wsa_AttributedQNameType + type: object + description: '' + xml: + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedAnyType: + title: wsa_AttributedAnyType + type: object + description: '' + xml: + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ProblemActionType: + title: wsa_ProblemActionType + type: object + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + SoapAction: + type: string + xml: + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsrf-bf_BaseFaultType: + title: wsrf-bf_BaseFaultType + required: + - Timestamp + type: object + properties: + Timestamp: + type: string + format: date-time + xml: + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Description: + type: array + items: + $ref: '#/components/schemas/wsrf-bf_Description' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + description: '' + xml: + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Documentation: + title: wstop_Documentation + type: object + description: '' + xml: + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_ExtensibleDocumented: + title: wstop_ExtensibleDocumented + type: object + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_QueryExpressionType: + title: wstop_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_TopicNamespaceType: + title: wstop_TopicNamespaceType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - targetNamespace + type: object + properties: + Topic: + type: array + items: + $ref: '#/components/schemas/wstop_Topic' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + name: + type: string + xml: + name: name + attribute: true + wrapped: false + targetNamespace: + type: string + xml: + name: targetNamespace + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + name: final + attribute: true + wrapped: false + xml: + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicType: + title: wstop_TopicType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - name + type: object + properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - {} + name: + type: string + xml: + attribute: true + wrapped: false + messageTypes: + type: array + items: + type: string + description: '' + xml: + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + attribute: true + wrapped: false + xml: + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicSetType: + title: wstop_TopicSetType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + AddConfigurationRequest: + title: AddConfigurationRequest + required: + - AddConfiguration + type: object + properties: + AddConfiguration: + allOf: + - $ref: '#/components/schemas/tns_AddConfiguration' + - {} + AddConfigurationResponse: + title: AddConfigurationResponse + required: + - AddConfigurationResponse + type: object + properties: + AddConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_AddConfigurationResponse' + - xml: + name: AddConfigurationResponse + attribute: false + wrapped: false + xml: + name: AddConfigurationResponse + attribute: false + wrapped: false + Choice0: + title: Choice0 + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice1: + title: Choice1 + type: object + properties: + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice2: + title: Choice2 + type: object + properties: + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice3: + title: Choice3 + type: object + properties: + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CreateMaskRequest: + title: CreateMaskRequest + required: + - CreateMask + type: object + properties: + CreateMask: + allOf: + - $ref: '#/components/schemas/tns_CreateMask' + - {} + CreateMaskResponse: + title: CreateMaskResponse + required: + - CreateMaskResponse + type: object + properties: + CreateMaskResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateMaskResponse' + - xml: + name: CreateMaskResponse + attribute: false + wrapped: false + xml: + name: CreateMaskResponse + attribute: false + wrapped: false + CreateOSDRequest: + title: CreateOSDRequest + required: + - CreateOSD + type: object + properties: + CreateOSD: + allOf: + - $ref: '#/components/schemas/tns_CreateOSD' + - {} + CreateOSDResponse: + title: CreateOSDResponse + required: + - CreateOSDResponse + type: object + properties: + CreateOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateOSDResponse' + - xml: + name: CreateOSDResponse + attribute: false + wrapped: false + xml: + name: CreateOSDResponse + attribute: false + wrapped: false + CreateProfileRequest: + title: CreateProfileRequest + required: + - CreateProfile + type: object + properties: + CreateProfile: + allOf: + - $ref: '#/components/schemas/tns_CreateProfile' + - {} + CreateProfileResponse: + title: CreateProfileResponse + required: + - CreateProfileResponse + type: object + properties: + CreateProfileResponse: + allOf: + - $ref: '#/components/schemas/tns_CreateProfileResponse' + - xml: + name: CreateProfileResponse + attribute: false + wrapped: false + xml: + name: CreateProfileResponse + attribute: false + wrapped: false + DeleteMaskRequest: + title: DeleteMaskRequest + required: + - DeleteMask + type: object + properties: + DeleteMask: + allOf: + - $ref: '#/components/schemas/tns_DeleteMask' + - {} + DeleteMaskResponse: + title: DeleteMaskResponse + required: + - DeleteMaskResponse + type: object + properties: + DeleteMaskResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: DeleteMaskResponse + attribute: false + wrapped: false + xml: + name: DeleteMaskResponse + attribute: false + wrapped: false + DeleteOSDRequest: + title: DeleteOSDRequest + required: + - DeleteOSD + type: object + properties: + DeleteOSD: + allOf: + - $ref: '#/components/schemas/tns_DeleteOSD' + - {} + DeleteOSDResponse: + title: DeleteOSDResponse + required: + - DeleteOSDResponse + type: object + properties: + DeleteOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: DeleteOSDResponse + attribute: false + wrapped: false + xml: + name: DeleteOSDResponse + attribute: false + wrapped: false + DeleteProfileRequest: + title: DeleteProfileRequest + required: + - DeleteProfile + type: object + properties: + DeleteProfile: + allOf: + - $ref: '#/components/schemas/tns_DeleteProfile' + - {} + DeleteProfileResponse: + title: DeleteProfileResponse + required: + - DeleteProfileResponse + type: object + properties: + DeleteProfileResponse: + allOf: + - $ref: '#/components/schemas/tns_DeleteProfileResponse' + - xml: + name: DeleteProfileResponse + attribute: false + wrapped: false + xml: + name: DeleteProfileResponse + attribute: false + wrapped: false + GetAnalyticsConfigurationsRequest: + title: GetAnalyticsConfigurationsRequest + required: + - GetAnalyticsConfigurations + type: object + properties: + GetAnalyticsConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAnalyticsConfigurationsResponse: + title: GetAnalyticsConfigurationsResponse + required: + - GetAnalyticsConfigurationsResponse + type: object + properties: + GetAnalyticsConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAnalyticsConfigurationsResponse' + - xml: + name: GetAnalyticsConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAnalyticsConfigurationsResponse + attribute: false + wrapped: false + GetAudioDecoderConfigurationOptionsRequest: + title: GetAudioDecoderConfigurationOptionsRequest + required: + - GetAudioDecoderConfigurationOptions + type: object + properties: + GetAudioDecoderConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioDecoderConfigurationOptionsResponse: + title: GetAudioDecoderConfigurationOptionsResponse + required: + - GetAudioDecoderConfigurationOptionsResponse + type: object + properties: + GetAudioDecoderConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurationOptionsResponse' + - xml: + name: GetAudioDecoderConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioDecoderConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioDecoderConfigurationsRequest: + title: GetAudioDecoderConfigurationsRequest + required: + - GetAudioDecoderConfigurations + type: object + properties: + GetAudioDecoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioDecoderConfigurationsResponse: + title: GetAudioDecoderConfigurationsResponse + required: + - GetAudioDecoderConfigurationsResponse + type: object + properties: + GetAudioDecoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioDecoderConfigurationsResponse' + - xml: + name: GetAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioDecoderConfigurationsResponse + attribute: false + wrapped: false + GetAudioEncoderConfigurationOptionsRequest: + title: GetAudioEncoderConfigurationOptionsRequest + required: + - GetAudioEncoderConfigurationOptions + type: object + properties: + GetAudioEncoderConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioEncoderConfigurationOptionsResponse: + title: GetAudioEncoderConfigurationOptionsResponse + required: + - GetAudioEncoderConfigurationOptionsResponse + type: object + properties: + GetAudioEncoderConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurationOptionsResponse' + - xml: + name: GetAudioEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioEncoderConfigurationsRequest: + title: GetAudioEncoderConfigurationsRequest + required: + - GetAudioEncoderConfigurations + type: object + properties: + GetAudioEncoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioEncoderConfigurationsResponse: + title: GetAudioEncoderConfigurationsResponse + required: + - GetAudioEncoderConfigurationsResponse + type: object + properties: + GetAudioEncoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioEncoderConfigurationsResponse' + - xml: + name: GetAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioEncoderConfigurationsResponse + attribute: false + wrapped: false + GetAudioOutputConfigurationOptionsRequest: + title: GetAudioOutputConfigurationOptionsRequest + required: + - GetAudioOutputConfigurationOptions + type: object + properties: + GetAudioOutputConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioOutputConfigurationOptionsResponse: + title: GetAudioOutputConfigurationOptionsResponse + required: + - GetAudioOutputConfigurationOptionsResponse + type: object + properties: + GetAudioOutputConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurationOptionsResponse' + - xml: + name: GetAudioOutputConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioOutputConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioOutputConfigurationsRequest: + title: GetAudioOutputConfigurationsRequest + required: + - GetAudioOutputConfigurations + type: object + properties: + GetAudioOutputConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioOutputConfigurationsResponse: + title: GetAudioOutputConfigurationsResponse + required: + - GetAudioOutputConfigurationsResponse + type: object + properties: + GetAudioOutputConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioOutputConfigurationsResponse' + - xml: + name: GetAudioOutputConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioOutputConfigurationsResponse + attribute: false + wrapped: false + GetAudioSourceConfigurationOptionsRequest: + title: GetAudioSourceConfigurationOptionsRequest + required: + - GetAudioSourceConfigurationOptions + type: object + properties: + GetAudioSourceConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioSourceConfigurationOptionsResponse: + title: GetAudioSourceConfigurationOptionsResponse + required: + - GetAudioSourceConfigurationOptionsResponse + type: object + properties: + GetAudioSourceConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurationOptionsResponse' + - xml: + name: GetAudioSourceConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetAudioSourceConfigurationOptionsResponse + attribute: false + wrapped: false + GetAudioSourceConfigurationsRequest: + title: GetAudioSourceConfigurationsRequest + required: + - GetAudioSourceConfigurations + type: object + properties: + GetAudioSourceConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetAudioSourceConfigurationsResponse: + title: GetAudioSourceConfigurationsResponse + required: + - GetAudioSourceConfigurationsResponse + type: object + properties: + GetAudioSourceConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetAudioSourceConfigurationsResponse' + - xml: + name: GetAudioSourceConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetAudioSourceConfigurationsResponse + attribute: false + wrapped: false + GetMaskOptionsRequest: + title: GetMaskOptionsRequest + required: + - GetMaskOptions + type: object + properties: + GetMaskOptions: + allOf: + - $ref: '#/components/schemas/tns_GetMaskOptions' + - {} + GetMaskOptionsResponse: + title: GetMaskOptionsResponse + required: + - GetMaskOptionsResponse + type: object + properties: + GetMaskOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMaskOptionsResponse' + - xml: + name: GetMaskOptionsResponse + attribute: false + wrapped: false + xml: + name: GetMaskOptionsResponse + attribute: false + wrapped: false + GetMasksRequest: + title: GetMasksRequest + required: + - GetMasks + type: object + properties: + GetMasks: + allOf: + - $ref: '#/components/schemas/tns_GetMasks' + - {} + GetMasksResponse: + title: GetMasksResponse + required: + - GetMasksResponse + type: object + properties: + GetMasksResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMasksResponse' + - xml: + name: GetMasksResponse + attribute: false + wrapped: false + xml: + name: GetMasksResponse + attribute: false + wrapped: false + GetMetadataConfigurationOptionsRequest: + title: GetMetadataConfigurationOptionsRequest + required: + - GetMetadataConfigurationOptions + type: object + properties: + GetMetadataConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetMetadataConfigurationOptionsResponse: + title: GetMetadataConfigurationOptionsResponse + required: + - GetMetadataConfigurationOptionsResponse + type: object + properties: + GetMetadataConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurationOptionsResponse' + - xml: + name: GetMetadataConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetMetadataConfigurationOptionsResponse + attribute: false + wrapped: false + GetMetadataConfigurationsRequest: + title: GetMetadataConfigurationsRequest + required: + - GetMetadataConfigurations + type: object + properties: + GetMetadataConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetMetadataConfigurationsResponse: + title: GetMetadataConfigurationsResponse + required: + - GetMetadataConfigurationsResponse + type: object + properties: + GetMetadataConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetMetadataConfigurationsResponse' + - xml: + name: GetMetadataConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetMetadataConfigurationsResponse + attribute: false + wrapped: false + GetOSDOptionsRequest: + title: GetOSDOptionsRequest + required: + - GetOSDOptions + type: object + properties: + GetOSDOptions: + allOf: + - $ref: '#/components/schemas/tns_GetOSDOptions' + - {} + GetOSDOptionsResponse: + title: GetOSDOptionsResponse + required: + - GetOSDOptionsResponse + type: object + properties: + GetOSDOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetOSDOptionsResponse' + - xml: + name: GetOSDOptionsResponse + attribute: false + wrapped: false + xml: + name: GetOSDOptionsResponse + attribute: false + wrapped: false + GetOSDsRequest: + title: GetOSDsRequest + required: + - GetOSDs + type: object + properties: + GetOSDs: + allOf: + - $ref: '#/components/schemas/tns_GetOSDs' + - {} + GetOSDsResponse: + title: GetOSDsResponse + required: + - GetOSDsResponse + type: object + properties: + GetOSDsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetOSDsResponse' + - xml: + name: GetOSDsResponse + attribute: false + wrapped: false + xml: + name: GetOSDsResponse + attribute: false + wrapped: false + GetProfilesRequest: + title: GetProfilesRequest + required: + - GetProfiles + type: object + properties: + GetProfiles: + allOf: + - $ref: '#/components/schemas/tns_GetProfiles' + - {} + GetProfilesResponse: + title: GetProfilesResponse + required: + - GetProfilesResponse + type: object + properties: + GetProfilesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetProfilesResponse' + - xml: + name: GetProfilesResponse + attribute: false + wrapped: false + xml: + name: GetProfilesResponse + attribute: false + wrapped: false + GetServiceCapabilitiesRequest: + title: GetServiceCapabilitiesRequest + required: + - GetServiceCapabilities + type: object + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + GetServiceCapabilitiesResponse: + title: GetServiceCapabilitiesResponse + required: + - GetServiceCapabilitiesResponse + type: object + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + GetSnapshotUriRequest: + title: GetSnapshotUriRequest + required: + - GetSnapshotUri + type: object + properties: + GetSnapshotUri: + allOf: + - $ref: '#/components/schemas/tns_GetSnapshotUri' + - {} + GetSnapshotUriResponse: + title: GetSnapshotUriResponse + required: + - GetSnapshotUriResponse + type: object + properties: + GetSnapshotUriResponse: + allOf: + - $ref: '#/components/schemas/tns_GetSnapshotUriResponse' + - xml: + name: GetSnapshotUriResponse + attribute: false + wrapped: false + xml: + name: GetSnapshotUriResponse + attribute: false + wrapped: false + GetStreamUriRequest: + title: GetStreamUriRequest + required: + - GetStreamUri + type: object + properties: + GetStreamUri: + allOf: + - $ref: '#/components/schemas/tns_GetStreamUri' + - {} + GetStreamUriResponse: + title: GetStreamUriResponse + required: + - GetStreamUriResponse + type: object + properties: + GetStreamUriResponse: + allOf: + - $ref: '#/components/schemas/tns_GetStreamUriResponse' + - xml: + name: GetStreamUriResponse + attribute: false + wrapped: false + xml: + name: GetStreamUriResponse + attribute: false + wrapped: false + GetVideoEncoderConfigurationOptionsRequest: + title: GetVideoEncoderConfigurationOptionsRequest + required: + - GetVideoEncoderConfigurationOptions + type: object + properties: + GetVideoEncoderConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetVideoEncoderConfigurationOptionsResponse: + title: GetVideoEncoderConfigurationOptionsResponse + required: + - GetVideoEncoderConfigurationOptionsResponse + type: object + properties: + GetVideoEncoderConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurationOptionsResponse' + - xml: + name: GetVideoEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetVideoEncoderConfigurationOptionsResponse + attribute: false + wrapped: false + GetVideoEncoderConfigurationsRequest: + title: GetVideoEncoderConfigurationsRequest + required: + - GetVideoEncoderConfigurations + type: object + properties: + GetVideoEncoderConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetVideoEncoderConfigurationsResponse: + title: GetVideoEncoderConfigurationsResponse + required: + - GetVideoEncoderConfigurationsResponse + type: object + properties: + GetVideoEncoderConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderConfigurationsResponse' + - xml: + name: GetVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetVideoEncoderConfigurationsResponse + attribute: false + wrapped: false + GetVideoEncoderInstancesRequest: + title: GetVideoEncoderInstancesRequest + required: + - GetVideoEncoderInstances + type: object + properties: + GetVideoEncoderInstances: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderInstances' + - {} + GetVideoEncoderInstancesResponse: + title: GetVideoEncoderInstancesResponse + required: + - GetVideoEncoderInstancesResponse + type: object + properties: + GetVideoEncoderInstancesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoEncoderInstancesResponse' + - xml: + name: GetVideoEncoderInstancesResponse + attribute: false + wrapped: false + xml: + name: GetVideoEncoderInstancesResponse + attribute: false + wrapped: false + GetVideoSourceConfigurationOptionsRequest: + title: GetVideoSourceConfigurationOptionsRequest + required: + - GetVideoSourceConfigurationOptions + type: object + properties: + GetVideoSourceConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetVideoSourceConfigurationOptionsResponse: + title: GetVideoSourceConfigurationOptionsResponse + required: + - GetVideoSourceConfigurationOptionsResponse + type: object + properties: + GetVideoSourceConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurationOptionsResponse' + - xml: + name: GetVideoSourceConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceConfigurationOptionsResponse + attribute: false + wrapped: false + GetVideoSourceConfigurationsRequest: + title: GetVideoSourceConfigurationsRequest + required: + - GetVideoSourceConfigurations + type: object + properties: + GetVideoSourceConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetVideoSourceConfigurationsResponse: + title: GetVideoSourceConfigurationsResponse + required: + - GetVideoSourceConfigurationsResponse + type: object + properties: + GetVideoSourceConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceConfigurationsResponse' + - xml: + name: GetVideoSourceConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceConfigurationsResponse + attribute: false + wrapped: false + GetVideoSourceModesRequest: + title: GetVideoSourceModesRequest + required: + - GetVideoSourceModes + type: object + properties: + GetVideoSourceModes: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceModes' + - {} + GetVideoSourceModesResponse: + title: GetVideoSourceModesResponse + required: + - GetVideoSourceModesResponse + type: object + properties: + GetVideoSourceModesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetVideoSourceModesResponse' + - xml: + name: GetVideoSourceModesResponse + attribute: false + wrapped: false + xml: + name: GetVideoSourceModesResponse + attribute: false + wrapped: false + RemoveConfigurationRequest: + title: RemoveConfigurationRequest + required: + - RemoveConfiguration + type: object + properties: + RemoveConfiguration: + allOf: + - $ref: '#/components/schemas/tns_RemoveConfiguration' + - {} + RemoveConfigurationResponse: + title: RemoveConfigurationResponse + required: + - RemoveConfigurationResponse + type: object + properties: + RemoveConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_RemoveConfigurationResponse' + - xml: + name: RemoveConfigurationResponse + attribute: false + wrapped: false + xml: + name: RemoveConfigurationResponse + attribute: false + wrapped: false + SetAudioDecoderConfigurationRequest: + title: SetAudioDecoderConfigurationRequest + required: + - SetAudioDecoderConfiguration + type: object + properties: + SetAudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioDecoderConfiguration' + - {} + SetAudioDecoderConfigurationResponse: + title: SetAudioDecoderConfigurationResponse + required: + - SetAudioDecoderConfigurationResponse + type: object + properties: + SetAudioDecoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioDecoderConfigurationResponse + attribute: false + wrapped: false + SetAudioEncoderConfigurationRequest: + title: SetAudioEncoderConfigurationRequest + required: + - SetAudioEncoderConfiguration + type: object + properties: + SetAudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioEncoderConfiguration' + - {} + SetAudioEncoderConfigurationResponse: + title: SetAudioEncoderConfigurationResponse + required: + - SetAudioEncoderConfigurationResponse + type: object + properties: + SetAudioEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioEncoderConfigurationResponse + attribute: false + wrapped: false + SetAudioOutputConfigurationRequest: + title: SetAudioOutputConfigurationRequest + required: + - SetAudioOutputConfiguration + type: object + properties: + SetAudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioOutputConfiguration' + - {} + SetAudioOutputConfigurationResponse: + title: SetAudioOutputConfigurationResponse + required: + - SetAudioOutputConfigurationResponse + type: object + properties: + SetAudioOutputConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetAudioOutputConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioOutputConfigurationResponse + attribute: false + wrapped: false + SetAudioSourceConfigurationRequest: + title: SetAudioSourceConfigurationRequest + required: + - SetAudioSourceConfiguration + type: object + properties: + SetAudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetAudioSourceConfiguration' + - {} + SetAudioSourceConfigurationResponse: + title: SetAudioSourceConfigurationResponse + required: + - SetAudioSourceConfigurationResponse + type: object + properties: + SetAudioSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetAudioSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetAudioSourceConfigurationResponse + attribute: false + wrapped: false + SetMaskRequest: + title: SetMaskRequest + required: + - SetMask + type: object + properties: + SetMask: + allOf: + - $ref: '#/components/schemas/tns_SetMask' + - {} + SetMaskResponse: + title: SetMaskResponse + required: + - SetMaskResponse + type: object + properties: + SetMaskResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetMaskResponse + attribute: false + wrapped: false + xml: + name: SetMaskResponse + attribute: false + wrapped: false + SetMetadataConfigurationRequest: + title: SetMetadataConfigurationRequest + required: + - SetMetadataConfiguration + type: object + properties: + SetMetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetMetadataConfiguration' + - {} + SetMetadataConfigurationResponse: + title: SetMetadataConfigurationResponse + required: + - SetMetadataConfigurationResponse + type: object + properties: + SetMetadataConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetMetadataConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetMetadataConfigurationResponse + attribute: false + wrapped: false + SetOSDRequest: + title: SetOSDRequest + required: + - SetOSD + type: object + properties: + SetOSD: + allOf: + - $ref: '#/components/schemas/tns_SetOSD' + - {} + SetOSDResponse: + title: SetOSDResponse + required: + - SetOSDResponse + type: object + properties: + SetOSDResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetOSDResponse + attribute: false + wrapped: false + xml: + name: SetOSDResponse + attribute: false + wrapped: false + SetSynchronizationPointRequest: + title: SetSynchronizationPointRequest + required: + - SetSynchronizationPoint + type: object + properties: + SetSynchronizationPoint: + allOf: + - $ref: '#/components/schemas/tns_SetSynchronizationPoint' + - {} + SetSynchronizationPointResponse: + title: SetSynchronizationPointResponse + required: + - SetSynchronizationPointResponse + type: object + properties: + SetSynchronizationPointResponse: + allOf: + - $ref: '#/components/schemas/tns_SetSynchronizationPointResponse' + - xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + xml: + name: SetSynchronizationPointResponse + attribute: false + wrapped: false + SetVideoEncoderConfigurationRequest: + title: SetVideoEncoderConfigurationRequest + required: + - SetVideoEncoderConfiguration + type: object + properties: + SetVideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetVideoEncoderConfiguration' + - {} + SetVideoEncoderConfigurationResponse: + title: SetVideoEncoderConfigurationResponse + required: + - SetVideoEncoderConfigurationResponse + type: object + properties: + SetVideoEncoderConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetVideoEncoderConfigurationResponse + attribute: false + wrapped: false + SetVideoSourceConfigurationRequest: + title: SetVideoSourceConfigurationRequest + required: + - SetVideoSourceConfiguration + type: object + properties: + SetVideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceConfiguration' + - {} + SetVideoSourceConfigurationResponse: + title: SetVideoSourceConfigurationResponse + required: + - SetVideoSourceConfigurationResponse + type: object + properties: + SetVideoSourceConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetVideoSourceConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetVideoSourceConfigurationResponse + attribute: false + wrapped: false + SetVideoSourceModeRequest: + title: SetVideoSourceModeRequest + required: + - SetVideoSourceMode + type: object + properties: + SetVideoSourceMode: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceMode' + - {} + SetVideoSourceModeResponse: + title: SetVideoSourceModeResponse + required: + - SetVideoSourceModeResponse + type: object + properties: + SetVideoSourceModeResponse: + allOf: + - $ref: '#/components/schemas/tns_SetVideoSourceModeResponse' + - xml: + name: SetVideoSourceModeResponse + attribute: false + wrapped: false + xml: + name: SetVideoSourceModeResponse + attribute: false + wrapped: false + StartMulticastStreamingRequest: + title: StartMulticastStreamingRequest + required: + - StartMulticastStreaming + type: object + properties: + StartMulticastStreaming: + allOf: + - $ref: '#/components/schemas/tns_StartStopMulticastStreaming' + - {} + StartMulticastStreamingResponse: + title: StartMulticastStreamingResponse + required: + - StartMulticastStreamingResponse + type: object + properties: + StartMulticastStreamingResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: StartMulticastStreamingResponse + attribute: false + wrapped: false + xml: + name: StartMulticastStreamingResponse + attribute: false + wrapped: false + StopMulticastStreamingRequest: + title: StopMulticastStreamingRequest + required: + - StopMulticastStreaming + type: object + properties: + StopMulticastStreaming: + allOf: + - $ref: '#/components/schemas/tns_StartStopMulticastStreaming' + - {} + StopMulticastStreamingResponse: + title: StopMulticastStreamingResponse + required: + - StopMulticastStreamingResponse + type: object + properties: + StopMulticastStreamingResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: StopMulticastStreamingResponse + attribute: false + wrapped: false + xml: + name: StopMulticastStreamingResponse + attribute: false + wrapped: false + tns1_space: + title: tns1_space + enum: + - default + - preserve + type: string + description: '' + xml: + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + attribute: false + wrapped: false + tt_ColorCluster: + title: tt_ColorCluster + required: + - Color + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Weight: + type: number + xml: + name: Weight + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Covariance: + allOf: + - $ref: '#/components/schemas/tt_ColorCovariance' + - xml: + name: Covariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorCluster + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice0: + title: tt_ColorOptionsChoice0 + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice1: + title: tt_ColorOptionsChoice1 + type: object + properties: + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItem: + title: tt_ElementItem + required: + - Name + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + description: Complex value structure. + xml: + name: ElementItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItemDescription: + title: tt_ElementItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: The type of the item. The Type must reference a defined type. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a complex type. The Type must reference a defined type. + xml: + name: ElementItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Messages: + title: tt_Messages + allOf: + - $ref: '#/components/schemas/tt_MessageDescription' + - required: + - ParentTopic + type: object + properties: + ParentTopic: + type: string + description: The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected. + xml: + name: ParentTopic + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Messages + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + tt_SimpleItem: + title: tt_SimpleItem + required: + - Name + - Value + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Value: + type: string + description: Item value. The type is defined in the corresponding description. + xml: + name: Value + prefix: tt + attribute: true + wrapped: false + description: Value name pair as defined by the corresponding description. + xml: + name: SimpleItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SimpleItemDescription: + title: tt_SimpleItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + name: SimpleItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SubscriptionPolicy: + title: tt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + wsnt_Message: + title: wsnt_Message + type: object + description: '' + xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicy: + title: wsnt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsrf-bf_Description: + title: wsrf-bf_Description + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_ErrorCode: + title: wsrf-bf_ErrorCode + required: + - dialect + type: object + properties: + dialect: + type: string + xml: + name: dialect + attribute: true + wrapped: false + description: '' + xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_FaultCause: + title: wsrf-bf_FaultCause + type: object + description: '' + xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Topic: + title: wstop_Topic + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - type: object + properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + name: parent + attribute: true + wrapped: false + xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object +tags: +- name: Media2Binding + description: '' diff --git a/doc/openapi/ref/ptz.yaml b/doc/openapi/ref/ptz.yaml new file mode 100644 index 00000000..414a7259 --- /dev/null +++ b/doc/openapi/ref/ptz.yaml @@ -0,0 +1,23668 @@ +openapi: 3.0.0 +info: + title: PTZService + contact: {} + version: '1.0' +servers: +- url: https://{defaultHost} + variables: + defaultHost: + default: www.example.com +paths: + /GetServiceCapabilities: + post: + tags: + - PTZBinding + summary: GetServiceCapabilities + description: Returns the capabilities of the PTZ service. The result is returned in a typed answer. + operationId: GetServiceCapabilities + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesRequest' + - xml: + name: GetServiceCapabilitiesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + deprecated: false + /GetNodes: + post: + tags: + - PTZBinding + summary: GetNodes + description: Get the descriptions of the available PTZ Nodes. + operationId: GetNodes + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNodesRequest' + - xml: + name: GetNodesRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNodesResponse' + - xml: + name: GetNodesResponse + attribute: false + wrapped: false + deprecated: false + /GetNode: + post: + tags: + - PTZBinding + summary: GetNode + description: >- + Get a specific PTZ Node identified by a reference + token or a name. + operationId: GetNode + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNodeRequest' + - xml: + name: GetNodeRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetNodeResponse' + - xml: + name: GetNodeResponse + attribute: false + wrapped: false + deprecated: false + /GetConfiguration: + post: + tags: + - PTZBinding + summary: GetConfiguration + description: Get a specific PTZconfiguration from the device, identified by its reference token or name. + operationId: GetConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetConfigurationRequest' + - xml: + name: GetConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetConfigurationResponse' + - xml: + name: GetConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetConfigurations: + post: + tags: + - PTZBinding + summary: GetConfigurations + description: Get all the existing PTZConfigurations from the device. + operationId: GetConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetConfigurationsRequest' + - xml: + name: GetConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetConfigurationsResponse' + - xml: + name: GetConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /SetConfiguration: + post: + tags: + - PTZBinding + summary: SetConfiguration + description: Set/update a existing PTZConfiguration on the device. + operationId: SetConfiguration + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetConfigurationRequest' + - xml: + name: SetConfigurationRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetConfigurationResponse' + - xml: + name: SetConfigurationResponse + attribute: false + wrapped: false + deprecated: false + /GetConfigurationOptions: + post: + tags: + - PTZBinding + summary: GetConfigurationOptions + 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. + operationId: GetConfigurationOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetConfigurationOptionsRequest' + - xml: + name: GetConfigurationOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetConfigurationOptionsResponse' + - xml: + name: GetConfigurationOptionsResponse + attribute: false + wrapped: false + deprecated: false + /SendAuxiliaryCommand: + post: + tags: + - PTZBinding + summary: SendAuxiliaryCommand + 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 + operationId: SendAuxiliaryCommand + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SendAuxiliaryCommandRequest' + - xml: + name: SendAuxiliaryCommandRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SendAuxiliaryCommandResponse' + - xml: + name: SendAuxiliaryCommandResponse + attribute: false + wrapped: false + deprecated: false + /GetPresets: + post: + tags: + - PTZBinding + summary: GetPresets + 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. + operationId: GetPresets + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetsRequest' + - xml: + name: GetPresetsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetsResponse' + - xml: + name: GetPresetsResponse + attribute: false + wrapped: false + deprecated: false + /SetPreset: + post: + tags: + - PTZBinding + summary: SetPreset + 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. + operationId: SetPreset + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetPresetRequest' + - xml: + name: SetPresetRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetPresetResponse' + - xml: + name: SetPresetResponse + attribute: false + wrapped: false + deprecated: false + /RemovePreset: + post: + tags: + - PTZBinding + summary: RemovePreset + 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. + operationId: RemovePreset + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemovePresetRequest' + - xml: + name: RemovePresetRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemovePresetResponse' + - xml: + name: RemovePresetResponse + attribute: false + wrapped: false + deprecated: false + /GotoPreset: + post: + tags: + - PTZBinding + summary: GotoPreset + 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. + operationId: GotoPreset + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GotoPresetRequest' + - xml: + name: GotoPresetRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GotoPresetResponse' + - xml: + name: GotoPresetResponse + attribute: false + wrapped: false + deprecated: false + /GotoHomePosition: + post: + tags: + - PTZBinding + summary: GotoHomePosition + 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. + operationId: GotoHomePosition + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GotoHomePositionRequest' + - xml: + name: GotoHomePositionRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GotoHomePositionResponse' + - xml: + name: GotoHomePositionResponse + attribute: false + wrapped: false + deprecated: false + /SetHomePosition: + post: + tags: + - PTZBinding + summary: SetHomePosition + 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. + operationId: SetHomePosition + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetHomePositionRequest' + - xml: + name: SetHomePositionRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/SetHomePositionResponse' + - xml: + name: SetHomePositionResponse + attribute: false + wrapped: false + deprecated: false + /ContinuousMove: + post: + tags: + - PTZBinding + summary: ContinuousMove + 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. + operationId: ContinuousMove + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ContinuousMoveRequest' + - xml: + name: ContinuousMoveRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ContinuousMoveResponse' + - xml: + name: ContinuousMoveResponse + attribute: false + wrapped: false + deprecated: false + /RelativeMove: + post: + tags: + - PTZBinding + summary: RelativeMove + 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. + operationId: RelativeMove + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RelativeMoveRequest' + - xml: + name: RelativeMoveRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RelativeMoveResponse' + - xml: + name: RelativeMoveResponse + attribute: false + wrapped: false + deprecated: false + /GetStatus: + post: + tags: + - PTZBinding + summary: GetStatus + description: >- + Operation to request PTZ status for the Node in the + selected profile. + operationId: GetStatus + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStatusRequest' + - xml: + name: GetStatusRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetStatusResponse' + - xml: + name: GetStatusResponse + attribute: false + wrapped: false + deprecated: false + /AbsoluteMove: + post: + tags: + - PTZBinding + summary: AbsoluteMove + description: Operation to move pan,tilt or zoom to a absolute destination. + operationId: AbsoluteMove + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AbsoluteMoveRequest' + - xml: + name: AbsoluteMoveRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/AbsoluteMoveResponse' + - xml: + name: AbsoluteMoveResponse + attribute: false + wrapped: false + deprecated: false + /GeoMove: + post: + tags: + - PTZBinding + summary: GeoMove + description: Operation to move pan,tilt or zoom to point to a destination based on the geolocation of the target. + operationId: GeoMove + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GeoMoveRequest' + - xml: + name: GeoMoveRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GeoMoveResponse' + - xml: + name: GeoMoveResponse + attribute: false + wrapped: false + deprecated: false + /Stop: + post: + tags: + - PTZBinding + summary: Stop + 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. + operationId: Stop + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopRequest' + - xml: + name: StopRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/StopResponse' + - xml: + name: StopResponse + attribute: false + wrapped: false + deprecated: false + /GetPresetTours: + post: + tags: + - PTZBinding + summary: GetPresetTours + description: Operation to request PTZ preset tours in the selected media profiles. + operationId: GetPresetTours + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetToursRequest' + - xml: + name: GetPresetToursRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetToursResponse' + - xml: + name: GetPresetToursResponse + attribute: false + wrapped: false + deprecated: false + /GetPresetTour: + post: + tags: + - PTZBinding + summary: GetPresetTour + description: Operation to request a specific PTZ preset tour in the selected media profile. + operationId: GetPresetTour + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetTourRequest' + - xml: + name: GetPresetTourRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetTourResponse' + - xml: + name: GetPresetTourResponse + attribute: false + wrapped: false + deprecated: false + /GetPresetTourOptions: + post: + tags: + - PTZBinding + summary: GetPresetTourOptions + description: Operation to request available options to configure PTZ preset tour. + operationId: GetPresetTourOptions + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetTourOptionsRequest' + - xml: + name: GetPresetTourOptionsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetPresetTourOptionsResponse' + - xml: + name: GetPresetTourOptionsResponse + attribute: false + wrapped: false + deprecated: false + /CreatePresetTour: + post: + tags: + - PTZBinding + summary: CreatePresetTour + description: Operation to create a preset tour for the selected media profile. + operationId: CreatePresetTour + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreatePresetTourRequest' + - xml: + name: CreatePresetTourRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/CreatePresetTourResponse' + - xml: + name: CreatePresetTourResponse + attribute: false + wrapped: false + deprecated: false + /ModifyPresetTour: + post: + tags: + - PTZBinding + summary: ModifyPresetTour + description: Operation to modify a preset tour for the selected media profile. + operationId: ModifyPresetTour + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ModifyPresetTourRequest' + - xml: + name: ModifyPresetTourRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/ModifyPresetTourResponse' + - xml: + name: ModifyPresetTourResponse + attribute: false + wrapped: false + deprecated: false + /OperatePresetTour: + post: + tags: + - PTZBinding + summary: OperatePresetTour + description: Operation to perform specific operation on the preset tour in selected media profile. + operationId: OperatePresetTour + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/OperatePresetTourRequest' + - xml: + name: OperatePresetTourRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/OperatePresetTourResponse' + - xml: + name: OperatePresetTourResponse + attribute: false + wrapped: false + deprecated: false + /RemovePresetTour: + post: + tags: + - PTZBinding + summary: RemovePresetTour + description: Operation to delete a specific preset tour from the media profile. + operationId: RemovePresetTour + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemovePresetTourRequest' + - xml: + name: RemovePresetTourRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/RemovePresetTourResponse' + - xml: + name: RemovePresetTourResponse + attribute: false + wrapped: false + deprecated: false + /GetCompatibleConfigurations: + post: + tags: + - PTZBinding + summary: GetCompatibleConfigurations + description: Operation to get all available PTZConfigurations that can be added to the referenced media profile. + operationId: GetCompatibleConfigurations + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleConfigurationsRequest' + - xml: + name: GetCompatibleConfigurationsRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/GetCompatibleConfigurationsResponse' + - xml: + name: GetCompatibleConfigurationsResponse + attribute: false + wrapped: false + deprecated: false + /MoveAndStartTracking: + post: + tags: + - PTZBinding + summary: MoveAndStartTracking + 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.' + operationId: MoveAndStartTracking + parameters: [] + requestBody: + description: '' + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/MoveAndStartTrackingRequest' + - xml: + name: MoveAndStartTrackingRequest + attribute: false + wrapped: false + required: true + responses: + '200': + description: Successfully retrieved the response + headers: {} + content: + application/xml: + schema: + allOf: + - $ref: '#/components/schemas/MoveAndStartTrackingResponse' + - xml: + name: MoveAndStartTrackingResponse + attribute: false + wrapped: false + deprecated: false +components: + schemas: + tns_GetServiceCapabilities: + title: tns_GetServiceCapabilities + type: object + description: '' + xml: + name: GetServiceCapabilities + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetServiceCapabilitiesResponse: + title: tns_GetServiceCapabilitiesResponse + required: + - Capabilities + type: object + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/tns_Capabilities' + - description: The capabilities for the PTZ service is returned in the Capabilities element. + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetServiceCapabilitiesResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Capabilities: + title: tns_Capabilities + type: object + properties: + EFlip: + type: boolean + description: Indicates whether or not EFlip is supported. + xml: + name: EFlip + prefix: tns + attribute: true + wrapped: false + Reverse: + type: boolean + description: Indicates whether or not reversing of PT control direction is supported. + xml: + name: Reverse + prefix: tns + attribute: true + wrapped: false + GetCompatibleConfigurations: + type: boolean + description: Indicates support for the GetCompatibleConfigurations command. + xml: + name: GetCompatibleConfigurations + prefix: tns + attribute: true + wrapped: false + MoveStatus: + type: boolean + description: Indicates that the PTZStatus includes MoveStatus information. + xml: + name: MoveStatus + prefix: tns + attribute: true + wrapped: false + StatusPosition: + type: boolean + description: Indicates that the PTZStatus includes Position information. + xml: + name: StatusPosition + prefix: tns + attribute: true + wrapped: false + MoveAndTrack: + type: string + description: Indication of the methods of MoveAndTrack that are supported, acceptable values are defined in tt:MoveAndTrackMethod. + xml: + name: MoveAndTrack + prefix: tns + attribute: true + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetNodes: + title: tns_GetNodes + type: object + description: '' + xml: + name: GetNodes + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetNodesResponse: + title: tns_GetNodesResponse + type: object + properties: + PTZNode: + type: array + items: + $ref: '#/components/schemas/tt_PTZNode' + description: A list of the existing PTZ Nodes on the device. + xml: + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetNodesResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetNode: + title: tns_GetNode + required: + - NodeToken + type: object + properties: + NodeToken: + maxLength: 64 + type: string + description: Token of the requested PTZNode. + xml: + name: NodeToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetNode + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetNodeResponse: + title: tns_GetNodeResponse + required: + - PTZNode + type: object + properties: + PTZNode: + allOf: + - $ref: '#/components/schemas/tt_PTZNode' + - description: A requested PTZNode. + xml: + name: PTZNode + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetNodeResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfigurations: + title: tns_GetConfigurations + type: object + description: '' + xml: + name: GetConfigurations + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfigurationsResponse: + title: tns_GetConfigurationsResponse + type: object + properties: + PTZConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_PTZConfiguration' + description: A list of all existing PTZConfigurations on the device. + xml: + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetConfigurationsResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfiguration: + title: tns_GetConfiguration + required: + - PTZConfigurationToken + type: object + properties: + PTZConfigurationToken: + maxLength: 64 + type: string + description: Token of the requested PTZConfiguration. + xml: + name: PTZConfigurationToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetConfiguration + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfigurationResponse: + title: tns_GetConfigurationResponse + required: + - PTZConfiguration + type: object + properties: + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: A requested PTZConfiguration. + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetConfigurationResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetConfiguration: + title: tns_SetConfiguration + required: + - PTZConfiguration + - ForcePersistence + type: object + properties: + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + ForcePersistence: + type: boolean + description: 'Flag that makes configuration persistent. Example: User wants the configuration to exist after reboot.' + xml: + name: ForcePersistence + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetConfiguration + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetConfigurationResponse: + title: tns_SetConfigurationResponse + type: object + description: '' + xml: + name: SetConfigurationResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfigurationOptions: + title: tns_GetConfigurationOptions + required: + - ConfigurationToken + type: object + properties: + ConfigurationToken: + maxLength: 64 + type: string + description: Token of an existing configuration that the options are intended for. + xml: + name: ConfigurationToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetConfigurationOptions + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetConfigurationOptionsResponse: + title: tns_GetConfigurationOptionsResponse + required: + - PTZConfigurationOptions + type: object + properties: + PTZConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions' + - description: The requested PTZ configuration options. + xml: + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetConfigurationOptionsResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SendAuxiliaryCommand: + title: tns_SendAuxiliaryCommand + required: + - ProfileToken + - AuxiliaryData + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + AuxiliaryData: + maxLength: 128 + type: string + description: The Auxiliary request data. + xml: + name: AuxiliaryData + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SendAuxiliaryCommand + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SendAuxiliaryCommandResponse: + title: tns_SendAuxiliaryCommandResponse + required: + - AuxiliaryResponse + type: object + properties: + AuxiliaryResponse: + maxLength: 128 + type: string + description: The response contains the auxiliary response. + xml: + name: AuxiliaryResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SendAuxiliaryCommandResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresets: + title: tns_GetPresets + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresets + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetsResponse: + title: tns_GetPresetsResponse + type: object + properties: + Preset: + type: array + items: + $ref: '#/components/schemas/tt_PTZPreset' + description: A list of presets which are available for the requested MediaProfile. + xml: + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetsResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetPreset: + title: tns_SetPreset + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetName: + type: string + description: A requested preset name. + xml: + name: PresetName + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetToken: + maxLength: 64 + type: string + description: A requested preset token. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetPreset + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetPresetResponse: + title: tns_SetPresetResponse + required: + - PresetToken + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: A token to the Preset which has been set. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetPresetResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemovePreset: + title: tns_RemovePreset + required: + - ProfileToken + - PresetToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetToken: + maxLength: 64 + type: string + description: A requested preset token. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemovePreset + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemovePresetResponse: + title: tns_RemovePresetResponse + type: object + description: '' + xml: + name: RemovePresetResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GotoPreset: + title: tns_GotoPreset + required: + - ProfileToken + - PresetToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetToken: + maxLength: 64 + type: string + description: A requested preset token. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: A requested speed.The speed parameter can only be specified when Speed Spaces are available for the PTZ Node. + xml: + name: Speed + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GotoPreset + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GotoPresetResponse: + title: tns_GotoPresetResponse + type: object + description: '' + xml: + name: GotoPresetResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStatus: + title: tns_GetStatus + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the PTZStatus should be requested. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStatus + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetStatusResponse: + title: tns_GetStatusResponse + required: + - PTZStatus + type: object + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZStatus' + - description: The PTZStatus for the requested MediaProfile. + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetStatusResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GotoHomePosition: + title: tns_GotoHomePosition + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: A requested speed.The speed parameter can only be specified when Speed Spaces are available for the PTZ Node. + xml: + name: Speed + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GotoHomePosition + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GotoHomePositionResponse: + title: tns_GotoHomePositionResponse + type: object + description: '' + xml: + name: GotoHomePositionResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetHomePosition: + title: tns_SetHomePosition + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the home position should be set. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: SetHomePosition + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_SetHomePositionResponse: + title: tns_SetHomePositionResponse + type: object + description: '' + xml: + name: SetHomePositionResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ContinuousMove: + title: tns_ContinuousMove + required: + - ProfileToken + - Velocity + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Velocity: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: A Velocity vector specifying the velocity of pan, tilt and zoom. + xml: + name: Velocity + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Timeout: + type: string + description: An optional Timeout parameter. + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousMove + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ContinuousMoveResponse: + title: tns_ContinuousMoveResponse + type: object + description: '' + xml: + name: ContinuousMoveResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RelativeMove: + title: tns_RelativeMove + required: + - ProfileToken + - Translation + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Translation: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A positional Translation relative to the current position + xml: + name: Translation + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: An optional Speed parameter. + xml: + name: Speed + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RelativeMove + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RelativeMoveResponse: + title: tns_RelativeMoveResponse + type: object + description: '' + xml: + name: RelativeMoveResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AbsoluteMove: + title: tns_AbsoluteMove + required: + - ProfileToken + - Position + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A Position vector specifying the absolute target position. + xml: + name: Position + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: An optional Speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteMove + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_AbsoluteMoveResponse: + title: tns_AbsoluteMoveResponse + type: object + description: '' + xml: + name: AbsoluteMoveResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GeoMove: + title: tns_GeoMove + required: + - ProfileToken + - Target + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Target: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: The geolocation of the target position. + xml: + name: Target + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: An optional Speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + AreaHeight: + type: number + description: An optional indication of the height of the target/area. + xml: + name: AreaHeight + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + AreaWidth: + type: number + description: An optional indication of the width of the target/area. + xml: + name: AreaWidth + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GeoMove + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GeoMoveResponse: + title: tns_GeoMoveResponse + type: object + description: '' + xml: + name: GeoMoveResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_Stop: + title: tns_Stop + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile that indicate what should be stopped. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PanTilt: + type: boolean + description: Set true when we want to stop ongoing pan and tilt movements.If PanTilt arguments are not present, this command stops these movements. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Zoom: + type: boolean + description: Set true when we want to stop ongoing zoom movement.If Zoom arguments are not present, this command stops ongoing zoom movement. + xml: + name: Zoom + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: Stop + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_StopResponse: + title: tns_StopResponse + type: object + description: '' + xml: + name: StopResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetTours: + title: tns_GetPresetTours + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetTours + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetToursResponse: + title: tns_GetPresetToursResponse + type: object + properties: + PresetTour: + type: array + items: + $ref: '#/components/schemas/tt_PresetTour' + description: '' + xml: + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetToursResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetTour: + title: tns_GetPresetTour + required: + - ProfileToken + - PresetTourToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetTourToken: + maxLength: 64 + type: string + xml: + name: PresetTourToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetTourResponse: + title: tns_GetPresetTourResponse + required: + - PresetTour + type: object + properties: + PresetTour: + allOf: + - $ref: '#/components/schemas/tt_PresetTour' + - xml: + name: PresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetTourResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetTourOptions: + title: tns_GetPresetTourOptions + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetTourToken: + maxLength: 64 + type: string + xml: + name: PresetTourToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetTourOptions + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetPresetTourOptionsResponse: + title: tns_GetPresetTourOptionsResponse + required: + - Options + type: object + properties: + Options: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourOptions' + - xml: + name: Options + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetPresetTourOptionsResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreatePresetTour: + title: tns_CreatePresetTour + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreatePresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_CreatePresetTourResponse: + title: tns_CreatePresetTourResponse + required: + - PresetTourToken + type: object + properties: + PresetTourToken: + maxLength: 64 + type: string + xml: + name: PresetTourToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: CreatePresetTourResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ModifyPresetTour: + title: tns_ModifyPresetTour + required: + - ProfileToken + - PresetTour + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetTour: + allOf: + - $ref: '#/components/schemas/tt_PresetTour' + - xml: + name: PresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: ModifyPresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_ModifyPresetTourResponse: + title: tns_ModifyPresetTourResponse + type: object + description: '' + xml: + name: ModifyPresetTourResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_OperatePresetTour: + title: tns_OperatePresetTour + required: + - ProfileToken + - PresetTourToken + - Operation + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetTourToken: + maxLength: 64 + type: string + xml: + name: PresetTourToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Operation: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourOperation' + - xml: + name: Operation + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: OperatePresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_OperatePresetTourResponse: + title: tns_OperatePresetTourResponse + type: object + description: '' + xml: + name: OperatePresetTourResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemovePresetTour: + title: tns_RemovePresetTour + required: + - ProfileToken + - PresetTourToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetTourToken: + maxLength: 64 + type: string + xml: + name: PresetTourToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: RemovePresetTour + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_RemovePresetTourResponse: + title: tns_RemovePresetTourResponse + type: object + description: '' + xml: + name: RemovePresetTourResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleConfigurations: + title: tns_GetCompatibleConfigurations + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: Contains the token of an existing media profile the configurations shall be compatible with. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleConfigurations + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_GetCompatibleConfigurationsResponse: + title: tns_GetCompatibleConfigurationsResponse + type: object + properties: + PTZConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_PTZConfiguration' + description: A list of all existing PTZConfigurations on the NVT that is suitable to be added to the addressed media profile. + xml: + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: GetCompatibleConfigurationsResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MoveAndStartTracking: + title: tns_MoveAndStartTracking + required: + - ProfileToken + type: object + properties: + ProfileToken: + maxLength: 64 + type: string + description: A reference to the MediaProfile where the operation should take place. + xml: + name: ProfileToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + PresetToken: + maxLength: 64 + type: string + description: A preset token. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: The geolocation of the target position. + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + TargetPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A Position vector specifying the absolute target position. + xml: + name: TargetPosition + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Speed vector specifying the velocity of pan, tilt and zoom. + xml: + name: Speed + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + ObjectID: + type: integer + description: Object ID of the object to track. + format: int32 + xml: + name: ObjectID + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + description: '' + xml: + name: MoveAndStartTracking + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tns_MoveAndStartTrackingResponse: + title: tns_MoveAndStartTrackingResponse + type: object + description: '' + xml: + name: MoveAndStartTrackingResponse + namespace: http://www.onvif.org/ver20/ptz/wsdl + prefix: tns + attribute: false + wrapped: false + tt_IntRange: + title: tt_IntRange + required: + - Min + - Max + type: object + properties: + Min: + type: integer + format: int32 + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: integer + format: int32 + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: IntRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector2D: + title: tt_Vector2D + required: + - x + - y + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Pan/tilt coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector2D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector1D: + title: tt_Vector1D + required: + - x + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + space: + type: string + description: 'Zoom coordinate space selector. The following options are defined:' + xml: + name: space + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector1D + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZVector: + title: tt_PTZVector + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan and the y component to tilt. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom position. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZVector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatus: + title: tt_PTZStatus + required: + - UtcTime + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - 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. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, idle or in an unknown state. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: States a current PTZ error. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UtcTime: + type: string + description: Specifies the UTC time when this status was generated. + format: date-time + xml: + name: UtcTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZMoveStatus: + title: tt_PTZMoveStatus + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZMoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveStatus: + title: tt_MoveStatus + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + description: '' + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Vector: + title: tt_Vector + type: object + properties: + x: + type: number + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Vector + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rectangle: + title: tt_Rectangle + type: object + properties: + bottom: + type: number + xml: + name: bottom + prefix: tt + attribute: true + wrapped: false + top: + type: number + xml: + name: top + prefix: tt + attribute: true + wrapped: false + right: + type: number + xml: + name: right + prefix: tt + attribute: true + wrapped: false + left: + type: number + xml: + name: left + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Rectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polygon: + title: tt_Polygon + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polygon + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Color: + title: tt_Color + required: + - X + - Y + - Z + type: object + properties: + X: + type: number + xml: + name: X + prefix: tt + attribute: true + wrapped: false + Y: + type: number + xml: + name: Y + prefix: tt + attribute: true + wrapped: false + Z: + type: number + xml: + name: Z + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: 'Acceptable values:' + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorCovariance: + title: tt_ColorCovariance + required: + - XX + - YY + - ZZ + type: object + properties: + XX: + type: number + xml: + name: XX + prefix: tt + attribute: true + wrapped: false + YY: + type: number + xml: + name: YY + prefix: tt + attribute: true + wrapped: false + ZZ: + type: number + xml: + name: ZZ + prefix: tt + attribute: true + wrapped: false + XY: + type: number + xml: + name: XY + prefix: tt + attribute: true + wrapped: false + XZ: + type: number + xml: + name: XZ + prefix: tt + attribute: true + wrapped: false + YZ: + type: number + xml: + name: YZ + prefix: tt + attribute: true + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: ColorCovariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorDescriptor: + title: tt_ColorDescriptor + type: object + properties: + ColorCluster: + type: array + items: + $ref: '#/components/schemas/tt_ColorCluster' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transformation: + title: tt_Transformation + type: object + properties: + Translate: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Translate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Scale: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Scale + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TransformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransformationExtension: + title: tt_TransformationExtension + type: object + description: '' + xml: + name: TransformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoLocation: + title: tt_GeoLocation + type: object + properties: + lon: + type: number + description: East west location as angle. + xml: + name: lon + prefix: tt + attribute: true + wrapped: false + lat: + type: number + description: North south location as angle. + xml: + name: lat + prefix: tt + attribute: true + wrapped: false + elevation: + type: number + description: Hight in meters above sea level. + xml: + name: elevation + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GeoOrientation: + title: tt_GeoOrientation + type: object + properties: + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + pitch: + type: number + description: Rotation around the y axis. + xml: + name: pitch + prefix: tt + attribute: true + wrapped: false + yaw: + type: number + description: Rotation around the z axis. + xml: + name: yaw + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalLocation: + title: tt_LocalLocation + type: object + properties: + x: + type: number + description: East west location as angle. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: North south location as angle. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + z: + type: number + description: Offset in meters from the sea level. + xml: + name: z + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocalOrientation: + title: tt_LocalOrientation + type: object + properties: + pan: + type: number + description: Rotation around the y axis. + xml: + name: pan + prefix: tt + attribute: true + wrapped: false + tilt: + type: number + description: Rotation around the z axis. + xml: + name: tilt + prefix: tt + attribute: true + wrapped: false + roll: + type: number + description: Rotation around the x axis. + xml: + name: roll + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Entity: + title: tt_Entity + enum: + - Device + - VideoSource + - AudioSource + type: string + description: '' + xml: + name: Entity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LocationEntity: + title: tt_LocationEntity + type: object + properties: + Entity: + type: string + description: Entity type the entry refers to, use a value from the tt:Entity enumeration. + xml: + name: Entity + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + description: Optional entity token. + xml: + name: Token + prefix: tt + attribute: true + wrapped: false + Fixed: + type: boolean + description: If this value is true the entity cannot be deleted. + xml: + name: Fixed + prefix: tt + attribute: true + wrapped: false + GeoSource: + type: string + description: Optional reference to the XAddr of another devices DeviceManagement service. + xml: + name: GeoSource + prefix: tt + attribute: true + wrapped: false + AutoGeo: + type: boolean + description: If set the geo location is obtained internally. + xml: + name: AutoGeo + prefix: tt + attribute: true + wrapped: false + GeoLocation: + allOf: + - $ref: '#/components/schemas/tt_GeoLocation' + - description: Location on earth. + xml: + name: GeoLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GeoOrientation: + allOf: + - $ref: '#/components/schemas/tt_GeoOrientation' + - description: Orientation relative to earth. + xml: + name: GeoOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalLocation: + allOf: + - $ref: '#/components/schemas/tt_LocalLocation' + - description: Indoor location offset. + xml: + name: LocalLocation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalOrientation: + allOf: + - $ref: '#/components/schemas/tt_LocalOrientation' + - description: Indoor orientation offset. + xml: + name: LocalOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LocationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceEntity: + title: tt_DeviceEntity + required: + - token + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier referencing the physical entity. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + description: Base class for physical entities like inputs and outputs. + xml: + name: DeviceEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangle: + title: tt_IntRectangle + required: + - x + - y + - width + - height + type: object + properties: + x: + type: integer + format: int32 + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: integer + format: int32 + xml: + name: y + prefix: tt + attribute: true + wrapped: false + width: + type: integer + format: int32 + xml: + name: width + prefix: tt + attribute: true + wrapped: false + height: + type: integer + format: int32 + xml: + name: height + prefix: tt + attribute: true + wrapped: false + description: Rectangle defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntRectangleRange: + title: tt_IntRectangleRange + required: + - XRange + - YRange + - WidthRange + - HeightRange + type: object + properties: + XRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of X-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of Y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WidthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of width. + xml: + name: WidthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HeightRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of height. + xml: + name: HeightRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of a rectangle. The rectangle itself is defined by lower left corner position and size. Units are pixel. + xml: + name: IntRectangleRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatRange: + title: tt_FloatRange + required: + - Min + - Max + type: object + properties: + Min: + type: number + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: number + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of values greater equal Min value and less equal Max value. + xml: + name: FloatRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DurationRange: + title: tt_DurationRange + required: + - Min + - Max + type: object + properties: + Min: + type: string + format: date-time + xml: + name: Min + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Max: + type: string + format: date-time + xml: + name: Max + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Range of duration greater equal Min duration and less equal Max duration. + xml: + name: DurationRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IntItems: + title: tt_IntItems + type: object + properties: + Items: + type: array + items: + type: integer + format: int32 + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: List of values. + xml: + name: IntItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FloatItems: + title: tt_FloatItems + type: object + properties: + Items: + type: array + items: + type: number + xml: + name: Items + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FloatItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StringItems: + title: tt_StringItems + required: + - Item + type: object + properties: + Item: + type: array + items: + type: string + xml: + name: Item + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StringItems + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnyHolder: + title: tt_AnyHolder + type: object + description: '' + xml: + name: AnyHolder + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSource: + title: tt_VideoSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Framerate + - Resolution + type: object + properties: + Framerate: + type: number + description: Frame rate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Horizontal and vertical resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings' + - description: Optional configuration of the image sensor. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video input. + tt_VideoSourceExtension: + title: tt_VideoSourceExtension + type: object + properties: + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if imaging service 2.00 is supported. + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceExtension2: + title: tt_VideoSourceExtension2 + type: object + description: '' + xml: + name: VideoSourceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSource: + title: tt_AudioSource + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Channels + type: object + properties: + Channels: + type: integer + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + xml: + name: Channels + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio input. + tt_Profile: + title: tt_Profile + required: + - token + - Name + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of the profile. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: A value of true signals that the profile cannot be deleted. Default is false. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name of the profile. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and rule engine. + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/tt_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + A media profile consists of a set of media configurations. Media profiles are used by a client + to configure properties of a media stream from an NVT. + xml: + name: Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension: + title: tt_ProfileExtension + type: object + properties: + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileExtension2: + title: tt_ProfileExtension2 + type: object + description: '' + xml: + name: ProfileExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfiguration: + title: tt_VideoSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + - Bounds + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Reference to the physical input. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bounds: + allOf: + - $ref: '#/components/schemas/tt_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing area shall not be larger than the whole Video source area. + xml: + name: Bounds + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ViewMode: + type: string + description: Readonly parameter signalling Source configuration's view mode, for devices supporting different view modes as defined in tt:viewModes. + xml: + name: ViewMode + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioSourceConfiguration: + title: tt_AudioSourceConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceToken + type: object + properties: + SourceToken: + maxLength: 64 + type: string + description: Token of the Audio Source the configuration applies to + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioSourceConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncoderConfiguration: + title: tt_VideoEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Configuration' + - description: Optional element to configure H.264 related parameters. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related video stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoderConfiguration: + title: tt_AudioEncoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoAnalyticsConfiguration: + title: tt_VideoAnalyticsConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfiguration' + - xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZConfiguration: + title: tt_PTZConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - NodeToken + type: object + properties: + NodeToken: + maxLength: 64 + type: string + description: A mandatory reference to the PTZ Node that the PTZ Configuration belongs to. + xml: + name: NodeToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsolutePantTiltPositionSpace: + type: string + description: If the PTZ Node supports absolute Pan/Tilt movements, it shall specify one Absolute Pan/Tilt Position Space as default. + xml: + name: DefaultAbsolutePantTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultAbsoluteZoomPositionSpace: + type: string + description: If the PTZ Node supports absolute zoom movements, it shall specify one Absolute Zoom Position Space as default. + xml: + name: DefaultAbsoluteZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativePanTiltTranslationSpace: + type: string + description: If the PTZ Node supports relative Pan/Tilt movements, it shall specify one RelativePan/Tilt Translation Space as default. + xml: + name: DefaultRelativePanTiltTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultRelativeZoomTranslationSpace: + type: string + description: If the PTZ Node supports relative zoom movements, it shall specify one Relative Zoom Translation Space as default. + xml: + name: DefaultRelativeZoomTranslationSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousPanTiltVelocitySpace: + type: string + description: If the PTZ Node supports continuous Pan/Tilt movements, it shall specify one Continuous Pan/Tilt Velocity Space as default. + xml: + name: DefaultContinuousPanTiltVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultContinuousZoomVelocitySpace: + type: string + description: If the PTZ Node supports continuous zoom movements, it shall specify one Continuous Zoom Velocity Space as default. + xml: + name: DefaultContinuousZoomVelocitySpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, it shall specify corresponding default Pan/Tilt and Zoom speeds. + xml: + name: DefaultPTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultPTZTimeout: + type: string + description: If the PTZ Node supports continuous movements, it shall specify a default timeout, after which the movement stops. + format: date-time + xml: + name: DefaultPTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/tt_PanTiltLimits' + - 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. + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomLimits: + allOf: + - $ref: '#/components/schemas/tt_ZoomLimits' + - 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. + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveRamp: + type: integer + description: The optional acceleration ramp used by the device when moving. + format: int32 + xml: + name: MoveRamp + prefix: tt + attribute: true + wrapped: false + PresetRamp: + type: integer + description: The optional acceleration ramp used by the device when recalling presets. + format: int32 + xml: + name: PresetRamp + prefix: tt + attribute: true + wrapped: false + PresetTourRamp: + type: integer + description: The optional acceleration ramp used by the device when executing PresetTours. + format: int32 + xml: + name: PresetTourRamp + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_MetadataConfiguration: + title: tt_MetadataConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Multicast + - SessionTimeout + type: object + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/tt_PTZFilter' + - description: optional element to configure which PTZ related data is to include in the metadata stream + xml: + name: PTZStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventSubscription' + - description: "Optional element to configure the streaming of events. A client might be interested in receiving all, \n none or some of the events produced by the device:" + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Analytics: + type: boolean + description: Defines whether the streamed metadata will include metadata from the analytics engines (video, cell motion, audio etc.) + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SessionTimeout: + type: string + description: The rtsp session timeout for the related audio stream (when using Media2 Service, this value is deprecated and ignored) + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfiguration' + - description: >- + Indication which AnalyticsModules shall output metadata. + Note that the streaming behavior is undefined if the list includes items that are not part of the associated AnalyticsConfiguration. + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CompressionType: + type: string + description: Optional parameter to configure compression type of Metadata payload. Use values from enumeration MetadataCompressionType. + xml: + name: CompressionType + prefix: tt + attribute: true + wrapped: false + GeoLocation: + type: boolean + description: Optional parameter to configure if the metadata stream shall contain the Geo Location coordinates of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + ShapePolygon: + type: boolean + description: Optional parameter to configure if the generated metadata stream should contain shape information as polygon. + xml: + name: ShapePolygon + prefix: tt + attribute: true + wrapped: false + xml: + name: MetadataConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioOutputConfiguration: + title: tt_AudioOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + - OutputLevel + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the phsycial Audio output. + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacy: + type: string + description: >- + An audio channel MAY support different types of audio transmission. While for full duplex + operation no special handling is required, in half duplex operation the transmission direction + needs to be switched. + The optional SendPrimacy parameter inside the AudioOutputConfiguration indicates which + direction is currently active. An NVC can switch between different modes by setting the + AudioOutputConfiguration. + xml: + name: SendPrimacy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevel: + type: integer + description: Volume setting of the output. The applicable range is defined via the option AudioOutputOptions.OutputLevelRange. + format: int32 + xml: + name: OutputLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioDecoderConfiguration: + title: tt_AudioDecoderConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - type: object + xml: + name: AudioDecoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The Audio Decoder Configuration does not contain any that parameter to configure the + + decoding .A decoder shall decode every data it receives (according to its capabilities). + tt_ConfigurationEntity: + title: tt_ConfigurationEntity + required: + - token + - Name + - UseCount + type: object + properties: + token: + maxLength: 64 + type: string + description: Token that uniquely references this configuration. Length up to 64 characters. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: User readable name. Length up to 64 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseCount: + type: integer + description: Number of internal references currently using this configuration. + format: int32 + xml: + name: UseCount + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Base type defining the common properties of a configuration. + xml: + name: ConfigurationEntity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension: + title: tt_VideoSourceConfigurationExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_Rotate' + - description: >- + Optional element to configure rotation of captured image. + What resolutions a device supports shall be unaffected by the Rotate parameters. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationExtension2: + title: tt_VideoSourceConfigurationExtension2 + type: object + properties: + LensDescription: + type: array + items: + $ref: '#/components/schemas/tt_LensDescription' + description: Optional element describing the geometric lens distortion. Multiple instances for future variable lens support. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SceneOrientation: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientation' + - description: Optional element describing the scene orientation in the camera’s field of view. + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Rotate: + title: tt_Rotate + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RotateMode' + - description: Parameter to enable/disable Rotation feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Degree: + type: integer + 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. + format: int32 + xml: + name: Degree + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateExtension: + title: tt_RotateExtension + type: object + description: '' + xml: + name: RotateExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateMode: + title: tt_RotateMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: RotateMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensProjection: + title: tt_LensProjection + required: + - Angle + - Radius + type: object + properties: + Angle: + type: number + description: Angle of incidence. + xml: + name: Angle + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Radius: + type: number + description: Mapping radius as a consequence of the emergent angle. + xml: + name: Radius + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transmittance: + type: number + description: Optional ray absorption at the given angle due to vignetting. A value of one means no absorption. + xml: + name: Transmittance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensProjection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensOffset: + title: tt_LensOffset + type: object + properties: + x: + type: number + description: Optional horizontal offset of the lens center in normalized coordinates. + xml: + name: x + prefix: tt + attribute: true + wrapped: false + y: + type: number + description: Optional vertical offset of the lens center in normalized coordinates. + xml: + name: y + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: LensOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LensDescription: + title: tt_LensDescription + required: + - Offset + - Projection + - XFactor + type: object + properties: + FocalLength: + type: number + description: Optional focal length of the optical system. + xml: + name: FocalLength + prefix: tt + attribute: true + wrapped: false + Offset: + allOf: + - $ref: '#/components/schemas/tt_LensOffset' + - description: Offset of the lens center to the imager center in normalized coordinates. + xml: + name: Offset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Projection: + type: array + items: + $ref: '#/components/schemas/tt_LensProjection' + description: "Radial description of the projection characteristics. The resulting curve is defined by the B-Spline interpolation \n over the given elements. The element for Radius zero shall not be provided. The projection points shall be ordered with ascending Radius. \n Items outside the last projection Radius shall be assumed to be invisible (black)." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XFactor: + type: number + description: Compensation of the x coordinate needed for the ONVIF normalized coordinate system. + xml: + name: XFactor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: LensDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptions: + title: tt_VideoSourceConfigurationOptions + required: + - BoundsRange + - VideoSourceTokensAvailable + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + prefix: tt + attribute: true + wrapped: false + BoundsRange: + allOf: + - $ref: '#/components/schemas/tt_IntRectangleRange' + - description: >- + Supported range for the capturing area. + Device that does not support cropped streaming shall express BoundsRange option as mentioned below + BoundsRange->XRange and BoundsRange->YRange with same Min/Max values HeightRange and WidthRange Min/Max values same as VideoSource Height and Width Limits. + xml: + name: BoundsRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSourceTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: VideoSourceTokensAvailable + attribute: false + wrapped: false + description: List of physical inputs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension: + title: tt_VideoSourceConfigurationOptionsExtension + type: object + properties: + Rotate: + allOf: + - $ref: '#/components/schemas/tt_RotateOptions' + - description: Options of parameters for Rotation feature. + xml: + name: Rotate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoSourceConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoSourceConfigurationOptionsExtension2: + title: tt_VideoSourceConfigurationOptionsExtension2 + type: object + properties: + SceneOrientationMode: + type: array + items: + $ref: '#/components/schemas/tt_SceneOrientationMode' + description: Scene orientation modes supported by the device for this configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoSourceConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptions: + title: tt_RotateOptions + required: + - Mode + type: object + properties: + Reboot: + type: boolean + description: >- + After setting the rotation, if a device starts to reboot this value is true. + If a device can handle rotation setting without rebooting this value is false. + xml: + name: Reboot + prefix: tt + attribute: true + wrapped: false + Mode: + type: array + items: + $ref: '#/components/schemas/tt_RotateMode' + description: Supported options of Rotate mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DegreeList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported degree value for rotation. + xml: + name: DegreeList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RotateOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RotateOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RotateOptionsExtension: + title: tt_RotateOptionsExtension + type: object + description: '' + xml: + name: RotateOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationMode: + title: tt_SceneOrientationMode + enum: + - MANUAL + - AUTO + type: string + description: '' + xml: + name: SceneOrientationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientationOption: + title: tt_SceneOrientationOption + enum: + - Below + - Horizon + - Above + type: string + description: Defines the acceptable values for the Orientation element of the SceneOrientation type + xml: + name: SceneOrientationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SceneOrientation: + title: tt_SceneOrientation + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene orientation. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Orientation: + type: string + description: "Assigned or determined scene orientation based on the Mode. When assigning the Mode to AUTO, this field \n is optional and will be ignored by the device. When assigning the Mode to MANUAL, this field is required \n and the device will return an InvalidArgs fault if missing." + xml: + name: Orientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SceneOrientation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ViewModes: + title: tt_ViewModes + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + type: string + description: Source view modes supported by device. + xml: + name: ViewModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoding: + title: tt_VideoEncoding + enum: + - JPEG + - MPEG4 + - H264 + type: string + description: '' + xml: + name: VideoEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Profile: + title: tt_Mpeg4Profile + enum: + - SP + - ASP + type: string + description: '' + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Profile: + title: tt_H264Profile + enum: + - Baseline + - Main + - Extended + - High + type: string + description: '' + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoResolution: + title: tt_VideoResolution + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl: + title: tt_VideoRateControl + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + type: object + properties: + FrameRateLimit: + type: integer + description: Maximum output framerate in fps. If an EncodingInterval is provided the resulting encoded framerate will be reduced by the given factor. + format: int32 + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingInterval: + type: integer + 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 ...) + format: int32 + xml: + name: EncodingInterval + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Configuration: + title: tt_Mpeg4Configuration + required: + - GovLength + - Mpeg4Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced simple profile (ASP) + xml: + name: Mpeg4Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Configuration: + title: tt_H264Configuration + required: + - GovLength + - H264Profile + type: object + properties: + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264Profile: + allOf: + - $ref: '#/components/schemas/tt_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + xml: + name: H264Profile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderConfigurationOptions: + title: tt_VideoEncoderConfigurationOptions + required: + - QualityRange + type: object + properties: + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoderConfiguration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension element). + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension element). + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension element). + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension: + title: tt_VideoEncoderOptionsExtension + type: object + properties: + JPEG: + allOf: + - $ref: '#/components/schemas/tt_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + xml: + name: JPEG + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MPEG4: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + xml: + name: MPEG4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264: + allOf: + - $ref: '#/components/schemas/tt_H264Options2' + - description: Optional H.264 encoder settings ranges. + xml: + name: H264 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoderOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoderOptionsExtension2: + title: tt_VideoEncoderOptionsExtension2 + type: object + description: '' + xml: + name: VideoEncoderOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions: + title: tt_JpegOptions + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegOptions2: + title: tt_JpegOptions2 + allOf: + - $ref: '#/components/schemas/tt_JpegOptions' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: JpegOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_Mpeg4Options: + title: tt_Mpeg4Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported MPEG-4 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4Options2: + title: tt_Mpeg4Options2 + allOf: + - $ref: '#/components/schemas/tt_Mpeg4Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Mpeg4Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_H264Options: + title: tt_H264Options + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLengthRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported group of Video frames length. This value typically corresponds to the I-Frame distance. + xml: + name: GovLengthRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FrameRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported frame rate in fps (frames per second). + xml: + name: FrameRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported encoding interval range. The encoding interval corresponds to the number of frames devided by the encoded frames. An encoding interval value of "1" means that all frames are encoded. + xml: + name: EncodingIntervalRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264ProfilesSupported: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H.264 profiles. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264Options + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264Options2: + title: tt_H264Options2 + allOf: + - $ref: '#/components/schemas/tt_H264Options' + - required: + - BitrateRange + type: object + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: H264Options2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoEncodingMimeNames: + title: tt_VideoEncodingMimeNames + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + type: string + description: Video Media Subtypes as referenced by IANA (without the leading "video/" Video Media Type). See also + xml: + name: VideoEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncodingProfiles: + title: tt_VideoEncodingProfiles + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + type: string + description: '' + xml: + name: VideoEncodingProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2Configuration: + title: tt_VideoEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Resolution + - Quality + type: object + properties: + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution2' + - description: Configured video resolution + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RateControl: + allOf: + - $ref: '#/components/schemas/tt_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + xml: + name: RateControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video streaming. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Quality: + type: number + description: Relative value for the video quantizers and the quality of the video. A high value within supported quality range means higher quality + xml: + name: Quality + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GovLength: + type: integer + 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. + format: int32 + xml: + name: GovLength + prefix: tt + attribute: true + wrapped: false + Profile: + type: string + description: The encoder profile as defined in tt:VideoEncodingProfiles. + xml: + name: Profile + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRate: + type: boolean + description: >- + A value of true indicates that frame rate is a fixed value rather than an upper limit, + and that the video encoder shall prioritize frame rate over all other adaptable + configuration values such as bitrate. Default is false. + xml: + name: GuaranteedFrameRate + prefix: tt + attribute: true + wrapped: false + xml: + name: VideoEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoResolution2: + title: tt_VideoResolution2 + required: + - Width + - Height + type: object + properties: + Width: + type: integer + description: Number of the columns of the Video image. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: Number of the lines of the Video image. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoResolution2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoRateControl2: + title: tt_VideoRateControl2 + required: + - FrameRateLimit + - BitrateLimit + type: object + properties: + ConstantBitRate: + type: boolean + description: Enforce constant bitrate. + xml: + name: ConstantBitRate + prefix: tt + attribute: true + wrapped: false + FrameRateLimit: + type: number + description: Desired frame rate in fps. The actual rate may be lower due to e.g. performance limitations. + xml: + name: FrameRateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateLimit: + type: integer + description: the maximum output bitrate in kbps + format: int32 + xml: + name: BitrateLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoRateControl2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoEncoder2ConfigurationOptions: + title: tt_VideoEncoder2ConfigurationOptions + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + type: object + properties: + GovLengthRange: + type: integer + 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. + format: int32 + xml: + name: GovLengthRange + prefix: tt + attribute: true + wrapped: false + FrameRatesSupported: + type: number + description: List of supported target frame rates in fps (frames per second). The list shall be sorted with highest values first. + xml: + name: FrameRatesSupported + prefix: tt + attribute: true + wrapped: false + ProfilesSupported: + type: string + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + xml: + name: ProfilesSupported + prefix: tt + attribute: true + wrapped: false + ConstantBitRateSupported: + type: boolean + description: Signal whether enforcing constant bitrate is supported. + xml: + name: ConstantBitRateSupported + prefix: tt + attribute: true + wrapped: false + GuaranteedFrameRateSupported: + type: boolean + description: Indicates the support for the GuaranteedFrameRate attribute on the VideoEncoder2Configuration element. + xml: + name: GuaranteedFrameRateSupported + prefix: tt + attribute: true + wrapped: false + Encoding: + type: string + description: Video Media Subtype for the video format. For definitions see tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + QualityRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Range of the quality values. A high value means higher quality. + xml: + name: QualityRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution2' + description: List of supported image sizes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of encoded bitrate in kbps. + xml: + name: BitrateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceConfigurationOptions: + title: tt_AudioSourceConfigurationOptions + required: + - InputTokensAvailable + type: object + properties: + InputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the audio source the configuration can be used for. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioSourceOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioSourceConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioSourceOptionsExtension: + title: tt_AudioSourceOptionsExtension + type: object + description: '' + xml: + name: AudioSourceOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoding: + title: tt_AudioEncoding + enum: + - G711 + - G726 + - AAC + type: string + description: '' + xml: + name: AudioEncoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOptions: + title: tt_AudioEncoderConfigurationOptions + type: object + properties: + Options: + type: array + items: + $ref: '#/components/schemas/tt_AudioEncoderConfigurationOption' + description: list of supported AudioEncoderConfigurations + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoderConfigurationOption: + title: tt_AudioEncoderConfigurationOption + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoderConfigurationOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncodingMimeNames: + title: tt_AudioEncodingMimeNames + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + type: string + description: Audio Media Subtypes as referenced by IANA (without the leading "audio/" Audio Media Type and except for the audio types defined in the restriction). See also + xml: + name: AudioEncodingMimeNames + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioEncoder2Configuration: + title: tt_AudioEncoder2Configuration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - Encoding + - Bitrate + - SampleRate + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Bitrate: + type: integer + description: The output bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRate: + type: integer + description: The output sample rate in kHz. + format: int32 + xml: + name: SampleRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AudioEncoder2Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AudioEncoder2ConfigurationOptions: + title: tt_AudioEncoder2ConfigurationOptions + required: + - Encoding + - BitrateList + - SampleRateList + type: object + properties: + Encoding: + type: string + description: Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BitrateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + xml: + name: BitrateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateList: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + xml: + name: SampleRateList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioEncoder2ConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationExtension: + title: tt_MetadataConfigurationExtension + type: object + description: '' + xml: + name: MetadataConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZFilter: + title: tt_PTZFilter + required: + - Status + - Position + type: object + properties: + Status: + type: boolean + description: True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOWN) + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + type: boolean + description: True if the metadata stream shall contain the PTZ position + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventSubscription: + title: tt_EventSubscription + type: object + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/tt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Subcription handling in the same way as base notification subscription. + xml: + name: EventSubscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptions: + title: tt_MetadataConfigurationOptions + required: + - PTZStatusFilterOptions + type: object + properties: + GeoLocation: + type: boolean + description: True if the device is able to stream the Geo Located positions of each target. + xml: + name: GeoLocation + prefix: tt + attribute: true + wrapped: false + MaxContentFilterSize: + type: integer + description: A device signalling support for content filtering shall support expressions with the provided expression size. + format: int32 + xml: + name: MaxContentFilterSize + prefix: tt + attribute: true + wrapped: false + PTZStatusFilterOptions: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptions' + - xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension: + title: tt_MetadataConfigurationOptionsExtension + type: object + properties: + CompressionType: + type: array + items: + type: string + xml: + name: CompressionType + attribute: false + wrapped: false + description: List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataConfigurationOptionsExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataConfigurationOptionsExtension2: + title: tt_MetadataConfigurationOptionsExtension2 + type: object + description: '' + xml: + name: MetadataConfigurationOptionsExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataCompressionType: + title: tt_MetadataCompressionType + enum: + - None + - GZIP + - EXI + type: string + description: '' + xml: + name: MetadataCompressionType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptions: + title: tt_PTZStatusFilterOptions + required: + - PanTiltStatusSupported + - ZoomStatusSupported + type: object + properties: + PanTiltStatusSupported: + type: boolean + description: True if the device is able to stream pan or tilt status information. + xml: + name: PanTiltStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomStatusSupported: + type: boolean + description: True if the device is able to stream zoom status inforamtion. + xml: + name: ZoomStatusSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSupported: + type: boolean + description: True if the device is able to stream the pan or tilt position. + xml: + name: PanTiltPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSupported: + type: boolean + description: True if the device is able to stream zoom position information. + xml: + name: ZoomPositionSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZStatusFilterOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZStatusFilterOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZStatusFilterOptionsExtension: + title: tt_PTZStatusFilterOptionsExtension + type: object + description: '' + xml: + name: PTZStatusFilterOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutput: + title: tt_VideoOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Layout + type: object + properties: + Layout: + allOf: + - $ref: '#/components/schemas/tt_Layout' + - xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Resolution: + allOf: + - $ref: '#/components/schemas/tt_VideoResolution' + - description: Resolution of the display in Pixel. + xml: + name: Resolution + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RefreshRate: + type: number + description: Refresh rate of the display in Hertz. + xml: + name: RefreshRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AspectRatio: + type: number + description: Aspect ratio of the display as physical extent of width divided by height. + xml: + name: AspectRatio + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoOutputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical video outputs. + tt_VideoOutputExtension: + title: tt_VideoOutputExtension + type: object + description: '' + xml: + name: VideoOutputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoOutputConfiguration: + title: tt_VideoOutputConfiguration + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - OutputToken + type: object + properties: + OutputToken: + maxLength: 64 + type: string + description: Token of the Video Output the configuration applies to + xml: + name: OutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: VideoOutputConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_VideoOutputConfigurationOptions: + title: tt_VideoOutputConfigurationOptions + type: object + description: '' + xml: + name: VideoOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptions: + title: tt_VideoDecoderConfigurationOptions + type: object + properties: + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/tt_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element describes the supported codecs and configurations + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + H264DecOptions: + allOf: + - $ref: '#/components/schemas/tt_H264DecOptions' + - description: If the device is able to decode H.264 streams this element describes the supported codecs and configurations + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/tt_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element describes the supported codecs and configurations + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_H264DecOptions: + title: tt_H264DecOptions + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported H.264 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedH264Profiles: + type: array + items: + $ref: '#/components/schemas/tt_H264Profile' + description: List of supported H264 Profiles (either baseline, main, extended or high) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported H.264 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: H264DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_JpegDecOptions: + title: tt_JpegDecOptions + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Jpeg Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Jpeg framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: JpegDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Mpeg4DecOptions: + title: tt_Mpeg4DecOptions + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + properties: + ResolutionsAvailable: + type: array + items: + $ref: '#/components/schemas/tt_VideoResolution' + description: List of supported Mpeg4 Video Resolutions + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedMpeg4Profiles: + type: array + items: + $ref: '#/components/schemas/tt_Mpeg4Profile' + description: List of supported Mpeg4 Profiles (either SP or ASP) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + xml: + name: SupportedInputBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported Mpeg4 framerate range in fps + xml: + name: SupportedFrameRate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Mpeg4DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoDecoderConfigurationOptionsExtension: + title: tt_VideoDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: VideoDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioOutput: + title: tt_AudioOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + xml: + name: AudioOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Representation of a physical audio outputs. + tt_AudioOutputConfigurationOptions: + title: tt_AudioOutputConfigurationOptions + required: + - OutputTokensAvailable + - OutputLevelRange + type: object + properties: + OutputTokensAvailable: + type: array + items: + maxLength: 64 + type: string + xml: + name: OutputTokensAvailable + attribute: false + wrapped: false + description: Tokens of the physical Audio outputs (typically one). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SendPrimacyOptions: + type: array + items: + type: string + xml: + name: SendPrimacyOptions + attribute: false + wrapped: false + description: An + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Minimum and maximum level range supported for this Output. + xml: + name: OutputLevelRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioOutputConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptions: + title: tt_AudioDecoderConfigurationOptions + type: object + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/tt_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section describes the supported configurations + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G711DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section describes the supported configurations + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + G726DecOptions: + allOf: + - $ref: '#/components/schemas/tt_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section describes the supported configurations + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioDecoderConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G711DecOptions: + title: tt_G711DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G711DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AACDecOptions: + title: tt_AACDecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AACDecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_G726DecOptions: + title: tt_G726DecOptions + required: + - Bitrate + - SampleRateRange + type: object + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported bitrates in kbps + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SampleRateRange: + allOf: + - $ref: '#/components/schemas/tt_IntItems' + - description: List of supported sample rates in kHz + xml: + name: SampleRateRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: G726DecOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioDecoderConfigurationOptionsExtension: + title: tt_AudioDecoderConfigurationOptionsExtension + type: object + description: '' + xml: + name: AudioDecoderConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MulticastConfiguration: + title: tt_MulticastConfiguration + required: + - Address + - Port + - TTL + - AutoStart + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/tt_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast streaming is enaled) + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: integer + description: The RTP mutlicast 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. + format: int32 + xml: + name: Port + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: integer + 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. + format: int32 + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Read only property signalling that streaming is persistant. Use the methods StartMulticastStreaming and StopMulticastStreaming to switch its state. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MulticastConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamSetup: + title: tt_StreamSetup + required: + - Stream + - Transport + type: object + properties: + Stream: + allOf: + - $ref: '#/components/schemas/tt_StreamType' + - description: Defines if a multicast or unicast stream is requested + xml: + name: Stream + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transport: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StreamType: + title: tt_StreamType + enum: + - RTP-Unicast + - RTP-Multicast + type: string + description: '' + xml: + name: StreamType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Transport: + title: tt_Transport + required: + - Protocol + type: object + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/tt_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + xml: + name: Protocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tunnel: + allOf: + - $ref: '#/components/schemas/tt_Transport' + - description: Optional element to describe further tunnel options. This element is normally not needed + xml: + name: Tunnel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Transport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TransportProtocol: + title: tt_TransportProtocol + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + description: '' + xml: + name: TransportProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaUri: + title: tt_MediaUri + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + type: object + properties: + Uri: + type: string + description: Stable Uri to be used for requesting the media stream + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterConnect: + type: boolean + description: Indicates if the Uri is only valid until the connection is established. The value shall be set to "false". + xml: + name: InvalidAfterConnect + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InvalidAfterReboot: + type: boolean + description: Indicates if the Uri is invalid after a reboot of the device. The value shall be set to "false". + xml: + name: InvalidAfterReboot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Timeout: + type: string + 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 + format: date-time + xml: + name: Timeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ScopeDefinition: + title: tt_ScopeDefinition + enum: + - Fixed + - Configurable + type: string + description: '' + xml: + name: ScopeDefinition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Scope: + title: tt_Scope + required: + - ScopeDef + - ScopeItem + type: object + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/tt_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + xml: + name: ScopeDef + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScopeItem: + type: string + description: Scope item URI. + xml: + name: ScopeItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Scope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DiscoveryMode: + title: tt_DiscoveryMode + enum: + - Discoverable + - NonDiscoverable + type: string + description: '' + xml: + name: DiscoveryMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterface: + title: tt_NetworkInterface + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Info: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceInfo' + - description: Network interface information + xml: + name: Info + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceLink' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_NetworkInterfaceExtension: + title: tt_NetworkInterfaceExtension + required: + - InterfaceType + type: object + properties: + InterfaceType: + type: integer + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: Extension point prepared for future 802.3 configuration. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot3Configuration: + title: tt_Dot3Configuration + type: object + description: '' + xml: + name: Dot3Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceExtension2: + title: tt_NetworkInterfaceExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceLink: + title: tt_NetworkInterfaceLink + required: + - AdminSettings + - OperSettings + - InterfaceType + type: object + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + xml: + name: AdminSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OperSettings: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + xml: + name: OperSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InterfaceType: + type: integer + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + xml: + name: InterfaceType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceLink + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceConnectionSetting: + title: tt_NetworkInterfaceConnectionSetting + required: + - AutoNegotiation + - Speed + - Duplex + type: object + properties: + AutoNegotiation: + type: boolean + description: Auto negotiation on/off. + xml: + name: AutoNegotiation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: integer + description: Speed. + format: int32 + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Duplex: + allOf: + - $ref: '#/components/schemas/tt_Duplex' + - description: Duplex type, Half or Full. + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceConnectionSetting + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Duplex: + title: tt_Duplex + enum: + - Full + - Half + type: string + description: '' + xml: + name: Duplex + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceInfo: + title: tt_NetworkInterfaceInfo + required: + - HwAddress + type: object + properties: + Name: + type: string + description: Network interface name, for example eth0. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HwAddress: + type: string + description: Network interface MAC address. + xml: + name: HwAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterface: + title: tt_IPv6NetworkInterface + required: + - Enabled + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv6Configuration' + - description: IPv6 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterface: + title: tt_IPv4NetworkInterface + required: + - Enabled + - Config + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Config: + allOf: + - $ref: '#/components/schemas/tt_IPv4Configuration' + - description: IPv4 configuration. + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterface + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4Configuration: + title: tt_IPv4Configuration + required: + - DHCP + type: object + properties: + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: Link local address. + xml: + name: LinkLocal + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + allOf: + - $ref: '#/components/schemas/tt_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6Configuration: + title: tt_IPv6Configuration + required: + - DHCP + type: object + properties: + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually entered IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LinkLocal: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of link local IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FromRA: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of IPv6 addresses configured by using router advertisment. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPv6ConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6ConfigurationExtension: + title: tt_IPv6ConfigurationExtension + type: object + description: '' + xml: + name: IPv6ConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6DHCPConfiguration: + title: tt_IPv6DHCPConfiguration + enum: + - Auto + - Stateful + - Stateless + - Off + type: string + description: '' + xml: + name: IPv6DHCPConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocol: + title: tt_NetworkProtocol + required: + - Name + - Enabled + - Port + type: object + properties: + Name: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolType' + - description: Network protocol type string. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates if the protocol is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Port: + type: array + items: + type: integer + format: int32 + xml: + name: Port + attribute: false + wrapped: false + description: The port that is used by the protocol. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkProtocolExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkProtocol + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolExtension: + title: tt_NetworkProtocolExtension + type: object + description: '' + xml: + name: NetworkProtocolExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkProtocolType: + title: tt_NetworkProtocolType + enum: + - HTTP + - HTTPS + - RTSP + type: string + description: '' + xml: + name: NetworkProtocolType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostType: + title: tt_NetworkHostType + enum: + - IPv4 + - IPv6 + - DNS + type: string + description: '' + xml: + name: NetworkHostType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHost: + title: tt_NetworkHost + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address. + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSname: + type: string + description: DNS name. + xml: + name: DNSname + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkHostExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkHost + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkHostExtension: + title: tt_NetworkHostExtension + type: object + description: '' + xml: + name: NetworkHostExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddress: + title: tt_IPAddress + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: string + description: IPv4 address. + xml: + name: IPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: string + description: IPv6 address + xml: + name: IPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv4Address: + title: tt_PrefixedIPv4Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv4 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv4Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PrefixedIPv6Address: + title: tt_PrefixedIPv6Address + required: + - Address + - PrefixLength + type: object + properties: + Address: + type: string + description: IPv6 address + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrefixLength: + type: integer + description: Prefix/submask length + format: int32 + xml: + name: PrefixLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PrefixedIPv6Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPType: + title: tt_IPType + enum: + - IPv4 + - IPv6 + type: string + description: '' + xml: + name: IPType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformation: + title: tt_HostnameInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether the hostname is obtained from DHCP or not. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: Indicates the hostname. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_HostnameInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: HostnameInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_HostnameInformationExtension: + title: tt_HostnameInformationExtension + type: object + description: '' + xml: + name: HostnameInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformation: + title: tt_DNSInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates whether or not DNS information is retrieved from DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SearchDomain: + type: array + items: + type: string + xml: + name: SearchDomain + attribute: false + wrapped: false + description: Search domain. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of DNS addresses received from DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DNSManual: + type: array + items: + $ref: '#/components/schemas/tt_IPAddress' + description: List of manually entered DNS addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DNSInformationExtension: + title: tt_DNSInformationExtension + type: object + description: '' + xml: + name: DNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformation: + title: tt_NTPInformation + required: + - FromDHCP + type: object + properties: + FromDHCP: + type: boolean + description: Indicates if NTP information is to be retrieved by using DHCP. + xml: + name: FromDHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPFromDHCP: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of NTP addresses retrieved by using DHCP. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NTPManual: + type: array + items: + $ref: '#/components/schemas/tt_NetworkHost' + description: List of manually entered NTP addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NTPInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NTPInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NTPInformationExtension: + title: tt_NTPInformationExtension + type: object + description: '' + xml: + name: NTPInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterType: + title: tt_IPAddressFilterType + enum: + - Allow + - Deny + type: string + description: '' + xml: + name: IPAddressFilterType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformation: + title: tt_DynamicDNSInformation + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSType' + - description: Dynamic DNS type. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + type: string + description: DNS name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TTL: + type: string + description: Time to live. + format: date-time + xml: + name: TTL + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DynamicDNSInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DynamicDNSInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSInformationExtension: + title: tt_DynamicDNSInformationExtension + type: object + description: '' + xml: + name: DynamicDNSInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DynamicDNSType: + title: tt_DynamicDNSType + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + type: string + description: '' + xml: + name: DynamicDNSType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfiguration: + title: tt_NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not an interface is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Link: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceConnectionSetting' + - description: Link configuration. + xml: + name: Link + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MTU: + type: integer + description: Maximum transmission unit. + format: int32 + xml: + name: MTU + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4: + allOf: + - $ref: '#/components/schemas/tt_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + xml: + name: IPv4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6: + allOf: + - $ref: '#/components/schemas/tt_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + xml: + name: IPv6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension: + title: tt_NetworkInterfaceSetConfigurationExtension + type: object + properties: + Dot3: + type: array + items: + $ref: '#/components/schemas/tt_Dot3Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot11: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Configuration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkInterfaceSetConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv6NetworkInterfaceSetConfiguration: + title: tt_IPv6NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv6 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AcceptRouterAdvert: + type: boolean + description: Indicates whether router advertisment is used. + xml: + name: AcceptRouterAdvert + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: List of manually added IPv6 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + allOf: + - $ref: '#/components/schemas/tt_IPv6DHCPConfiguration' + - description: DHCP configuration. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv6NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPv4NetworkInterfaceSetConfiguration: + title: tt_IPv4NetworkInterfaceSetConfiguration + type: object + properties: + Enabled: + type: boolean + description: Indicates whether or not IPv4 is enabled. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Manual: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: List of manually added IPv4 addresses. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DHCP: + type: boolean + description: Indicates whether or not DHCP is used. + xml: + name: DHCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPv4NetworkInterfaceSetConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkGateway: + title: tt_NetworkGateway + type: object + properties: + IPv4Address: + type: array + items: + type: string + xml: + name: IPv4Address + attribute: false + wrapped: false + description: IPv4 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + type: string + xml: + name: IPv6Address + attribute: false + wrapped: false + description: IPv6 address string. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkGateway + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfiguration: + title: tt_NetworkZeroConfiguration + required: + - InterfaceToken + - Enabled + type: object + properties: + InterfaceToken: + maxLength: 64 + type: string + description: Unique identifier of network interface. + xml: + name: InterfaceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Enabled: + type: boolean + description: Indicates whether the zero-configuration is enabled or not. + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Addresses: + type: array + items: + type: string + xml: + name: Addresses + attribute: false + wrapped: false + description: The zero-configuration IPv4 address(es) + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension: + title: tt_NetworkZeroConfigurationExtension + type: object + properties: + Additional: + type: array + items: + $ref: '#/components/schemas/tt_NetworkZeroConfiguration' + description: Optional array holding the configuration for the second and possibly further interfaces. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkZeroConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkZeroConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkZeroConfigurationExtension2: + title: tt_NetworkZeroConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkZeroConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilter: + title: tt_IPAddressFilter + required: + - Type + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv4Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv4Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPv6Address: + type: array + items: + $ref: '#/components/schemas/tt_PrefixedIPv6Address' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IPAddressFilterExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IPAddressFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IPAddressFilterExtension: + title: tt_IPAddressFilterExtension + type: object + description: '' + xml: + name: IPAddressFilterExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Configuration: + title: tt_Dot11Configuration + required: + - SSID + - Mode + - Alias + - Priority + - Security + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11StationMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Alias: + maxLength: 64 + type: string + xml: + name: Alias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + maximum: 31 + minimum: 0 + type: integer + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfiguration' + - xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11StationMode: + title: tt_Dot11StationMode + enum: + - Ad-hoc + - Infrastructure + - Extended + type: string + description: '' + xml: + name: Dot11StationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfiguration: + title: tt_Dot11SecurityConfiguration + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityMode' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Algorithm: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: Algorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PSK: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSet' + - xml: + name: PSK + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Dot1X: + maxLength: 64 + type: string + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11SecurityConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11SecurityConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityConfigurationExtension: + title: tt_Dot11SecurityConfigurationExtension + type: object + description: '' + xml: + name: Dot11SecurityConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SecurityMode: + title: tt_Dot11SecurityMode + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + type: string + description: '' + xml: + name: Dot11SecurityMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Cipher: + title: tt_Dot11Cipher + enum: + - CCMP + - TKIP + - Any + - Extended + type: string + description: '' + xml: + name: Dot11Cipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSet: + title: tt_Dot11PSKSet + type: object + properties: + Key: + type: string + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of 256 bits, or 64 octets when represented in hex + format: binary + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Passphrase: + pattern: '[ -~]{8,63}' + type: string + description: >- + According to IEEE802.11-2007 H.4.1 a pass-phrase is a sequence of between 8 and 63 ASCII-encoded characters and + each character in the pass-phrase must have an encoding in the range of 32 to 126 (decimal),inclusive. + xml: + name: Passphrase + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11PSKSetExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11PSKSet + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11PSKSetExtension: + title: tt_Dot11PSKSetExtension + type: object + description: '' + xml: + name: Dot11PSKSetExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkInterfaceSetConfigurationExtension2: + title: tt_NetworkInterfaceSetConfigurationExtension2 + type: object + description: '' + xml: + name: NetworkInterfaceSetConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Capabilities: + title: tt_Dot11Capabilities + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + type: object + properties: + TKIP: + type: boolean + xml: + name: TKIP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ScanAvailableNetworks: + type: boolean + xml: + name: ScanAvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MultipleConfiguration: + type: boolean + xml: + name: MultipleConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AdHocStationMode: + type: boolean + xml: + name: AdHocStationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WEP: + type: boolean + xml: + name: WEP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11SignalStrength: + title: tt_Dot11SignalStrength + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + type: string + description: '' + xml: + name: Dot11SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11Status: + title: tt_Dot11Status + required: + - SSID + - ActiveConfigAlias + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: PairCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + allOf: + - $ref: '#/components/schemas/tt_Dot11Cipher' + - xml: + name: GroupCipher + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ActiveConfigAlias: + maxLength: 64 + type: string + xml: + name: ActiveConfigAlias + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AuthAndMangementSuite: + title: tt_Dot11AuthAndMangementSuite + enum: + - None + - Dot1X + - PSK + - Extended + type: string + description: '' + xml: + name: Dot11AuthAndMangementSuite + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworks: + title: tt_Dot11AvailableNetworks + required: + - SSID + type: object + properties: + SSID: + type: string + format: binary + xml: + name: SSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BSSID: + type: string + xml: + name: BSSID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuthAndMangementSuite: + type: array + items: + $ref: '#/components/schemas/tt_Dot11AuthAndMangementSuite' + description: See IEEE802.11 7.3.2.25.2 for details. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PairCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + GroupCipher: + type: array + items: + $ref: '#/components/schemas/tt_Dot11Cipher' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignalStrength: + allOf: + - $ref: '#/components/schemas/tt_Dot11SignalStrength' + - xml: + name: SignalStrength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot11AvailableNetworksExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot11AvailableNetworks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot11AvailableNetworksExtension: + title: tt_Dot11AvailableNetworksExtension + type: object + description: '' + xml: + name: Dot11AvailableNetworksExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilityCategory: + title: tt_CapabilityCategory + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + type: string + description: '' + xml: + name: CapabilityCategory + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Capabilities: + title: tt_Capabilities + type: object + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsCapabilities' + - description: Analytics capabilities + xml: + name: Analytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Device: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilities' + - description: Device capabilities + xml: + name: Device + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Events: + allOf: + - $ref: '#/components/schemas/tt_EventCapabilities' + - description: Event capabilities + xml: + name: Events + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Imaging: + allOf: + - $ref: '#/components/schemas/tt_ImagingCapabilities' + - description: Imaging capabilities + xml: + name: Imaging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Media: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilities' + - description: Media capabilities + xml: + name: Media + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZ: + allOf: + - $ref: '#/components/schemas/tt_PTZCapabilities' + - description: PTZ capabilities + xml: + name: PTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Capabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension: + title: tt_CapabilitiesExtension + type: object + properties: + DeviceIO: + allOf: + - $ref: '#/components/schemas/tt_DeviceIOCapabilities' + - xml: + name: DeviceIO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Display: + allOf: + - $ref: '#/components/schemas/tt_DisplayCapabilities' + - xml: + name: Display + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Recording: + allOf: + - $ref: '#/components/schemas/tt_RecordingCapabilities' + - xml: + name: Recording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Search: + allOf: + - $ref: '#/components/schemas/tt_SearchCapabilities' + - xml: + name: Search + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Replay: + allOf: + - $ref: '#/components/schemas/tt_ReplayCapabilities' + - xml: + name: Replay + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Receiver: + allOf: + - $ref: '#/components/schemas/tt_ReceiverCapabilities' + - xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsDevice: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceCapabilities' + - xml: + name: AnalyticsDevice + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extensions: + allOf: + - $ref: '#/components/schemas/tt_CapabilitiesExtension2' + - xml: + name: Extensions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CapabilitiesExtension2: + title: tt_CapabilitiesExtension2 + type: object + description: '' + xml: + name: CapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsCapabilities: + title: tt_AnalyticsCapabilities + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + type: object + properties: + XAddr: + type: string + description: Analytics service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Indicates whether or not rules are supported. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleSupport: + type: boolean + description: Indicates whether or not modules are supported. + xml: + name: AnalyticsModuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilities: + title: tt_DeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Device service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Network: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilities' + - description: Network capabilities. + xml: + name: Network + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + System: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilities' + - description: System capabilities. + xml: + name: System + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IO: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilities' + - description: I/O capabilities. + xml: + name: IO + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Security: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilities' + - description: Security capabilities. + xml: + name: Security + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DeviceCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceCapabilitiesExtension: + title: tt_DeviceCapabilitiesExtension + type: object + description: '' + xml: + name: DeviceCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventCapabilities: + title: tt_EventCapabilities + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + type: object + properties: + XAddr: + type: string + description: Event service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSSubscriptionPolicySupport: + type: boolean + description: Indicates whether or not WS Subscription policy is supported. + xml: + name: WSSubscriptionPolicySupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPullPointSupport: + type: boolean + description: Indicates whether or not WS Pull Point is supported. + xml: + name: WSPullPointSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WSPausableSubscriptionManagerInterfaceSupport: + type: boolean + description: Indicates whether or not WS Pausable Subscription Manager Interface is supported. + xml: + name: WSPausableSubscriptionManagerInterfaceSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EventCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilities: + title: tt_IOCapabilities + type: object + properties: + InputConnectors: + type: integer + description: Number of input connectors. + format: int32 + xml: + name: InputConnectors + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + description: Number of relay outputs. + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension: + title: tt_IOCapabilitiesExtension + required: + - Extension + type: object + properties: + Auxiliary: + type: boolean + xml: + name: Auxiliary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IOCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IOCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IOCapabilitiesExtension2: + title: tt_IOCapabilitiesExtension2 + type: object + description: '' + xml: + name: IOCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilities: + title: tt_MediaCapabilities + required: + - XAddr + - StreamingCapabilities + type: object + properties: + XAddr: + type: string + description: Media service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + xml: + name: StreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MediaCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaCapabilitiesExtension: + title: tt_MediaCapabilitiesExtension + required: + - ProfileCapabilities + type: object + properties: + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/tt_ProfileCapabilities' + - xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MediaCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilities: + title: tt_RealTimeStreamingCapabilities + type: object + properties: + RTPMulticast: + type: boolean + description: Indicates whether or not RTP multicast is supported. + xml: + name: RTPMulticast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether or not RTP over TCP is supported. + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether or not RTP/RTSP/TCP is supported. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RealTimeStreamingCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RealTimeStreamingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RealTimeStreamingCapabilitiesExtension: + title: tt_RealTimeStreamingCapabilitiesExtension + type: object + description: '' + xml: + name: RealTimeStreamingCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileCapabilities: + title: tt_ProfileCapabilities + required: + - MaximumNumberOfProfiles + type: object + properties: + MaximumNumberOfProfiles: + type: integer + description: Maximum number of profiles. + format: int32 + xml: + name: MaximumNumberOfProfiles + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilities: + title: tt_NetworkCapabilities + type: object + properties: + IPFilter: + type: boolean + description: Indicates whether or not IP filtering is supported. + xml: + name: IPFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZeroConfiguration: + type: boolean + description: Indicates whether or not zeroconf is supported. + xml: + name: ZeroConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IPVersion6: + type: boolean + description: Indicates whether or not IPv6 is supported. + xml: + name: IPVersion6 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynDNS: + type: boolean + description: Indicates whether or not is supported. + xml: + name: DynDNS + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension: + title: tt_NetworkCapabilitiesExtension + type: object + properties: + Dot11Configuration: + type: boolean + xml: + name: Dot11Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_NetworkCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NetworkCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NetworkCapabilitiesExtension2: + title: tt_NetworkCapabilitiesExtension2 + type: object + description: '' + xml: + name: NetworkCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilities: + title: tt_SecurityCapabilities + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + type: object + properties: + TLS1.1: + type: boolean + description: Indicates whether or not TLS 1.1 is supported. + xml: + name: TLS1.1 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TLS1.2: + type: boolean + description: Indicates whether or not TLS 1.2 is supported. + xml: + name: TLS1.2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + OnboardKeyGeneration: + type: boolean + description: Indicates whether or not onboard key generation is supported. + xml: + name: OnboardKeyGeneration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AccessPolicyConfig: + type: boolean + description: Indicates whether or not access policy configuration is supported. + xml: + name: AccessPolicyConfig + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + X.509Token: + type: boolean + description: Indicates whether or not WS-Security X.509 token is supported. + xml: + name: X.509Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SAMLToken: + type: boolean + description: Indicates whether or not WS-Security SAML token is supported. + xml: + name: SAMLToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KerberosToken: + type: boolean + description: Indicates whether or not WS-Security Kerberos token is supported. + xml: + name: KerberosToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RELToken: + type: boolean + description: Indicates whether or not WS-Security REL token is supported. + xml: + name: RELToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension: + title: tt_SecurityCapabilitiesExtension + required: + - TLS1.0 + type: object + properties: + TLS1.0: + type: boolean + xml: + name: TLS1.0 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SecurityCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SecurityCapabilitiesExtension2: + title: tt_SecurityCapabilitiesExtension2 + required: + - Dot1X + - RemoteUserHandling + type: object + properties: + Dot1X: + type: boolean + xml: + name: Dot1X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedEAPMethod: + type: array + items: + type: integer + format: int32 + xml: + name: SupportedEAPMethod + attribute: false + wrapped: false + description: EAP Methods supported by the device. The int values refer to the + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteUserHandling: + type: boolean + xml: + name: RemoteUserHandling + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SecurityCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilities: + title: tt_SystemCapabilities + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + type: object + properties: + DiscoveryResolve: + type: boolean + description: Indicates whether or not WS Discovery resolve requests are supported. + xml: + name: DiscoveryResolve + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DiscoveryBye: + type: boolean + description: Indicates whether or not WS-Discovery Bye is supported. + xml: + name: DiscoveryBye + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RemoteDiscovery: + type: boolean + description: Indicates whether or not remote discovery is supported. + xml: + name: RemoteDiscovery + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemBackup: + type: boolean + description: Indicates whether or not system backup is supported. + xml: + name: SystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SystemLogging: + type: boolean + description: Indicates whether or not system logging is supported. + xml: + name: SystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FirmwareUpgrade: + type: boolean + description: Indicates whether or not firmware upgrade is supported. + xml: + name: FirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedVersions: + type: array + items: + $ref: '#/components/schemas/tt_OnvifVersion' + description: Indicates supported ONVIF version(s). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension: + title: tt_SystemCapabilitiesExtension + type: object + properties: + HttpFirmwareUpgrade: + type: boolean + xml: + name: HttpFirmwareUpgrade + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemBackup: + type: boolean + xml: + name: HttpSystemBackup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSystemLogging: + type: boolean + xml: + name: HttpSystemLogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HttpSupportInformation: + type: boolean + xml: + name: HttpSupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemCapabilitiesExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemCapabilitiesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemCapabilitiesExtension2: + title: tt_SystemCapabilitiesExtension2 + type: object + description: '' + xml: + name: SystemCapabilitiesExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OnvifVersion: + title: tt_OnvifVersion + required: + - Major + - Minor + type: object + properties: + Major: + type: integer + description: Major version number. + format: int32 + xml: + name: Major + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minor: + type: integer + description: >- + Two digit minor version number. + If 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. + Otherwise, minor number is month of release, such as "06" for June. + format: int32 + xml: + name: Minor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OnvifVersion + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingCapabilities: + title: tt_ImagingCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: Imaging service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZCapabilities: + title: tt_PTZCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: PTZ service URI. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DeviceIOCapabilities: + title: tt_DeviceIOCapabilities + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoSources: + type: integer + format: int32 + xml: + name: VideoSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoOutputs: + type: integer + format: int32 + xml: + name: VideoOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSources: + type: integer + format: int32 + xml: + name: AudioSources + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputs: + type: integer + format: int32 + xml: + name: AudioOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelayOutputs: + type: integer + format: int32 + xml: + name: RelayOutputs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DeviceIOCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DisplayCapabilities: + title: tt_DisplayCapabilities + required: + - XAddr + - FixedLayout + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedLayout: + type: boolean + description: Indication that the SetLayout command supports only predefined layouts. + xml: + name: FixedLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DisplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingCapabilities: + title: tt_RecordingCapabilities + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverSource: + type: boolean + xml: + name: ReceiverSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaProfileSource: + type: boolean + xml: + name: MediaProfileSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicRecordings: + type: boolean + xml: + name: DynamicRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DynamicTracks: + type: boolean + xml: + name: DynamicTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxStringLength: + type: integer + format: int32 + xml: + name: MaxStringLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchCapabilities: + title: tt_SearchCapabilities + required: + - XAddr + - MetadataSearch + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataSearch: + type: boolean + xml: + name: MetadataSearch + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SearchCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayCapabilities: + title: tt_ReplayCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + description: The address of the replay service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReplayCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverCapabilities: + title: tt_ReceiverCapabilities + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + type: object + properties: + XAddr: + type: string + description: The address of the receiver service. + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_Multicast: + type: boolean + description: Indicates whether the device can receive RTP multicast streams. + xml: + name: RTP_Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/TCP streams + xml: + name: RTP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RTP_RTSP_TCP: + type: boolean + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + xml: + name: RTP_RTSP_TCP + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedReceivers: + type: integer + description: The maximum number of receivers supported by the device. + format: int32 + xml: + name: SupportedReceivers + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRTSPURILength: + type: integer + description: The maximum allowed length for RTSP URIs. + format: int32 + xml: + name: MaximumRTSPURILength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReceiverCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceCapabilities: + title: tt_AnalyticsDeviceCapabilities + required: + - XAddr + type: object + properties: + XAddr: + type: string + xml: + name: XAddr + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleSupport: + type: boolean + description: Obsolete property. + xml: + name: RuleSupport + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceExtension: + title: tt_AnalyticsDeviceExtension + type: object + description: '' + xml: + name: AnalyticsDeviceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogType: + title: tt_SystemLogType + enum: + - System + - Access + type: string + description: Enumeration describing the available system log modes. + xml: + name: SystemLogType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLog: + title: tt_SystemLog + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The log information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The log information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLog + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportInformation: + title: tt_SupportInformation + type: object + properties: + Binary: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - description: The support information as attachment data. + xml: + name: Binary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + String: + type: string + description: The support information as character data. + xml: + name: String + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BinaryData: + title: tt_BinaryData + required: + - Data + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Data: + type: string + description: base64 encoded binary data. + format: binary + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BinaryData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AttachmentData: + title: tt_AttachmentData + required: + - Include + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + Include: + allOf: + - $ref: '#/components/schemas/xop_Include' + - xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + description: '' + xml: + name: AttachmentData + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BackupFile: + title: tt_BackupFile + required: + - Name + - Data + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_AttachmentData' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BackupFile + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUriList: + title: tt_SystemLogUriList + type: object + properties: + SystemLog: + type: array + items: + $ref: '#/components/schemas/tt_SystemLogUri' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUriList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemLogUri: + title: tt_SystemLogUri + required: + - Type + - Uri + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_SystemLogType' + - xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Uri: + type: string + xml: + name: Uri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SystemLogUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FactoryDefaultType: + title: tt_FactoryDefaultType + enum: + - Hard + - Soft + type: string + description: Enumeration describing the available factory default modes. + xml: + name: FactoryDefaultType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SetDateTimeType: + title: tt_SetDateTimeType + enum: + - Manual + - NTP + type: string + description: '' + xml: + name: SetDateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTime: + title: tt_SystemDateTime + required: + - DateTimeType + - DaylightSavings + type: object + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/tt_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + xml: + name: DateTimeType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DaylightSavings: + type: boolean + description: Informative indicator whether daylight savings is currently on/off. + xml: + name: DaylightSavings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeZone: + allOf: + - $ref: '#/components/schemas/tt_TimeZone' + - description: Timezone information in Posix format. + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UTCDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Current system date and time in UTC format. This field is mandatory since version 2.0. + xml: + name: UTCDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LocalDateTime: + allOf: + - $ref: '#/components/schemas/tt_DateTime' + - description: Date and time in local format. + xml: + name: LocalDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SystemDateTimeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: General date time inforamtion returned by the GetSystemDateTime method. + xml: + name: SystemDateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SystemDateTimeExtension: + title: tt_SystemDateTimeExtension + type: object + description: '' + xml: + name: SystemDateTimeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTime: + title: tt_DateTime + required: + - Time + - Date + type: object + properties: + Time: + allOf: + - $ref: '#/components/schemas/tt_Time' + - xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Date: + allOf: + - $ref: '#/components/schemas/tt_Date' + - xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Date: + title: tt_Date + required: + - Year + - Month + - Day + type: object + properties: + Year: + type: integer + format: int32 + xml: + name: Year + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Month: + type: integer + description: Range is 1 to 12. + format: int32 + xml: + name: Month + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Day: + type: integer + description: Range is 1 to 31. + format: int32 + xml: + name: Day + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Date + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Time: + title: tt_Time + required: + - Hour + - Minute + - Second + type: object + properties: + Hour: + type: integer + description: Range is 0 to 23. + format: int32 + xml: + name: Hour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Minute: + type: integer + description: Range is 0 to 59. + format: int32 + xml: + name: Minute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Second: + type: integer + description: Range is 0 to 61 (typically 59). + format: int32 + xml: + name: Second + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TimeZone: + title: tt_TimeZone + required: + - TZ + type: object + properties: + TZ: + type: string + description: Posix timezone string. + xml: + name: TZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 section 8.3 + xml: + name: TimeZone + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RemoteUser: + title: tt_RemoteUser + required: + - Username + - UseDerivedPassword + type: object + properties: + Username: + type: string + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UseDerivedPassword: + type: boolean + xml: + name: UseDerivedPassword + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RemoteUser + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserLevel: + title: tt_UserLevel + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + description: '' + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_User: + title: tt_User + required: + - Username + - UserLevel + type: object + properties: + Username: + type: string + description: Username string. + xml: + name: Username + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password string. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + UserLevel: + allOf: + - $ref: '#/components/schemas/tt_UserLevel' + - description: User level string. + xml: + name: UserLevel + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_UserExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: User + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_UserExtension: + title: tt_UserExtension + type: object + description: '' + xml: + name: UserExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParameters: + title: tt_CertificateGenerationParameters + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subject: + type: string + xml: + name: Subject + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotBefore: + type: string + xml: + name: ValidNotBefore + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ValidNotAfter: + type: string + xml: + name: ValidNotAfter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateGenerationParametersExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateGenerationParameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateGenerationParametersExtension: + title: tt_CertificateGenerationParametersExtension + type: object + description: '' + xml: + name: CertificateGenerationParametersExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Certificate: + title: tt_Certificate + required: + - CertificateID + - Certificate + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - description: base64 encoded DER representation of certificate. + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateStatus: + title: tt_CertificateStatus + required: + - CertificateID + - Status + type: object + properties: + CertificateID: + type: string + description: Certificate id. + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + type: boolean + description: Indicates whether or not a certificate is used in a HTTPS configuration. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateWithPrivateKey: + title: tt_CertificateWithPrivateKey + required: + - Certificate + - PrivateKey + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Certificate: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: Certificate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PrivateKey: + allOf: + - $ref: '#/components/schemas/tt_BinaryData' + - xml: + name: PrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateWithPrivateKey + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformation: + title: tt_CertificateInformation + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IssuerDN: + type: string + xml: + name: IssuerDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SubjectDN: + type: string + xml: + name: SubjectDN + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: KeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExtendedKeyUsage: + allOf: + - $ref: '#/components/schemas/tt_CertificateUsage' + - xml: + name: ExtendedKeyUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + KeyLength: + type: integer + format: int32 + xml: + name: KeyLength + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Version: + type: string + xml: + name: Version + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SerialNum: + type: string + xml: + name: SerialNum + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SignatureAlgorithm: + type: string + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding DateTimeRange is from "From" to "Until" + xml: + name: SignatureAlgorithm + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Validity: + allOf: + - $ref: '#/components/schemas/tt_DateTimeRange' + - xml: + name: Validity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_CertificateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CertificateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateUsage: + title: tt_CertificateUsage + required: + - Critical + type: object + properties: + Critical: + type: boolean + xml: + name: Critical + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: CertificateUsage + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CertificateInformationExtension: + title: tt_CertificateInformationExtension + type: object + description: '' + xml: + name: CertificateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfiguration: + title: tt_Dot1XConfiguration + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + type: object + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + xml: + name: Dot1XConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Identity: + type: string + xml: + name: Identity + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnonymousID: + type: string + xml: + name: AnonymousID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethod: + type: integer + description: EAP Method type as defined in + format: int32 + xml: + name: EAPMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CACertificateID: + type: array + items: + type: string + xml: + name: CACertificateID + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EAPMethodConfiguration: + allOf: + - $ref: '#/components/schemas/tt_EAPMethodConfiguration' + - xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_Dot1XConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Dot1XConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Dot1XConfigurationExtension: + title: tt_Dot1XConfigurationExtension + type: object + description: '' + xml: + name: Dot1XConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EAPMethodConfiguration: + title: tt_EAPMethodConfiguration + type: object + properties: + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/tt_TLSConfiguration' + - description: Confgiuration information for TLS Method. + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Password: + type: string + description: Password for those EAP Methods that require a password. The password shall never be returned on a get method. + xml: + name: Password + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EapMethodExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EAPMethodConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EapMethodExtension: + title: tt_EapMethodExtension + type: object + description: '' + xml: + name: EapMethodExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TLSConfiguration: + title: tt_TLSConfiguration + required: + - CertificateID + type: object + properties: + CertificateID: + type: string + xml: + name: CertificateID + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TLSConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GenericEapPwdConfigurationExtension: + title: tt_GenericEapPwdConfigurationExtension + type: object + description: '' + xml: + name: GenericEapPwdConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayLogicalState: + title: tt_RelayLogicalState + enum: + - active + - inactive + type: string + description: '' + xml: + name: RelayLogicalState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayIdleState: + title: tt_RelayIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: RelayIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutputSettings: + title: tt_RelayOutputSettings + required: + - Mode + - DelayTime + - IdleState + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_RelayMode' + - description: "'Bistable' or 'Monostable'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DelayTime: + type: string + 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. + format: date-time + xml: + name: DelayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IdleState: + allOf: + - $ref: '#/components/schemas/tt_RelayIdleState' + - description: "'open' or 'closed'" + xml: + name: IdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelayOutputSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayMode: + title: tt_RelayMode + enum: + - Monostable + - Bistable + type: string + description: '' + xml: + name: RelayMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelayOutput: + title: tt_RelayOutput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - Properties + type: object + properties: + Properties: + allOf: + - $ref: '#/components/schemas/tt_RelayOutputSettings' + - xml: + name: Properties + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: RelayOutput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_DigitalIdleState: + title: tt_DigitalIdleState + enum: + - closed + - open + type: string + description: '' + xml: + name: DigitalIdleState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DigitalInput: + title: tt_DigitalInput + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - type: object + properties: + IdleState: + allOf: + - $ref: '#/components/schemas/tt_DigitalIdleState' + - description: Indicate the Digital IdleState status. + xml: + name: IdleState + prefix: tt + attribute: true + wrapped: false + xml: + name: DigitalInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNode: + title: tt_PTZNode + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + properties: + Name: + maxLength: 64 + type: string + description: A unique identifier that is used to reference PTZ Nodes. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. For each Coordinate System, the PTZ Node MUST specify its allowed range. + xml: + name: SupportedPTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumNumberOfPresets: + type: integer + description: All preset operations MUST be available for this PTZ Node if one preset is supported. + format: int32 + xml: + name: MaximumNumberOfPresets + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + HomeSupported: + type: boolean + 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. + xml: + name: HomeSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AuxiliaryCommands: + type: array + items: + maxLength: 128 + type: string + xml: + name: AuxiliaryCommands + attribute: false + wrapped: false + description: A list of supported Auxiliary commands. If the list is not empty, the Auxiliary Operations MUST be available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FixedHomePosition: + type: boolean + description: Indication whether the HomePosition of a Node is fixed or it can be changed via the SetHomePosition command. + xml: + name: FixedHomePosition + prefix: tt + attribute: true + wrapped: false + GeoMove: + type: boolean + description: Indication whether the Node supports the geo-referenced move command. + xml: + name: GeoMove + prefix: tt + attribute: true + wrapped: false + xml: + name: PTZNode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZNodeExtension: + title: tt_PTZNodeExtension + type: object + properties: + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + xml: + name: SupportedPresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZNodeExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZNodeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZNodeExtension2: + title: tt_PTZNodeExtension2 + type: object + description: '' + xml: + name: PTZNodeExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupported: + title: tt_PTZPresetTourSupported + required: + - MaximumNumberOfPresetTours + type: object + properties: + MaximumNumberOfPresetTours: + type: integer + 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. + format: int32 + xml: + name: MaximumNumberOfPresetTours + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPresetTourOperation: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourOperation' + description: Indicates which preset tour operations are available for this PTZ Node. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSupportedExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSupported + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSupportedExtension: + title: tt_PTZPresetTourSupportedExtension + type: object + description: '' + xml: + name: PTZPresetTourSupportedExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension: + title: tt_PTZConfigurationExtension + type: object + properties: + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirection' + - description: Optional element to configure PT Control Direction related features. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationExtension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationExtension2: + title: tt_PTZConfigurationExtension2 + type: object + description: '' + xml: + name: PTZConfigurationExtension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirection: + title: tt_PTControlDirection + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlip' + - description: Optional element to configure related parameters for E-Flip. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_Reverse' + - description: Optional element to configure related parameters for reversing of PT Control Direction. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionExtension: + title: tt_PTControlDirectionExtension + type: object + description: '' + xml: + name: PTControlDirectionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlip: + title: tt_EFlip + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Reverse: + title: tt_Reverse + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipMode: + title: tt_EFlipMode + enum: + - OFF + - ON + - Extended + type: string + description: '' + xml: + name: EFlipMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseMode: + title: tt_ReverseMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ReverseMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions: + title: tt_PTZConfigurationOptions + required: + - Spaces + - PTZTimeout + type: object + properties: + PTZRamps: + type: integer + description: >- + The list of acceleration ramps supported by the device. The + smallest acceleration value corresponds to the minimal index, the + highest acceleration corresponds to the maximum index. + format: int32 + xml: + name: PTZRamps + prefix: tt + attribute: true + wrapped: false + Spaces: + allOf: + - $ref: '#/components/schemas/tt_PTZSpaces' + - description: A list of supported coordinate systems including their range limitations. + xml: + name: Spaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZTimeout: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the PTZ Node. + xml: + name: PTZTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTControlDirection: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + xml: + name: PTControlDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZConfigurationOptions2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZConfigurationOptions2: + title: tt_PTZConfigurationOptions2 + type: object + description: '' + xml: + name: PTZConfigurationOptions2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptions: + title: tt_PTControlDirectionOptions + type: object + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptions' + - description: Supported options for EFlip feature. + xml: + name: EFlip + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Reverse: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptions' + - description: Supported options for Reverse feature. + xml: + name: Reverse + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTControlDirectionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTControlDirectionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTControlDirectionOptionsExtension: + title: tt_PTControlDirectionOptionsExtension + type: object + description: '' + xml: + name: PTControlDirectionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptions: + title: tt_EFlipOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_EFlipMode' + description: Options of EFlip mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_EFlipOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EFlipOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EFlipOptionsExtension: + title: tt_EFlipOptionsExtension + type: object + description: '' + xml: + name: EFlipOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptions: + title: tt_ReverseOptions + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ReverseMode' + description: Options of Reverse mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ReverseOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ReverseOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReverseOptionsExtension: + title: tt_ReverseOptionsExtension + type: object + description: '' + xml: + name: ReverseOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PanTiltLimits: + title: tt_PanTiltLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: A range of pan tilt limits. + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PanTiltLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ZoomLimits: + title: tt_ZoomLimits + required: + - Range + type: object + properties: + Range: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: A range of zoom limit + xml: + name: Range + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ZoomLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpaces: + title: tt_PTZSpaces + type: object + properties: + AbsolutePanTiltPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AbsoluteZoomPositionSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, the range should be defined as the full range of the Zoom normalized to the range 0 (wide) to 1 (tele). \n There is no assumption about how the generic zoom range is mapped to magnification, FOV or other physical zoom dimension." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePanTiltTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 where positive translation would mean clockwise rotation or movement in right/up direction resulting in the following space description." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativeZoomTranslationSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 Instead, 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 where 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 There 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousPanTiltVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space2DDescription' + 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 Instead, 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 rotation 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." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousZoomVelocitySpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + 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 where a positive velocity would map to TELE direction. A generic zoom velocity space description resembles the following." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Pan/Tilt movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information. The speed of a combined Pan/Tilt \n movement is represented by a single non-negative scalar value." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomSpeedSpace: + type: array + items: + $ref: '#/components/schemas/tt_Space1DDescription' + description: "The speed space specifies the speed for a Zoom movement when moving to an absolute position or to a relative translation. \n In contrast to the velocity spaces, speed spaces do not contain any directional information." + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZSpacesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpaces + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpacesExtension: + title: tt_PTZSpacesExtension + type: object + description: '' + xml: + name: PTZSpacesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space2DDescription: + title: tt_Space2DDescription + required: + - URI + - XRange + - YRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of y-axis. + xml: + name: YRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space2DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Space1DDescription: + title: tt_Space1DDescription + required: + - URI + - XRange + type: object + properties: + URI: + type: string + description: A URI of coordinate systems. + xml: + name: URI + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + XRange: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: A range of x-axis. + xml: + name: XRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Space1DDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZSpeed: + title: tt_PTZSpeed + type: object + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/tt_Vector2D' + - 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. + xml: + name: PanTilt + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Zoom: + allOf: + - $ref: '#/components/schemas/tt_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) Zoom movement should not be affected. + xml: + name: Zoom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPreset: + title: tt_PTZPreset + type: object + properties: + token: + maxLength: 64 + type: string + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: A list of preset position name. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: A list of preset position. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPreset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourState: + title: tt_PTZPresetTourState + enum: + - Idle + - Touring + - Paused + - Extended + type: string + description: '' + xml: + name: PTZPresetTourState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourDirection: + title: tt_PTZPresetTourDirection + enum: + - Forward + - Backward + - Extended + type: string + description: '' + xml: + name: PTZPresetTourDirection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOperation: + title: tt_PTZPresetTourOperation + enum: + - Start + - Stop + - Pause + - Extended + type: string + description: '' + xml: + name: PTZPresetTourOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PresetTour: + title: tt_PresetTour + required: + - Status + - AutoStart + - StartingCondition + type: object + properties: + token: + maxLength: 64 + type: string + description: Unique identifier of this preset tour. + xml: + name: token + prefix: tt + attribute: true + wrapped: false + Name: + maxLength: 64 + type: string + description: Readable name of the preset tour. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Status: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset tour. + xml: + name: Status + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoStart: + type: boolean + description: Auto Start flag of the preset tour. True allows the preset tour to be activated always. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourSpot' + description: A list of detail of touring spots including preset positions. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PresetTour + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourExtension: + title: tt_PTZPresetTourExtension + type: object + description: '' + xml: + name: PTZPresetTourExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpot: + title: tt_PTZPresetTourSpot + required: + - PresetDetail + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on moving toward this tour spot. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + type: string + description: Optional parameter to specify time duration of staying on this tour sport. + format: date-time + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotExtension: + title: tt_PTZPresetTourSpotExtension + type: object + description: '' + xml: + name: PTZPresetTourSpotExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetail: + title: tt_PTZPresetTourPresetDetail + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourTypeExtension: + title: tt_PTZPresetTourTypeExtension + type: object + description: '' + xml: + name: PTZPresetTourTypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatus: + title: tt_PTZPresetTourStatus + required: + - State + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + xml: + name: CurrentTourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStatusExtension: + title: tt_PTZPresetTourStatusExtension + type: object + description: '' + xml: + name: PTZPresetTourStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingCondition: + title: tt_PTZPresetTourStartingCondition + type: object + properties: + RandomPresetOrder: + type: 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. + xml: + name: RandomPresetOrder + prefix: tt + attribute: true + wrapped: false + RecurringTime: + type: integer + description: Optional parameter to specify how many times the preset tour is recurred. + format: int32 + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + type: string + description: Optional parameter to specify how long time duration the preset tour is recurred. + format: date-time + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour goes. Forward shall be chosen in case it is omitted. + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionExtension: + title: tt_PTZPresetTourStartingConditionExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourOptions: + title: tt_PTZPresetTourOptions + required: + - AutoStart + - StartingCondition + - TourSpot + type: object + properties: + AutoStart: + type: boolean + description: Indicates whether or not the AutoStart is supported. + xml: + name: AutoStart + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartingCondition: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + xml: + name: StartingCondition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TourSpot: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + xml: + name: TourSpot + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourSpotOptions: + title: tt_PTZPresetTourSpotOptions + required: + - PresetDetail + - StayTime + type: object + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position of the tour spot. + xml: + name: PresetDetail + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StayTime: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of stay time for a tour spot. + xml: + name: StayTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourSpotOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptions: + title: tt_PTZPresetTourPresetDetailOptions + type: object + properties: + PresetToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: PresetToken + attribute: false + wrapped: false + description: A list of available Preset Tokens for tour spots. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Home: + type: boolean + description: An option to indicate Home postion for tour spots. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + xml: + name: PanTiltPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/tt_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + xml: + name: ZoomPositionSpace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourPresetDetailOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourPresetDetailOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourPresetDetailOptionsExtension: + title: tt_PTZPresetTourPresetDetailOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourPresetDetailOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptions: + title: tt_PTZPresetTourStartingConditionOptions + type: object + properties: + RecurringTime: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Supported range of Recurring Time. + xml: + name: RecurringTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecurringDuration: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of Recurring Duration. + xml: + name: RecurringDuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Direction: + type: array + items: + $ref: '#/components/schemas/tt_PTZPresetTourDirection' + description: Supported options for Direction of Preset Tour. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourStartingConditionOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPresetTourStartingConditionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PTZPresetTourStartingConditionOptionsExtension: + title: tt_PTZPresetTourStartingConditionOptionsExtension + type: object + description: '' + xml: + name: PTZPresetTourStartingConditionOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveAndTrackMethod: + title: tt_MoveAndTrackMethod + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + type: string + description: '' + xml: + name: MoveAndTrackMethod + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus: + title: tt_ImagingStatus + required: + - FocusStatus + type: object + properties: + FocusStatus: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus' + - xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus: + title: tt_FocusStatus + required: + - Position + - MoveStatus + - Error + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration: + title: tt_FocusConfiguration + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: >- + Parameter to set autofocus far limit (unit: meter). + + If set to 0.0, infinity will be used. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AutoFocusMode: + title: tt_AutoFocusMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AFModes: + title: tt_AFModes + enum: + - OnceAfterMove + type: string + description: '' + xml: + name: AFModes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings: + title: tt_ImagingSettings + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension: + title: tt_ImagingSettingsExtension + type: object + description: '' + xml: + name: ImagingSettingsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure: + title: tt_Exposure + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + description: Minimum value of the iris range allowed to be used by the algorithm. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + description: Maximum value of the iris range allowed to be used by the algorithm. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + description: The fixed attenuation of input light affected by the iris (dB). 0dB maps to a fully opened iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicMode: + title: tt_WideDynamicMode + enum: + - OFF + - ON + type: string + description: '' + xml: + name: WideDynamicMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange: + title: tt_WideDynamicRange + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: White dynamic range (on/off) + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unitless) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationMode: + title: tt_BacklightCompensationMode + enum: + - OFF + - ON + type: string + description: Enumeration describing the available backlight compenstation modes. + xml: + name: BacklightCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation: + title: tt_BacklightCompensation + required: + - Mode + - Level + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposurePriority: + title: tt_ExposurePriority + enum: + - LowNoise + - FrameRate + type: string + description: '' + xml: + name: ExposurePriority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions: + title: tt_ImagingOptions + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions' + - xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions' + - xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions' + - xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions' + - xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions' + - xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions: + title: tt_WideDynamicRangeOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions: + title: tt_BacklightCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions: + title: tt_FocusOptions + required: + - DefaultSpeed + - NearLimit + - FarLimit + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions: + title: tt_ExposureOptions + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions: + title: tt_WhiteBalanceOptions + required: + - Mode + - YrGain + - YbGain + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusMove: + title: tt_FocusMove + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocus' + - description: Parameters for the absolute focus control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocus' + - description: Parameters for the relative focus control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocus' + - description: Parameter for the continuous focus control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusMove + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocus: + title: tt_AbsoluteFocus + required: + - Position + type: object + properties: + Position: + type: number + description: Position parameter for the absolute focus control. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the absolute focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocus: + title: tt_RelativeFocus + required: + - Distance + type: object + properties: + Distance: + type: number + description: Distance parameter for the relative focus control. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + type: number + description: Speed parameter for the relative focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocus: + title: tt_ContinuousFocus + required: + - Speed + type: object + properties: + Speed: + type: number + description: Speed parameter for the Continuous focus control. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions: + title: tt_MoveOptions + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions' + - xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AbsoluteFocusOptions: + title: tt_AbsoluteFocusOptions + required: + - Position + type: object + properties: + Position: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AbsoluteFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions: + title: tt_RelativeFocusOptions + required: + - Distance + - Speed + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ContinuousFocusOptions: + title: tt_ContinuousFocusOptions + required: + - Speed + type: object + properties: + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ContinuousFocusOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureMode: + title: tt_ExposureMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: ExposureMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Enabled: + title: tt_Enabled + enum: + - ENABLED + - DISABLED + type: string + description: '' + xml: + name: Enabled + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceMode: + title: tt_WhiteBalanceMode + enum: + - AUTO + - MANUAL + type: string + description: '' + xml: + name: WhiteBalanceMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterMode: + title: tt_IrCutFilterMode + enum: + - ON + - OFF + - AUTO + type: string + description: '' + xml: + name: IrCutFilterMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance: + title: tt_WhiteBalance + required: + - Mode + - CrGain + - CbGain + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20: + title: tt_ImagingStatus20 + type: object + properties: + FocusStatus20: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20' + - description: Status of focus. + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingStatus20Extension: + title: tt_ImagingStatus20Extension + type: object + description: '' + xml: + name: ImagingStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20: + title: tt_FocusStatus20 + required: + - Position + - MoveStatus + type: object + properties: + Position: + type: number + description: Status of focus position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MoveStatus: + allOf: + - $ref: '#/components/schemas/tt_MoveStatus' + - description: Status of focus MoveStatus. + xml: + name: MoveStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: Error status of focus. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusStatus20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusStatus20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusStatus20Extension: + title: tt_FocusStatus20Extension + type: object + description: '' + xml: + name: FocusStatus20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettings20: + title: tt_ImagingSettings20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + type: number + description: Image brightness (unit unspecified). + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + type: number + description: Color saturation of the image (unit unspecified). + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + type: number + description: Contrast of the image (unit unspecified). + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_Exposure20' + - description: Exposure mode of the device. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20' + - description: Focus configuration. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilter: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + xml: + name: IrCutFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + type: number + description: Sharpness of the Video image. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRange20' + - description: WDR settings. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20' + - description: White balance settings. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension20' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command. + xml: + name: ImagingSettings20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension20: + title: tt_ImagingSettingsExtension20 + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension202' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension202: + title: tt_ImagingSettingsExtension202 + type: object + properties: + IrCutFilterAutoAdjustment: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustment' + description: An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension203' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension202 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension203: + title: tt_ImagingSettingsExtension203 + type: object + properties: + ToneCompensation: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Defogging: + allOf: + - $ref: '#/components/schemas/tt_Defogging' + - description: Optional element to configure Image Defogging. + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReduction: + allOf: + - $ref: '#/components/schemas/tt_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingSettingsExtension204' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingSettingsExtension203 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingSettingsExtension204: + title: tt_ImagingSettingsExtension204 + type: object + description: '' + xml: + name: ImagingSettingsExtension204 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilization: + title: tt_ImageStabilization + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified) + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationExtension: + title: tt_ImageStabilizationExtension + type: object + description: '' + xml: + name: ImageStabilizationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationMode: + title: tt_ImageStabilizationMode + enum: + - OFF + - ON + - AUTO + - Extended + type: string + description: '' + xml: + name: ImageStabilizationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustment: + title: tt_IrCutFilterAutoAdjustment + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: string + description: Specifies which boundaries to automatically toggle Ir cut filter following parameters are applied to. Its options shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + name: BoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: number + 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). + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTime: + type: string + description: Delay time of toggling Ir cut filter to on/off after crossing of the boundary exposure levels. + format: date-time + xml: + name: ResponseTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentExtension: + title: tt_IrCutFilterAutoAdjustmentExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoBoundaryType: + title: tt_IrCutFilterAutoBoundaryType + enum: + - Common + - ToOn + - ToOff + - Extended + type: string + description: '' + xml: + name: IrCutFilterAutoBoundaryType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRange20: + title: tt_WideDynamicRange20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether WDR mode is enabled or disabled (on/off). + xml: + name: WideDynamicRange20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensation20: + title: tt_BacklightCompensation20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter (unit unspecified). + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing whether BLC mode is enabled or disabled (on/off). + xml: + name: BacklightCompensation20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Exposure20: + title: tt_Exposure20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ExposureMode' + - description: Exposure Mode + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + allOf: + - $ref: '#/components/schemas/tt_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Window: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Rectangular exposure mask. + xml: + name: Window + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + type: number + description: Minimum value of exposure time range allowed to be used by the algorithm. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + type: number + description: Maximum value of exposure time range allowed to be used by the algorithm. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + type: number + description: Minimum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + type: number + description: Maximum value of the sensor gain range that is allowed to be used by the algorithm. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + type: number + 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. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + type: number + 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. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + type: number + description: The fixed exposure time used by the image sensor (μs). + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + type: number + description: The fixed gain used by the image sensor (dB). + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + type: number + 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. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Type describing the exposure settings. + xml: + name: Exposure20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensation: + title: tt_ToneCompensation + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic ToneCompensation feature. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationExtension: + title: tt_ToneCompensationExtension + type: object + description: '' + xml: + name: ToneCompensationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationMode: + title: tt_ToneCompensationMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: ToneCompensationMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Defogging: + title: tt_Defogging + required: + - Mode + type: object + properties: + Mode: + type: string + description: Parameter to enable/disable or automatic Defogging feature. Its options shall be chosen from tt:DefoggingMode Type. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: number + description: Optional level parameter specified with unitless normalized value from 0.0 to +1.0. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_DefoggingExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Defogging + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingExtension: + title: tt_DefoggingExtension + type: object + description: '' + xml: + name: DefoggingExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingMode: + title: tt_DefoggingMode + enum: + - OFF + - ON + - AUTO + type: string + description: '' + xml: + name: DefoggingMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReduction: + title: tt_NoiseReduction + required: + - Level + type: object + properties: + Level: + type: number + description: Level parameter specified with unitless normalized value from 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReduction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20: + title: tt_ImagingOptions20 + type: object + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/tt_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + xml: + name: BacklightCompensation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Brightness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Brightness. + xml: + name: Brightness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorSaturation: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Color Saturation. + xml: + name: ColorSaturation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Contrast: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Contrast. + xml: + name: Contrast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Exposure: + allOf: + - $ref: '#/components/schemas/tt_ExposureOptions20' + - description: Valid range of Exposure. + xml: + name: Exposure + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Focus: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20' + - description: Valid range of Focus. + xml: + name: Focus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IrCutFilterModes: + type: array + items: + $ref: '#/components/schemas/tt_IrCutFilterMode' + description: Valid range of IrCutFilterModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sharpness: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of Sharpness. + xml: + name: Sharpness + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/tt_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + xml: + name: WideDynamicRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + WhiteBalance: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + xml: + name: WhiteBalance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension: + title: tt_ImagingOptions20Extension + type: object + properties: + ImageStabilization: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + xml: + name: ImageStabilization + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension2' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension2: + title: tt_ImagingOptions20Extension2 + type: object + properties: + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto mode. + xml: + name: IrCutFilterAutoAdjustment + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension3' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension2 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension3: + title: tt_ImagingOptions20Extension3 + type: object + properties: + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/tt_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/tt_DefoggingOptions' + - description: Options of parameters for Defogging feature. + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/tt_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImagingOptions20Extension4' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImagingOptions20Extension3 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImagingOptions20Extension4: + title: tt_ImagingOptions20Extension4 + type: object + description: '' + xml: + name: ImagingOptions20Extension4 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptions: + title: tt_ImageStabilizationOptions + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ImageStabilizationMode' + description: Supported options of Image Stabilization mode parameter. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Image Stabilization. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ImageStabilizationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ImageStabilizationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageStabilizationOptionsExtension: + title: tt_ImageStabilizationOptionsExtension + type: object + description: '' + xml: + name: ImageStabilizationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptions: + title: tt_IrCutFilterAutoAdjustmentOptions + required: + - BoundaryType + type: object + properties: + BoundaryType: + type: array + items: + type: string + xml: + name: BoundaryType + attribute: false + wrapped: false + description: Supported options of boundary types for adjustment of Ir cut filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BoundaryOffset: + type: boolean + description: Indicates whether or not boundary offset for toggling Ir cut filter is supported. + xml: + name: BoundaryOffset + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/tt_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + xml: + name: ResponseTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_IrCutFilterAutoAdjustmentOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_IrCutFilterAutoAdjustmentOptionsExtension: + title: tt_IrCutFilterAutoAdjustmentOptionsExtension + type: object + description: '' + xml: + name: IrCutFilterAutoAdjustmentOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WideDynamicRangeOptions20: + title: tt_WideDynamicRangeOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WideDynamicMode' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WideDynamicRangeOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_BacklightCompensationOptions20: + title: tt_BacklightCompensationOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_BacklightCompensationMode' + description: "'ON' or 'OFF'" + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Level range of BacklightCompensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: BacklightCompensationOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ExposureOptions20: + title: tt_ExposureOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_ExposureMode' + description: Exposure Mode + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: array + items: + $ref: '#/components/schemas/tt_ExposurePriority' + description: The exposure priority mode (low noise/framerate). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum ExposureTime. + xml: + name: MinExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum ExposureTime. + xml: + name: MaxExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Gain. + xml: + name: MinGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Gain. + xml: + name: MaxGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MinIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Minimum Iris. + xml: + name: MinIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxIris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Maximum Iris. + xml: + name: MaxIris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ExposureTime: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the ExposureTime. + xml: + name: ExposureTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Gain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Gain. + xml: + name: Gain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Iris: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of the Iris. + xml: + name: Iris + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ExposureOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MoveOptions20: + title: tt_MoveOptions20 + type: object + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/tt_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + xml: + name: Absolute + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Relative: + allOf: + - $ref: '#/components/schemas/tt_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + xml: + name: Relative + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Continuous: + allOf: + - $ref: '#/components/schemas/tt_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + xml: + name: Continuous + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MoveOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RelativeFocusOptions20: + title: tt_RelativeFocusOptions20 + required: + - Distance + type: object + properties: + Distance: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the distance. + xml: + name: Distance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Speed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid ranges of the speed. + xml: + name: Speed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RelativeFocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20: + title: tt_WhiteBalance20 + required: + - Mode + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceMode' + - description: "'AUTO' or 'MANUAL'" + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CrGain: + type: number + description: Rgain (unitless). + xml: + name: CrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CbGain: + type: number + description: Bgain (unitless). + xml: + name: CbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalance20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalance20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalance20Extension: + title: tt_WhiteBalance20Extension + type: object + description: '' + xml: + name: WhiteBalance20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20: + title: tt_FocusConfiguration20 + required: + - AutoFocusMode + type: object + properties: + AFMode: + type: string + description: Zero or more modes as defined in enumeration tt:AFModes. + xml: + name: AFMode + prefix: tt + attribute: true + wrapped: false + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/tt_AutoFocusMode' + - description: Mode of auto focus. + xml: + name: AutoFocusMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + type: number + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + type: number + description: 'Parameter to set autofocus near limit (unit: meter).' + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + type: number + description: 'Parameter to set autofocus far limit (unit: meter).' + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusConfiguration20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusConfiguration20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusConfiguration20Extension: + title: tt_FocusConfiguration20Extension + type: object + description: '' + xml: + name: FocusConfiguration20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20: + title: tt_WhiteBalanceOptions20 + required: + - Mode + type: object + properties: + Mode: + type: array + items: + $ref: '#/components/schemas/tt_WhiteBalanceMode' + description: Mode of WhiteBalance. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YrGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YrGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + YbGain: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: YbGain + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_WhiteBalanceOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: WhiteBalanceOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_WhiteBalanceOptions20Extension: + title: tt_WhiteBalanceOptions20Extension + type: object + description: '' + xml: + name: WhiteBalanceOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20: + title: tt_FocusOptions20 + type: object + properties: + AutoFocusModes: + type: array + items: + $ref: '#/components/schemas/tt_AutoFocusMode' + description: Supported modes for auto focus. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of DefaultSpeed. + xml: + name: DefaultSpeed + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NearLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of NearLimit. + xml: + name: NearLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FarLimit: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - description: Valid range of FarLimit. + xml: + name: FarLimit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_FocusOptions20Extension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20 + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FocusOptions20Extension: + title: tt_FocusOptions20Extension + type: object + properties: + AFModes: + type: array + items: + type: string + xml: + name: AFModes + attribute: false + wrapped: false + description: Supported options for auto focus. Options shall be chosen from tt:AFModes. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FocusOptions20Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ToneCompensationOptions: + title: tt_ToneCompensationOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Tone Compensation mode. Its options shall be chosen from tt:ToneCompensationMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Tone Compensation. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ToneCompensationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DefoggingOptions: + title: tt_DefoggingOptions + required: + - Mode + - Level + type: object + properties: + Mode: + type: array + items: + type: string + xml: + name: Mode + attribute: false + wrapped: false + description: Supported options for Defogging mode. Its options shall be chosen from tt:DefoggingMode Type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Level: + type: boolean + description: Indicates whether or not support Level parameter for Defogging. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DefoggingOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_NoiseReductionOptions: + title: tt_NoiseReductionOptions + required: + - Level + type: object + properties: + Level: + type: boolean + description: Indicates whether or not support Level parameter for NoiseReduction. + xml: + name: Level + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: NoiseReductionOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ImageSendingType: + title: tt_ImageSendingType + enum: + - Embedded + - LocalStorage + - RemoteStorage + type: string + description: '' + xml: + name: ImageSendingType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PropertyOperation: + title: tt_PropertyOperation + enum: + - Initialized + - Deleted + - Changed + type: string + description: '' + xml: + name: PropertyOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Message: + title: tt_Message + required: + - UtcTime + type: object + properties: + UtcTime: + type: string + format: date-time + xml: + name: UtcTime + prefix: tt + attribute: true + wrapped: false + PropertyOperation: + allOf: + - $ref: '#/components/schemas/tt_PropertyOperation' + - xml: + name: PropertyOperation + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: Token value pairs that triggered this message. Typically only one item is present. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Message + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageExtension: + title: tt_MessageExtension + type: object + description: '' + xml: + name: MessageExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemList: + title: tt_ItemList + type: object + properties: + SimpleItem: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItem' + description: Value name pair as defined by the corresponding description. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItem: + type: array + items: + $ref: '#/components/schemas/tt_ElementItem' + description: Complex value structure. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ItemList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListExtension: + title: tt_ItemListExtension + type: object + description: '' + xml: + name: ItemListExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescription: + title: tt_MessageDescription + type: object + properties: + IsProperty: + type: 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. + xml: + name: IsProperty + prefix: tt + attribute: true + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + Set of tokens producing this message. The list may only contain SimpleItemDescription items. + The set of tokens identify the component within the WS-Endpoint, which is responsible for the producing the message. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Key: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes optional message payload parameters that may be used as key. E.g. object IDs of tracked objects are conveyed as key. + xml: + name: Key + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Data: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: Describes the payload of the message. + xml: + name: Data + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MessageDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MessageDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MessageDescriptionExtension: + title: tt_MessageDescriptionExtension + type: object + description: '' + xml: + name: MessageDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescription: + title: tt_ItemListDescription + type: object + properties: + SimpleItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_SimpleItemDescription' + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ElementItemDescription: + type: array + items: + $ref: '#/components/schemas/tt_ElementItemDescription' + description: Description of a complex type. The Type must reference a defined type. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + Describes a list of items. Each item in the list shall have a unique name. + The list is designed as linear structure without optional or unbounded elements. + Use ElementItems only when complex structures are inevitable. + xml: + name: ItemListDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ItemListDescriptionExtension: + title: tt_ItemListDescriptionExtension + type: object + description: '' + xml: + name: ItemListDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Polyline: + title: tt_Polyline + required: + - Point + type: object + properties: + Point: + type: array + items: + $ref: '#/components/schemas/tt_Vector' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Polyline + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Direction: + title: tt_Direction + enum: + - Left + - Right + - Any + type: string + description: '' + xml: + name: Direction + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfiguration: + title: tt_AnalyticsEngineConfiguration + type: object + properties: + AnalyticsModule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineConfigurationExtension: + title: tt_AnalyticsEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfiguration: + title: tt_RuleEngineConfiguration + type: object + properties: + Rule: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RuleEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RuleEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RuleEngineConfigurationExtension: + title: tt_RuleEngineConfigurationExtension + type: object + description: '' + xml: + name: RuleEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Config: + title: tt_Config + required: + - Name + - Type + - Parameters + type: object + properties: + Name: + type: string + description: Name of the configuration. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + 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. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemList' + - description: List of configuration parameters as defined in the corresponding description. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: Config + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescription: + title: tt_ConfigDescription + required: + - Name + - Parameters + type: object + properties: + Name: + type: string + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies the type of rule, not a type definition in a schema. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + fixed: + type: boolean + description: The fixed attribute signals that it is not allowed to add or remove this type of configuration. + xml: + name: fixed + prefix: tt + attribute: true + wrapped: false + maxInstances: + type: integer + description: The maxInstances attribute signals the maximum number of instances per configuration. + format: int32 + xml: + name: maxInstances + prefix: tt + attribute: true + wrapped: false + Parameters: + allOf: + - $ref: '#/components/schemas/tt_ItemListDescription' + - description: >- + List describing the configuration parameters. The names of the parameters must be unique. If possible SimpleItems + should be used to transport the information to ease parsing of dynamically defined messages by a client + application. + xml: + name: Parameters + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Messages: + type: array + items: + $ref: '#/components/schemas/tt_Messages' + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ConfigDescriptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ConfigDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ConfigDescriptionExtension: + title: tt_ConfigDescriptionExtension + type: object + description: '' + xml: + name: ConfigDescriptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRules: + title: tt_SupportedRules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + RuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: RuleContentSchemaLocation + attribute: false + wrapped: false + description: Lists the location of all schemas that are referenced in the rules. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: List of rules supported by the Video Analytics configuration.. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedRulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedRules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedRulesExtension: + title: tt_SupportedRulesExtension + type: object + description: '' + xml: + name: SupportedRulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModules: + title: tt_SupportedAnalyticsModules + type: object + properties: + Limit: + type: integer + description: Maximum number of concurrent instances. + format: int32 + xml: + name: Limit + prefix: tt + attribute: true + wrapped: false + AnalyticsModuleContentSchemaLocation: + type: array + items: + type: string + xml: + name: AnalyticsModuleContentSchemaLocation + attribute: false + wrapped: false + description: >- + It optionally contains a list of URLs that provide the location of schema files. + These schema files describe the types and elements used in the analytics module descriptions. + Analytics module descriptions that reference types or elements imported from any ONVIF defined schema files + need not explicitly list those schema files. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsModuleDescription: + type: array + items: + $ref: '#/components/schemas/tt_ConfigDescription' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SupportedAnalyticsModulesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SupportedAnalyticsModules + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SupportedAnalyticsModulesExtension: + title: tt_SupportedAnalyticsModulesExtension + type: object + description: '' + xml: + name: SupportedAnalyticsModulesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArray: + title: tt_PolylineArray + required: + - Segment + type: object + properties: + Segment: + type: array + items: + $ref: '#/components/schemas/tt_Polyline' + description: Contains array of Polyline + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PolylineArrayExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayExtension: + title: tt_PolylineArrayExtension + type: object + description: '' + xml: + name: PolylineArrayExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolylineArrayConfiguration: + title: tt_PolylineArrayConfiguration + required: + - PolylineArray + type: object + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/tt_PolylineArray' + - description: Contains PolylineArray configuration data + xml: + name: PolylineArray + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolylineArrayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpression: + title: tt_MotionExpression + required: + - Expression + type: object + properties: + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Expression: + type: string + description: Motion Expression data structure contains motion expression which is based on Scene Descriptor schema with XPATH syntax. The Type argument could allow introduction of different dialects + xml: + name: Expression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MotionExpressionConfiguration: + title: tt_MotionExpressionConfiguration + required: + - MotionExpression + type: object + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/tt_MotionExpression' + - description: Contains Rule MotionExpression configuration + xml: + name: MotionExpression + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MotionExpressionConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CellLayout: + title: tt_CellLayout + required: + - Columns + - Rows + - Transformation + type: object + properties: + Columns: + type: integer + description: Number of columns of the cell grid (x dimension) + format: int32 + xml: + name: Columns + prefix: tt + attribute: true + wrapped: false + Rows: + type: integer + description: Number of rows of the cell grid (y dimension) + format: int32 + xml: + name: Rows + prefix: tt + attribute: true + wrapped: false + Transformation: + allOf: + - $ref: '#/components/schemas/tt_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid is starting from the upper left corner and x dimension is going from left to right and the y dimension from up to down. + xml: + name: Transformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: CellLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneConfiguration: + title: tt_PaneConfiguration + required: + - Token + type: object + properties: + PaneName: + type: string + description: Optional name of the pane configuration. + xml: + name: PaneName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioOutputToken: + maxLength: 64 + type: string + description: >- + If the device has audio outputs, this element contains a pointer to the audio output that is associated with the pane. A client + + can retrieve the available audio outputs of a device using the GetAudioOutputs command of the DeviceIO service. + xml: + name: AudioOutputToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioSourceToken: + maxLength: 64 + type: string + description: >- + If the device has audio sources, this element contains a pointer to the audio source that is associated with this pane. + + The 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 + + DeviceIO service. + xml: + name: AudioSourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfiguration' + - description: >- + The configuration of the audio encoder including codec, bitrate + + and sample rate. + xml: + name: AudioEncoderConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + maxLength: 64 + type: string + description: >- + A pointer to a Receiver that has the necessary information to receive + data 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 + GetReceivers command of the Receiver Service. + xml: + name: ReceiverToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + maxLength: 64 + type: string + description: A unique identifier in the display device. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration of the streaming and coding settings of a Video window. + xml: + name: PaneConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayout: + title: tt_PaneLayout + required: + - Pane + - Area + type: object + properties: + Pane: + maxLength: 64 + type: string + description: Reference to the configuration of the streaming and coding parameters. + xml: + name: Pane + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Area: + allOf: + - $ref: '#/components/schemas/tt_Rectangle' + - description: Describes the location and size of the area on the monitor. The area coordinate values are espressed in normalized units [-1.0, 1.0]. + xml: + name: Area + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A pane layout describes one Video window of a display. It links a pane configuration to a region of the screen. + xml: + name: PaneLayout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Layout: + title: tt_Layout + required: + - PaneLayout + type: object + properties: + PaneLayout: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayout' + description: List of panes assembling the display layout. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A layout describes a set of Video windows that are displayed simultaniously on a display. + xml: + name: Layout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutExtension: + title: tt_LayoutExtension + type: object + description: '' + xml: + name: LayoutExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_CodingCapabilities: + title: tt_CodingCapabilities + required: + - VideoDecodingCapabilities + type: object + properties: + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes the supported codecs and their configuration. + xml: + name: AudioEncodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes the supported codecs and their settings. + xml: + name: AudioDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/tt_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their configuration. + xml: + name: VideoDecodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: This type contains the Audio and Video coding capabilities of a display service. + xml: + name: CodingCapabilities + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptions: + title: tt_LayoutOptions + required: + - PaneLayoutOptions + type: object + properties: + PaneLayoutOptions: + type: array + items: + $ref: '#/components/schemas/tt_PaneLayoutOptions' + description: Lists the possible Pane Layouts of the Video Output + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_LayoutOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: The options supported for a display layout. + xml: + name: LayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_LayoutOptionsExtension: + title: tt_LayoutOptionsExtension + type: object + description: '' + xml: + name: LayoutOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneLayoutOptions: + title: tt_PaneLayoutOptions + required: + - Area + type: object + properties: + Area: + type: array + items: + $ref: '#/components/schemas/tt_Rectangle' + description: List of areas assembling a layout. Coordinate values are in the range [-1.0, 1.0]. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_PaneOptionExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a pane layout describing a complete display layout. + xml: + name: PaneLayoutOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PaneOptionExtension: + title: tt_PaneOptionExtension + type: object + description: '' + xml: + name: PaneOptionExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Receiver: + title: tt_Receiver + required: + - Token + - Configuration + type: object + properties: + Token: + maxLength: 64 + type: string + description: Unique identifier of the receiver. + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Description of a receiver, including its token and configuration. + xml: + name: Receiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverConfiguration: + title: tt_ReceiverConfiguration + required: + - Mode + - MediaUri + - StreamSetup + type: object + properties: + Mode: + allOf: + - $ref: '#/components/schemas/tt_ReceiverMode' + - description: 'The following connection modes are defined:' + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MediaUri: + type: string + description: Details of the URI to which the receiver should connect. + xml: + name: MediaUri + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StreamSetup: + allOf: + - $ref: '#/components/schemas/tt_StreamSetup' + - description: Stream connection parameters. + xml: + name: StreamSetup + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describes the configuration of a receiver. + xml: + name: ReceiverConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverMode: + title: tt_ReceiverMode + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + description: Specifies a receiver connection mode. + xml: + name: ReceiverMode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverState: + title: tt_ReceiverState + enum: + - NotConnected + - Connecting + - Connected + - Unknown + type: string + description: Specifies the current connection state of the receiver. + xml: + name: ReceiverState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReceiverStateInformation: + title: tt_ReceiverStateInformation + required: + - State + - AutoCreated + type: object + properties: + State: + allOf: + - $ref: '#/components/schemas/tt_ReceiverState' + - description: 'The connection state of the receiver may have one of the following states:' + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreated: + type: boolean + description: Indicates whether or not the receiver was created automatically. + xml: + name: AutoCreated + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Contains information about a receiver's current state. + xml: + name: ReceiverStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceReference: + title: tt_SourceReference + required: + - Token + type: object + properties: + Type: + type: string + default: http://www.onvif.org/ver10/schema/Receiver + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + Token: + maxLength: 64 + type: string + xml: + name: Token + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_DateTimeRange: + title: tt_DateTimeRange + required: + - From + - Until + type: object + properties: + From: + type: string + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: DateTimeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSummary: + title: tt_RecordingSummary + required: + - DataFrom + - DataUntil + - NumberRecordings + type: object + properties: + DataFrom: + type: string + description: The earliest point in time where there is recorded data on the device. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataUntil: + type: string + description: The most recent point in time where there is recorded data on the device. + format: date-time + xml: + name: DataUntil + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + NumberRecordings: + type: integer + description: The device contains this many recordings. + format: int32 + xml: + name: NumberRecordings + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingSummary + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScope: + title: tt_SearchScope + type: object + properties: + IncludedSources: + type: array + items: + $ref: '#/components/schemas/tt_SourceReference' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + IncludedRecordings: + type: array + items: + maxLength: 64 + type: string + xml: + name: IncludedRecordings + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformationFilter: + type: string + 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. + xml: + name: RecordingInformationFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SearchScopeExtension' + - description: Extension point + xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A structure for defining a limited scope when searching in recorded data. + xml: + name: SearchScope + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchScopeExtension: + title: tt_SearchScopeExtension + type: object + description: '' + xml: + name: SearchScopeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EventFilter: + title: tt_EventFilter + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + xml: + name: EventFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_PTZPositionFilter: + title: tt_PTZPositionFilter + required: + - MinPosition + - MaxPosition + - EnterOrExit + type: object + properties: + MinPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + xml: + name: MinPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaxPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + xml: + name: MaxPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EnterOrExit: + type: boolean + description: If true, search for when entering the specified PTZ volume. + xml: + name: EnterOrExit + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PTZPositionFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataFilter: + title: tt_MetadataFilter + required: + - MetadataStreamFilter + type: object + properties: + MetadataStreamFilter: + type: string + xml: + name: MetadataStreamFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataFilter + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindRecordingResultList: + title: tt_FindRecordingResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingInformation: + type: array + items: + $ref: '#/components/schemas/tt_RecordingInformation' + description: A RecordingInformation structure for each found recording matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindRecordingResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResultList: + title: tt_FindEventResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindEventResult' + description: A FindEventResult structure for each found event matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindEventResult: + title: tt_FindEventResult + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: The recording where this event was found. Empty string if no recording is associated with this event. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the track where this event was found. Empty string if no track is associated with this event. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the event occured. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + xml: + name: Event + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + StartStateEvent: + type: boolean + 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. + xml: + name: StartStateEvent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindEventResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResultList: + title: tt_FindPTZPositionResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindPTZPositionResult' + description: A FindPTZPositionResult structure for each found PTZ position matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindPTZPositionResult: + title: tt_FindPTZPositionResult + required: + - RecordingToken + - TrackToken + - Time + - Position + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the PTZ position. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the PTZ position. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The time when the PTZ position was valid. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: The PTZ position. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindPTZPositionResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResultList: + title: tt_FindMetadataResultList + required: + - SearchState + type: object + properties: + SearchState: + allOf: + - $ref: '#/components/schemas/tt_SearchState' + - description: The state of the search when the result is returned. Indicates if there can be more results, or if the search is completed. + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Result: + type: array + items: + $ref: '#/components/schemas/tt_FindMetadataResult' + description: A FindMetadataResult structure for each found set of Metadata matching the search. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResultList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FindMetadataResult: + title: tt_FindMetadataResult + required: + - RecordingToken + - TrackToken + - Time + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording containing the metadata. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackToken: + maxLength: 64 + type: string + description: A reference to the metadata track containing the matching metadata. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Time: + type: string + description: The point in time when the matching metadata occurs in the metadata track. + format: date-time + xml: + name: Time + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FindMetadataResult + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SearchState: + title: tt_SearchState + enum: + - Queued + - Searching + - Completed + - Unknown + type: string + description: '' + xml: + name: SearchState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingInformation: + title: tt_RecordingInformation + required: + - RecordingToken + - Source + - Content + - RecordingStatus + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: >- + Information about the source of the recording. This gives a description of where the data in the recording comes from. Since a single + recording is intended to record related material, there is just one source. It is indicates the physical location or the + major data source for the recording. Currently the recordingconfiguration cannot describe each individual data source. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EarliestRecording: + type: string + format: date-time + xml: + name: EarliestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + LatestRecording: + type: string + format: date-time + xml: + name: LatestRecording + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Track: + type: array + items: + $ref: '#/components/schemas/tt_TrackInformation' + description: Basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RecordingStatus: + allOf: + - $ref: '#/components/schemas/tt_RecordingStatus' + - xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingSourceInformation: + title: tt_RecordingSourceInformation + required: + - SourceId + - Name + - Location + - Description + - Address + type: object + properties: + SourceId: + type: string + description: >- + Identifier for the source chosen by the client that creates the structure. + This identifier is opaque to the device. Clients may use any type of URI for this field. A device shall support at least 128 characters. + xml: + name: SourceId + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Name: + maxLength: 64 + type: string + description: Informative user readable name of the source, e.g. "Camera23". A device shall support at least 20 characters. + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Location: + type: string + description: Informative description of the physical location of the source, e.g. the coordinates on a map. + xml: + name: Location + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the source. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Address: + type: string + description: URI provided by the service supplying data to be recorded. A device shall support at least 128 characters. + xml: + name: Address + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of informative desciptions of a data source. The Search searvice allows a client to filter on recordings based on information in this structure. + xml: + name: RecordingSourceInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingStatus: + title: tt_RecordingStatus + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + type: string + description: '' + xml: + name: RecordingStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackInformation: + title: tt_TrackInformation + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + type: object + properties: + TrackToken: + maxLength: 64 + type: string + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track: "Video", "Audio" or "Metadata". + The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the contents of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataFrom: + type: string + description: The start date and time of the oldest recorded data in the track. + format: date-time + xml: + name: DataFrom + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DataTo: + type: string + description: The stop date and time of the newest recorded data in the track. + format: date-time + xml: + name: DataTo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackType: + title: tt_TrackType + enum: + - Video + - Audio + - Metadata + - Extended + type: string + description: '' + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MediaAttributes: + title: tt_MediaAttributes + required: + - RecordingToken + - From + - Until + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: A reference to the recording that has these attributes. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TrackAttributes: + type: array + items: + $ref: '#/components/schemas/tt_TrackAttributes' + description: A set of attributes for each track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + From: + type: string + description: The attributes are valid from this point in time in the recording. + format: date-time + xml: + name: From + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Until: + type: string + 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. + format: date-time + xml: + name: Until + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: A set of media attributes valid for a recording at a point in time or for a time interval. + xml: + name: MediaAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributes: + title: tt_TrackAttributes + required: + - TrackInformation + type: object + properties: + TrackInformation: + allOf: + - $ref: '#/components/schemas/tt_TrackInformation' + - description: The basic information about the track. Note that a track may represent a single contiguous time span or consist of multiple slices. + xml: + name: TrackInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoAttributes: + allOf: + - $ref: '#/components/schemas/tt_VideoAttributes' + - description: If the track is a video track, exactly one of this structure shall be present and contain the video attributes. + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AudioAttributes: + allOf: + - $ref: '#/components/schemas/tt_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure shall be present and contain the audio attributes. + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/tt_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure shall be present and contain the metadata attributes. + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_TrackAttributesExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackAttributesExtension: + title: tt_TrackAttributesExtension + type: object + description: '' + xml: + name: TrackAttributesExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_VideoAttributes: + title: tt_VideoAttributes + required: + - Width + - Height + - Encoding + - Framerate + type: object + properties: + Bitrate: + type: integer + description: Average bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Width: + type: integer + description: The width of the video in pixels. + format: int32 + xml: + name: Width + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Height: + type: integer + description: The height of the video in pixels. + format: int32 + xml: + name: Height + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Video encoding of the track. Use value from tt:VideoEncoding for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Framerate: + type: number + description: Average framerate in frames per second. + xml: + name: Framerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: VideoAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioAttributes: + title: tt_AudioAttributes + required: + - Encoding + - Samplerate + type: object + properties: + Bitrate: + type: integer + description: The bitrate in kbps. + format: int32 + xml: + name: Bitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Encoding: + type: string + description: Audio encoding of the track. Use values from tt:AudioEncoding for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames and + xml: + name: Encoding + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Samplerate: + type: integer + description: The sample rate in kHz. + format: int32 + xml: + name: Samplerate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataAttributes: + title: tt_MetadataAttributes + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + type: object + properties: + PtzSpaces: + type: 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. + xml: + name: PtzSpaces + prefix: tt + attribute: true + wrapped: false + CanContainPTZ: + type: boolean + description: Indicates that there can be PTZ data in the metadata track in the specified time interval. + xml: + name: CanContainPTZ + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainAnalytics: + type: boolean + description: Indicates that there can be analytics data in the metadata track in the specified time interval. + xml: + name: CanContainAnalytics + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CanContainNotifications: + type: boolean + description: Indicates that there can be notifications in the metadata track in the specified time interval. + xml: + name: CanContainNotifications + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataAttributes + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingConfiguration: + title: tt_RecordingConfiguration + required: + - Source + - Content + - MaximumRetentionTime + type: object + properties: + Source: + allOf: + - $ref: '#/components/schemas/tt_RecordingSourceInformation' + - description: Information about the source of the recording. + xml: + name: Source + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Content: + type: string + description: Informative description of the source. + xml: + name: Content + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MaximumRetentionTime: + type: string + description: >- + Sspecifies the maximum time that data in any track within the + recording shall be stored. The device shall delete any data older than the maximum retention + time. Such data shall not be accessible anymore. If the MaximumRetentionPeriod is set to 0, + the device shall not limit the retention time of stored data, except by resource constraints. + Whatever the value of MaximumRetentionTime, the device may automatically delete + recordings to free up storage space for new recordings. + format: date-time + xml: + name: MaximumRetentionTime + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_TrackConfiguration: + title: tt_TrackConfiguration + required: + - TrackType + - Description + type: object + properties: + TrackType: + allOf: + - $ref: '#/components/schemas/tt_TrackType' + - description: >- + Type of the track. It shall be equal to the strings “Video”, + “Audio” or “Metadata”. The track shall only be able to hold data of that type. + xml: + name: TrackType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Description: + type: string + description: Informative description of the track. + xml: + name: Description + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: TrackConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingsResponseItem: + title: tt_GetRecordingsResponseItem + required: + - RecordingToken + - Configuration + - Tracks + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Token of the recording. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_RecordingConfiguration' + - description: Configuration of the recording. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_GetTracksResponseList' + - description: List of tracks. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseList: + title: tt_GetTracksResponseList + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_GetTracksResponseItem' + description: Configuration of a track. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseList + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetTracksResponseItem: + title: tt_GetTracksResponseItem + required: + - TrackToken + - Configuration + type: object + properties: + TrackToken: + maxLength: 64 + type: string + description: Token of the track. + xml: + name: TrackToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Configuration: + allOf: + - $ref: '#/components/schemas/tt_TrackConfiguration' + - description: Configuration of the track. + xml: + name: Configuration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetTracksResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfiguration: + title: tt_RecordingJobConfiguration + required: + - RecordingToken + - Mode + - Priority + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identifies the recording to which this job shall store the received data. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + type: string + description: >- + The mode of the job. If it is idle, nothing shall happen. If it is active, the device shall try + to obtain data from the receivers. A client shall use GetRecordingJobState to determine if data transfer is really taking place. + xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Priority: + type: integer + description: >- + This shall be a non-negative number. If there are multiple recording jobs that store data to + the same track, the device will only store the data for the recording job with the highest + priority. The priority is specified per recording job, but the device shall determine the priority + of each track individually. If there are two recording jobs with the same priority, the device + shall record the data corresponding to the recording job that was activated the latest. + format: int32 + xml: + name: Priority + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Source: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobSource' + description: Source of the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobConfigurationExtension: + title: tt_RecordingJobConfigurationExtension + type: object + description: '' + xml: + name: RecordingJobConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSource: + title: tt_RecordingJobSource + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: >- + This field shall be a reference to the source of the data. The type of the source + is determined by the attribute Type in the SourceToken structure. If Type is + http://www.onvif.org/ver10/schema/Receiver, the token is a ReceiverReference. In this case + the device shall receive the data over the network. If Type is + http://www.onvif.org/ver10/schema/Profile, the token identifies a media profile, instructing the + device to obtain data from a profile that exists on the local device. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AutoCreateReceiver: + type: boolean + description: >- + If this field is TRUE, and if the SourceToken is omitted, the device + shall create a receiver object (through the receiver service) and assign the + ReceiverReference to the SourceToken field. When retrieving the RecordingJobConfiguration + from the device, the AutoCreateReceiver field shall never be present. + xml: + name: AutoCreateReceiver + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobTrack' + description: List of tracks associated with the recording. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobSourceExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobSourceExtension: + title: tt_RecordingJobSourceExtension + type: object + description: '' + xml: + name: RecordingJobSourceExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobTrack: + title: tt_RecordingJobTrack + required: + - SourceTag + - Destination + type: object + properties: + SourceTag: + type: string + description: >- + If the received RTSP stream contains multiple tracks of the same type, the + SourceTag differentiates between those Tracks. This field can be ignored in case of recording a local source. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: >- + The destination is the tracktoken of the track to which the device shall store the + received data. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformation: + title: tt_RecordingJobStateInformation + required: + - RecordingToken + - State + type: object + properties: + RecordingToken: + maxLength: 64 + type: string + description: Identification of the recording that the recording job records to. + xml: + name: RecordingToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over the whole RecordingJobInformation structure. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Sources: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateSource' + description: Identifies the data source of the recording job. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateInformationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateInformationExtension: + title: tt_RecordingJobStateInformationExtension + type: object + description: '' + xml: + name: RecordingJobStateInformationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateSource: + title: tt_RecordingJobStateSource + required: + - SourceToken + - State + - Tracks + type: object + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/tt_SourceReference' + - description: Identifies the data source of the recording job. + xml: + name: SourceToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Tracks: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobStateTracks' + - description: List of track items. + xml: + name: Tracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateSource + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTracks: + title: tt_RecordingJobStateTracks + type: object + properties: + Track: + type: array + items: + $ref: '#/components/schemas/tt_RecordingJobStateTrack' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTracks + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_RecordingJobStateTrack: + title: tt_RecordingJobStateTrack + required: + - SourceTag + - Destination + - State + type: object + properties: + SourceTag: + type: string + description: Identifies the track of the data source that provides the data. + xml: + name: SourceTag + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Destination: + maxLength: 64 + type: string + description: Indicates the destination track. + xml: + name: Destination + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Error: + type: string + description: >- + Optionally holds an implementation defined string value that describes the error. + The string should be in the English language. + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + description: >- + Provides the job state of the track. The valid + values of state shall be “Idle”, “Active” and “Error”. If state equals “Error”, the Error field may be filled in with an implementation defined value. + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: RecordingJobStateTrack + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_GetRecordingJobsResponseItem: + title: tt_GetRecordingJobsResponseItem + required: + - JobToken + - JobConfiguration + type: object + properties: + JobToken: + maxLength: 64 + type: string + xml: + name: JobToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + JobConfiguration: + allOf: + - $ref: '#/components/schemas/tt_RecordingJobConfiguration' + - xml: + name: JobConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: GetRecordingJobsResponseItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ReplayConfiguration: + title: tt_ReplayConfiguration + required: + - SessionTimeout + type: object + properties: + SessionTimeout: + type: string + description: The RTSP session timeout. + format: date-time + xml: + name: SessionTimeout + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Configuration parameters for the replay service. + xml: + name: ReplayConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngine: + title: tt_AnalyticsEngine + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - AnalyticsEngineConfiguration + type: object + properties: + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfiguration' + - xml: + name: AnalyticsEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngine + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_AnalyticsDeviceEngineConfiguration: + title: tt_AnalyticsDeviceEngineConfiguration + required: + - EngineConfiguration + type: object + properties: + EngineConfiguration: + type: array + items: + $ref: '#/components/schemas/tt_EngineConfiguration' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsDeviceEngineConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsDeviceEngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsDeviceEngineConfigurationExtension: + title: tt_AnalyticsDeviceEngineConfigurationExtension + type: object + description: '' + xml: + name: AnalyticsDeviceEngineConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_EngineConfiguration: + title: tt_EngineConfiguration + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + type: object + properties: + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/tt_VideoAnalyticsConfiguration' + - xml: + name: VideoAnalyticsConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + AnalyticsEngineInputInfo: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfo' + - xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: EngineConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfo: + title: tt_AnalyticsEngineInputInfo + type: object + properties: + InputInfo: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: InputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsEngineInputInfoExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsEngineInputInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInputInfoExtension: + title: tt_AnalyticsEngineInputInfoExtension + type: object + description: '' + xml: + name: AnalyticsEngineInputInfoExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineInput: + title: tt_AnalyticsEngineInput + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + properties: + SourceIdentification: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentification' + - xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VideoInput: + allOf: + - $ref: '#/components/schemas/tt_VideoEncoderConfiguration' + - xml: + name: VideoInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + MetadataInput: + allOf: + - $ref: '#/components/schemas/tt_MetadataInput' + - xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_SourceIdentification: + title: tt_SourceIdentification + required: + - Name + - Token + type: object + properties: + Name: + type: string + xml: + name: Name + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Token: + type: array + items: + maxLength: 64 + type: string + xml: + name: Token + attribute: false + wrapped: false + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_SourceIdentificationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: SourceIdentification + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SourceIdentificationExtension: + title: tt_SourceIdentificationExtension + type: object + description: '' + xml: + name: SourceIdentificationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInput: + title: tt_MetadataInput + type: object + properties: + MetadataConfig: + type: array + items: + $ref: '#/components/schemas/tt_Config' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_MetadataInputExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: MetadataInput + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MetadataInputExtension: + title: tt_MetadataInputExtension + type: object + description: '' + xml: + name: MetadataInputExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsEngineControl: + title: tt_AnalyticsEngineControl + allOf: + - $ref: '#/components/schemas/tt_ConfigurationEntity' + - required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + properties: + EngineToken: + maxLength: 64 + type: string + description: Token of the analytics engine (AnalyticsEngine) being controlled. + xml: + name: EngineToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + EngineConfigToken: + maxLength: 64 + type: string + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) in effect. + xml: + name: EngineConfigToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + InputToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: InputToken + attribute: false + wrapped: false + description: Tokens of the input (AnalyticsEngineInput) configuration applied. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ReceiverToken: + type: array + items: + maxLength: 64 + type: string + xml: + name: ReceiverToken + attribute: false + wrapped: false + description: Tokens of the receiver providing media input data. The order of ReceiverToken shall exactly match the order of InputToken. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Multicast: + allOf: + - $ref: '#/components/schemas/tt_MulticastConfiguration' + - xml: + name: Multicast + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Subscription: + allOf: + - $ref: '#/components/schemas/tt_Config' + - xml: + name: Subscription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Mode: + allOf: + - $ref: '#/components/schemas/tt_ModeOfOperation' + - xml: + name: Mode + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: AnalyticsEngineControl + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_ModeOfOperation: + title: tt_ModeOfOperation + enum: + - Idle + - Active + - Unknown + type: string + description: '' + xml: + name: ModeOfOperation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsStateInformation: + title: tt_AnalyticsStateInformation + required: + - AnalyticsEngineControlToken + - State + type: object + properties: + AnalyticsEngineControlToken: + maxLength: 64 + type: string + description: Token of the control object whose status is requested. + xml: + name: AnalyticsEngineControlToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + allOf: + - $ref: '#/components/schemas/tt_AnalyticsState' + - xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsStateInformation + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AnalyticsState: + title: tt_AnalyticsState + required: + - State + type: object + properties: + Error: + type: string + xml: + name: Error + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + State: + type: string + xml: + name: State + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AnalyticsState + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayload: + title: tt_ActionEngineEventPayload + type: object + properties: + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + xml: + name: RequestInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + xml: + name: ResponseInfo + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + xml: + name: Fault + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ActionEngineEventPayloadExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Action Engine Event Payload data structure contains the information about the ONVIF command invocations. Since this event could be generated by other or proprietary actions, the command invocation specific fields are defined as optional and additional extension mechanism is provided for future or additional action definitions. + xml: + name: ActionEngineEventPayload + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActionEngineEventPayloadExtension: + title: tt_ActionEngineEventPayloadExtension + type: object + description: '' + xml: + name: ActionEngineEventPayloadExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassType: + title: tt_AudioClassType + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + type: string + description: >- + AudioClassType acceptable values are; + gun_shot, scream, glass_breaking, tire_screech + xml: + name: AudioClassType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassCandidate: + title: tt_AudioClassCandidate + required: + - Type + - Likelihood + type: object + properties: + Type: + allOf: + - $ref: '#/components/schemas/tt_AudioClassType' + - description: Indicates audio class label + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Likelihood: + type: number + description: A likelihood/probability that the corresponding audio event belongs to this class. The sum of the likelihoods shall NOT exceed 1 + xml: + name: Likelihood + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassCandidate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptor: + title: tt_AudioClassDescriptor + type: object + properties: + ClassCandidate: + type: array + items: + $ref: '#/components/schemas/tt_AudioClassCandidate' + description: Array of audio class label and class probability + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_AudioClassDescriptorExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: AudioClassDescriptor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_AudioClassDescriptorExtension: + title: tt_AudioClassDescriptorExtension + type: object + description: '' + xml: + name: AudioClassDescriptorExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ActiveConnection: + title: tt_ActiveConnection + required: + - CurrentBitrate + - CurrentFps + type: object + properties: + CurrentBitrate: + type: number + xml: + name: CurrentBitrate + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + CurrentFps: + type: number + xml: + name: CurrentFps + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ActiveConnection + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatus: + title: tt_ProfileStatus + type: object + properties: + ActiveConnections: + type: array + items: + $ref: '#/components/schemas/tt_ActiveConnection' + description: '' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ProfileStatusExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ProfileStatus + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ProfileStatusExtension: + title: tt_ProfileStatusExtension + type: object + description: '' + xml: + name: ProfileStatusExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDReference: + title: tt_OSDReference + type: object + description: '' + xml: + name: OSDReference + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDType: + title: tt_OSDType + enum: + - Text + - Image + - Extended + type: string + description: '' + xml: + name: OSDType + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfiguration: + title: tt_OSDPosConfiguration + required: + - Type + type: object + properties: + Type: + type: string + description: 'For OSD position type, following are the pre-defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Pos: + allOf: + - $ref: '#/components/schemas/tt_Vector' + - xml: + name: Pos + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDPosConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDPosConfigurationExtension: + title: tt_OSDPosConfigurationExtension + type: object + description: '' + xml: + name: OSDPosConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColor: + title: tt_OSDColor + required: + - Color + type: object + properties: + Transparent: + type: integer + format: int32 + xml: + name: Transparent + prefix: tt + attribute: true + wrapped: false + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: 'The value range of "Transparent" could be defined by vendors only should follow this rule: the minimum value means non-transparent and the maximum value maens fully transparent.' + xml: + name: OSDColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfiguration: + title: tt_OSDTextConfiguration + required: + - Type + type: object + properties: + IsPersistentText: + type: 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. + xml: + name: IsPersistentText + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: 'The following OSD Text Type are defined:' + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: string + 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:' + xml: + name: DateFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: string + 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:' + xml: + name: TimeFormat + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSize: + type: integer + description: Font size of the text in pt. + format: int32 + xml: + name: FontSize + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Font color of the text. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColor' + - description: Background color of the text. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PlainText: + type: string + description: The content of text to be displayed. + xml: + name: PlainText + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextConfigurationExtension: + title: tt_OSDTextConfigurationExtension + type: object + description: '' + xml: + name: OSDTextConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfiguration: + title: tt_OSDImgConfiguration + required: + - ImgPath + type: object + properties: + ImgPath: + type: string + description: The URI of the image which to be displayed. + xml: + name: ImgPath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgConfigurationExtension: + title: tt_OSDImgConfigurationExtension + type: object + description: '' + xml: + name: OSDImgConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorspaceRange: + title: tt_ColorspaceRange + required: + - X + - Y + - Z + - Colorspace + type: object + properties: + X: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: X + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Y: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Y + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Z: + allOf: + - $ref: '#/components/schemas/tt_FloatRange' + - xml: + name: Z + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Colorspace: + type: string + description: Acceptable values are the same as in tt:Color. + xml: + name: Colorspace + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorspaceRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptions: + title: tt_ColorOptions + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the colors supported. Either list each color or define the range of color values. + xml: + name: ColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptions: + title: tt_OSDColorOptions + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_ColorOptions' + - description: Optional list of supported colors. + xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Transparent: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + xml: + name: Transparent + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: Describe the option of the color and its transparency. + xml: + name: OSDColorOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDColorOptionsExtension: + title: tt_OSDColorOptionsExtension + type: object + description: '' + xml: + name: OSDColorOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptions: + title: tt_OSDTextOptions + required: + - Type + type: object + properties: + Type: + type: array + items: + type: string + xml: + name: Type + attribute: false + wrapped: 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontSizeRange: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: Range of the font size value. + xml: + name: FontSizeRange + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + DateFormat: + type: array + items: + type: string + xml: + name: DateFormat + attribute: false + wrapped: false + description: List of supported date format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TimeFormat: + type: array + items: + type: string + xml: + name: TimeFormat + attribute: false + wrapped: false + description: List of supported time format. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + FontColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported font color. + xml: + name: FontColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + BackgroundColor: + allOf: + - $ref: '#/components/schemas/tt_OSDColorOptions' + - description: List of supported background color. + xml: + name: BackgroundColor + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDTextOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDTextOptionsExtension: + title: tt_OSDTextOptionsExtension + type: object + description: '' + xml: + name: OSDTextOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptions: + title: tt_OSDImgOptions + required: + - ImagePath + type: object + properties: + FormatsSupported: + type: string + description: List of supported image MIME types, such as "image/png". + xml: + name: FormatsSupported + prefix: tt + attribute: true + wrapped: false + MaxSize: + type: integer + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + xml: + name: MaxSize + prefix: tt + attribute: true + wrapped: false + MaxWidth: + type: integer + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxWidth + prefix: tt + attribute: true + wrapped: false + MaxHeight: + type: integer + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + xml: + name: MaxHeight + prefix: tt + attribute: true + wrapped: false + ImagePath: + type: array + items: + type: string + xml: + name: ImagePath + attribute: false + wrapped: false + description: List of available image URIs. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDImgOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDImgOptionsExtension: + title: tt_OSDImgOptionsExtension + type: object + description: '' + xml: + name: OSDImgOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfiguration: + title: tt_OSDConfiguration + allOf: + - $ref: '#/components/schemas/tt_DeviceEntity' + - required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + properties: + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/tt_OSDReference' + - description: Reference to the video source configuration. + xml: + name: VideoSourceConfigurationToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + allOf: + - $ref: '#/components/schemas/tt_OSDType' + - description: Type of OSD. + xml: + name: Type + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Position: + allOf: + - $ref: '#/components/schemas/tt_OSDPosConfiguration' + - description: Position configuration of OSD. + xml: + name: Position + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextString: + allOf: + - $ref: '#/components/schemas/tt_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the value of Type field is Text. + xml: + name: TextString + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Image: + allOf: + - $ref: '#/components/schemas/tt_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the value of Type field is Image + xml: + name: Image + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: OSDConfiguration + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + tt_OSDConfigurationExtension: + title: tt_OSDConfigurationExtension + type: object + description: '' + xml: + name: OSDConfigurationExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_MaximumNumberOfOSDs: + title: tt_MaximumNumberOfOSDs + required: + - Total + type: object + properties: + Total: + type: integer + format: int32 + xml: + name: Total + prefix: tt + attribute: true + wrapped: false + Image: + type: integer + format: int32 + xml: + name: Image + prefix: tt + attribute: true + wrapped: false + PlainText: + type: integer + format: int32 + xml: + name: PlainText + prefix: tt + attribute: true + wrapped: false + Date: + type: integer + format: int32 + xml: + name: Date + prefix: tt + attribute: true + wrapped: false + Time: + type: integer + format: int32 + xml: + name: Time + prefix: tt + attribute: true + wrapped: false + DateAndTime: + type: integer + format: int32 + xml: + name: DateAndTime + prefix: tt + attribute: true + wrapped: false + description: '' + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptions: + title: tt_OSDConfigurationOptions + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + type: object + properties: + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/tt_MaximumNumberOfOSDs' + - 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. + xml: + name: MaximumNumberOfOSDs + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Type: + type: array + items: + $ref: '#/components/schemas/tt_OSDType' + 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. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + PositionOption: + type: array + items: + type: string + xml: + name: PositionOption + attribute: false + wrapped: false + description: 'List available OSD position type. Following are the pre-defined:' + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + TextOption: + allOf: + - $ref: '#/components/schemas/tt_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall be returned if the device is signaling the support for Text. + xml: + name: TextOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ImageOption: + allOf: + - $ref: '#/components/schemas/tt_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall be returned if the device is signaling the support for Image. + xml: + name: ImageOption + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_OSDConfigurationOptionsExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: OSDConfigurationOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_OSDConfigurationOptionsExtension: + title: tt_OSDConfigurationOptionsExtension + type: object + description: '' + xml: + name: OSDConfigurationOptionsExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_FileProgress: + title: tt_FileProgress + required: + - FileName + - Progress + type: object + properties: + FileName: + type: string + description: Exported file name + xml: + name: FileName + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Progress: + type: number + description: Normalized percentage completion for uploading the exported file + xml: + name: Progress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: FileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgress: + title: tt_ArrayOfFileProgress + type: object + properties: + FileProgress: + type: array + items: + $ref: '#/components/schemas/tt_FileProgress' + description: Exported file name and export progress information + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_ArrayOfFileProgressExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ArrayOfFileProgress + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ArrayOfFileProgressExtension: + title: tt_ArrayOfFileProgressExtension + type: object + description: '' + xml: + name: ArrayOfFileProgressExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePath: + title: tt_StorageReferencePath + required: + - StorageToken + type: object + properties: + StorageToken: + maxLength: 64 + type: string + description: identifier of an existing Storage Configuration. + xml: + name: StorageToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + RelativePath: + type: string + description: gives the relative directory path on the storage + xml: + name: RelativePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Extension: + allOf: + - $ref: '#/components/schemas/tt_StorageReferencePathExtension' + - xml: + name: Extension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: StorageReferencePath + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_StorageReferencePathExtension: + title: tt_StorageReferencePathExtension + type: object + description: '' + xml: + name: StorageReferencePathExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_PolygonOptions: + title: tt_PolygonOptions + type: object + properties: + RectangleOnly: + type: boolean + description: >- + True if the device supports defining a region only using Rectangle. + + The rectangle points are still passed using a Polygon element if the device does not support polygon regions. In this case, the points provided in the Polygon element shall represent a rectangle. + xml: + name: RectangleOnly + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + VertexLimits: + allOf: + - $ref: '#/components/schemas/tt_IntRange' + - description: >- + Provides the minimum and maximum number of points that can be defined in the Polygon. + + If RectangleOnly is not set to true, this parameter is required. + xml: + name: VertexLimits + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: PolygonOptions + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xmime_base64Binary: + title: xmime_base64Binary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: base64Binary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + xmime_hexBinary: + title: xmime_hexBinary + type: object + properties: + contentType: + minLength: 3 + type: string + xml: + name: contentType + prefix: xmime + attribute: true + wrapped: false + description: '' + xml: + name: hexBinary + namespace: http://www.w3.org/2005/05/xmlmime + prefix: xmime + attribute: false + wrapped: false + soapenv_Envelope: + title: soapenv_Envelope + required: + - Body + type: object + properties: + Header: + allOf: + - $ref: '#/components/schemas/soapenv_Header' + - xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Body: + allOf: + - $ref: '#/components/schemas/soapenv_Body' + - xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: Envelope + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Header: + title: soapenv_Header + type: object + description: Elements replacing the wildcard MUST be namespace qualified, but can be in the targetNamespace + xml: + name: Header + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Body: + title: soapenv_Body + type: object + description: '' + xml: + name: Body + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_Fault: + title: soapenv_Fault + required: + - Code + - Reason + type: object + properties: + Code: + allOf: + - $ref: '#/components/schemas/soapenv_faultcode' + - xml: + name: Code + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Reason: + allOf: + - $ref: '#/components/schemas/soapenv_faultreason' + - xml: + name: Reason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Node: + type: string + xml: + name: Node + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Role: + type: string + xml: + name: Role + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Detail: + allOf: + - $ref: '#/components/schemas/soapenv_detail' + - xml: + name: Detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: Fault reporting structure + xml: + name: Fault + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultreason: + title: soapenv_faultreason + required: + - Text + type: object + properties: + Text: + type: array + items: + $ref: '#/components/schemas/soapenv_reasontext' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultreason + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_reasontext: + title: soapenv_reasontext + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: reasontext + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcode: + title: soapenv_faultcode + required: + - Value + type: object + properties: + Value: + allOf: + - $ref: '#/components/schemas/soapenv_faultcodeEnum' + - xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: faultcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_faultcodeEnum: + title: soapenv_faultcodeEnum + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + type: string + description: '' + xml: + name: faultcodeEnum + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_subcode: + title: soapenv_subcode + required: + - Value + type: object + properties: + Value: + type: string + xml: + name: Value + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + Subcode: + allOf: + - $ref: '#/components/schemas/soapenv_subcode' + - xml: + name: Subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: subcode + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_detail: + title: soapenv_detail + type: object + description: '' + xml: + name: detail + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_NotUnderstoodType: + title: soapenv_NotUnderstoodType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: NotUnderstoodType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_SupportedEnvType: + title: soapenv_SupportedEnvType + required: + - qname + type: object + properties: + qname: + type: string + xml: + name: qname + prefix: soapenv + attribute: true + wrapped: false + description: '' + xml: + name: SupportedEnvType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + soapenv_UpgradeType: + title: soapenv_UpgradeType + required: + - SupportedEnvelope + type: object + properties: + SupportedEnvelope: + type: array + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + description: '' + xml: + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + description: '' + xml: + name: UpgradeType + namespace: http://www.w3.org/2003/05/soap-envelope + prefix: soapenv + attribute: false + wrapped: false + wsnt_QueryExpressionType: + title: wsnt_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_TopicExpressionType: + title: wsnt_TopicExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: TopicExpressionType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_FilterType: + title: wsnt_FilterType + type: object + description: '' + xml: + name: FilterType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicyType: + title: wsnt_SubscriptionPolicyType + type: object + description: '' + xml: + name: SubscriptionPolicyType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationProducerRP: + title: wsnt_NotificationProducerRP + type: object + properties: + TopicExpression: + type: array + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + FixedTopicSet: + type: boolean + default: true + xml: + name: FixedTopicSet + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicExpressionDialect: + type: array + items: + type: string + xml: + name: TopicExpressionDialect + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - xml: + name: TopicSet + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: NotificationProducerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsa_EndpointReferenceType: + title: wsa_EndpointReferenceType + required: + - Address + type: object + properties: + Address: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Address + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + ReferenceParameters: + allOf: + - $ref: '#/components/schemas/wsa_ReferenceParametersType' + - xml: + name: ReferenceParameters + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + Metadata: + allOf: + - $ref: '#/components/schemas/wsa_MetadataType' + - xml: + name: Metadata + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: EndpointReferenceType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsnt_SubscriptionManagerRP: + title: wsnt_SubscriptionManagerRP + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CreationTime: + type: string + format: date-time + xml: + name: CreationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscriptionManagerRP + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_NotificationMessageHolderType: + title: wsnt_NotificationMessageHolderType + required: + - Message + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + ProducerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ProducerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Message: + allOf: + - $ref: '#/components/schemas/wsnt_Message' + - xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: NotificationMessageHolderType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Notify: + title: wsnt_Notify + required: + - NotificationMessage + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Notify + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UseRaw: + title: wsnt_UseRaw + type: object + description: '' + xml: + name: UseRaw + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_Subscribe: + title: wsnt_Subscribe + required: + - ConsumerReference + type: object + properties: + ConsumerReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: ConsumerReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - xml: + name: Filter + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: InitialTerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + - xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Subscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeResponse: + title: wsnt_SubscribeResponse + required: + - SubscriptionReference + type: object + properties: + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: SubscriptionReference + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: SubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessage: + title: wsnt_GetCurrentMessage + required: + - Topic + type: object + properties: + Topic: + allOf: + - $ref: '#/components/schemas/wsnt_TopicExpressionType' + - xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetCurrentMessage + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetCurrentMessageResponse: + title: wsnt_GetCurrentMessageResponse + type: object + description: '' + xml: + name: GetCurrentMessageResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscribeCreationFailedFaultType: + title: wsnt_SubscribeCreationFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: SubscribeCreationFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidFilterFaultType: + title: wsnt_InvalidFilterFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - UnknownFilter + type: object + properties: + UnknownFilter: + type: array + items: + type: string + xml: + name: UnknownFilter + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: InvalidFilterFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicExpressionDialectUnknownFaultType: + title: wsnt_TopicExpressionDialectUnknownFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicExpressionDialectUnknownFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidTopicExpressionFaultType: + title: wsnt_InvalidTopicExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidTopicExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_TopicNotSupportedFaultType: + title: wsnt_TopicNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: TopicNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_MultipleTopicsSpecifiedFaultType: + title: wsnt_MultipleTopicsSpecifiedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: MultipleTopicsSpecifiedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidProducerPropertiesExpressionFaultType: + title: wsnt_InvalidProducerPropertiesExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidProducerPropertiesExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_InvalidMessageContentExpressionFaultType: + title: wsnt_InvalidMessageContentExpressionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: InvalidMessageContentExpressionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnrecognizedPolicyRequestFaultType: + title: wsnt_UnrecognizedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnrecognizedPolicy: + type: array + items: + type: string + xml: + name: UnrecognizedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnrecognizedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnsupportedPolicyRequestFaultType: + title: wsnt_UnsupportedPolicyRequestFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + properties: + UnsupportedPolicy: + type: array + items: + type: string + xml: + name: UnsupportedPolicy + attribute: false + wrapped: false + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnsupportedPolicyRequestFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NotifyMessageNotSupportedFaultType: + title: wsnt_NotifyMessageNotSupportedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NotifyMessageNotSupportedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnacceptableInitialTerminationTimeFaultType: + title: wsnt_UnacceptableInitialTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableInitialTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_NoCurrentMessageOnTopicFaultType: + title: wsnt_NoCurrentMessageOnTopicFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: NoCurrentMessageOnTopicFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_GetMessages: + title: wsnt_GetMessages + type: object + properties: + MaximumNumber: + type: integer + format: int32 + xml: + name: MaximumNumber + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessages + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_GetMessagesResponse: + title: wsnt_GetMessagesResponse + type: object + properties: + NotificationMessage: + type: array + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: GetMessagesResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPoint: + title: wsnt_DestroyPullPoint + type: object + description: '' + xml: + name: DestroyPullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_DestroyPullPointResponse: + title: wsnt_DestroyPullPointResponse + type: object + description: '' + xml: + name: DestroyPullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToGetMessagesFaultType: + title: wsnt_UnableToGetMessagesFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToGetMessagesFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_UnableToDestroyPullPointFaultType: + title: wsnt_UnableToDestroyPullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroyPullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_CreatePullPoint: + title: wsnt_CreatePullPoint + type: object + description: '' + xml: + name: CreatePullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_CreatePullPointResponse: + title: wsnt_CreatePullPointResponse + required: + - PullPoint + type: object + properties: + PullPoint: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: PullPoint + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: CreatePullPointResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToCreatePullPointFaultType: + title: wsnt_UnableToCreatePullPointFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToCreatePullPointFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Renew: + title: wsnt_Renew + required: + - TerminationTime + type: object + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + - xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: Renew + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_RenewResponse: + title: wsnt_RenewResponse + required: + - TerminationTime + type: object + properties: + TerminationTime: + type: string + format: date-time + xml: + name: TerminationTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + CurrentTime: + type: string + format: date-time + xml: + name: CurrentTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xml: + name: RenewResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnacceptableTerminationTimeFaultType: + title: wsnt_UnacceptableTerminationTimeFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - required: + - MinimumTime + type: object + properties: + MinimumTime: + type: string + format: date-time + xml: + name: MinimumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + MaximumTime: + type: string + format: date-time + xml: + name: MaximumTime + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + xml: + name: UnacceptableTerminationTimeFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_Unsubscribe: + title: wsnt_Unsubscribe + type: object + description: '' + xml: + name: Unsubscribe + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnsubscribeResponse: + title: wsnt_UnsubscribeResponse + type: object + description: '' + xml: + name: UnsubscribeResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_UnableToDestroySubscriptionFaultType: + title: wsnt_UnableToDestroySubscriptionFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: UnableToDestroySubscriptionFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_PauseSubscription: + title: wsnt_PauseSubscription + type: object + description: '' + xml: + name: PauseSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseSubscriptionResponse: + title: wsnt_PauseSubscriptionResponse + type: object + description: '' + xml: + name: PauseSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscription: + title: wsnt_ResumeSubscription + type: object + description: '' + xml: + name: ResumeSubscription + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_ResumeSubscriptionResponse: + title: wsnt_ResumeSubscriptionResponse + type: object + description: '' + xml: + name: ResumeSubscriptionResponse + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_PauseFailedFaultType: + title: wsnt_PauseFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: PauseFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + wsnt_ResumeFailedFaultType: + title: wsnt_ResumeFailedFaultType + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + xml: + name: ResumeFailedFaultType + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + description: '' + xop_Include: + title: xop_Include + required: + - href + type: object + properties: + href: + type: string + xml: + name: href + prefix: xop + attribute: true + wrapped: false + description: '' + xml: + name: Include + namespace: http://www.w3.org/2004/08/xop/include + prefix: xop + attribute: false + wrapped: false + wsa_ReferenceParametersType: + title: wsa_ReferenceParametersType + type: object + description: '' + xml: + name: ReferenceParametersType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_MetadataType: + title: wsa_MetadataType + type: object + description: '' + xml: + name: MetadataType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedURIType: + title: wsa_AttributedURIType + type: object + description: '' + xml: + name: AttributedURIType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelatesToType: + title: wsa_RelatesToType + type: object + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + xml: + name: RelationshipType + attribute: true + wrapped: false + description: '' + xml: + name: RelatesToType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_RelationshipTypeOpenEnum: + title: wsa_RelationshipTypeOpenEnum + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + description: '' + xml: + name: RelationshipType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_FaultCodesOpenEnumType: + title: wsa_FaultCodesOpenEnumType + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + description: '' + xml: + name: FaultCodesType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedQNameType: + title: wsa_AttributedQNameType + type: object + description: '' + xml: + name: AttributedQNameType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_AttributedAnyType: + title: wsa_AttributedAnyType + type: object + description: '' + xml: + name: AttributedAnyType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsa_ProblemActionType: + title: wsa_ProblemActionType + type: object + properties: + Action: + allOf: + - $ref: '#/components/schemas/wsa_AttributedURIType' + - xml: + name: Action + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + SoapAction: + type: string + xml: + name: SoapAction + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + description: '' + xml: + name: ProblemActionType + namespace: http://www.w3.org/2005/08/addressing + prefix: wsa + attribute: false + wrapped: false + wsrf-bf_BaseFaultType: + title: wsrf-bf_BaseFaultType + required: + - Timestamp + type: object + properties: + Timestamp: + type: string + format: date-time + xml: + name: Timestamp + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Originator: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - xml: + name: Originator + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + ErrorCode: + allOf: + - $ref: '#/components/schemas/wsrf-bf_ErrorCode' + - xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + Description: + type: array + items: + $ref: '#/components/schemas/wsrf-bf_Description' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + FaultCause: + allOf: + - $ref: '#/components/schemas/wsrf-bf_FaultCause' + - xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + description: '' + xml: + name: BaseFaultType + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Documentation: + title: wstop_Documentation + type: object + description: '' + xml: + name: Documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_ExtensibleDocumented: + title: wstop_ExtensibleDocumented + type: object + properties: + documentation: + allOf: + - $ref: '#/components/schemas/wstop_Documentation' + - xml: + name: documentation + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + xml: + name: ExtensibleDocumented + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_QueryExpressionType: + title: wstop_QueryExpressionType + required: + - Dialect + type: object + properties: + Dialect: + type: string + xml: + name: Dialect + attribute: true + wrapped: false + description: '' + xml: + name: QueryExpressionType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + wstop_TopicNamespaceType: + title: wstop_TopicNamespaceType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - targetNamespace + type: object + properties: + Topic: + type: array + items: + $ref: '#/components/schemas/wstop_Topic' + description: '' + xml: + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + name: + type: string + xml: + name: name + attribute: true + wrapped: false + targetNamespace: + type: string + xml: + name: targetNamespace + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + name: final + attribute: true + wrapped: false + xml: + name: TopicNamespaceType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicType: + title: wstop_TopicType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - required: + - name + type: object + properties: + MessagePattern: + allOf: + - $ref: '#/components/schemas/wstop_QueryExpressionType' + - {} + Topic: + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - {} + name: + type: string + xml: + attribute: true + wrapped: false + messageTypes: + type: array + items: + type: string + description: '' + xml: + attribute: true + wrapped: false + final: + type: boolean + default: false + xml: + attribute: true + wrapped: false + xml: + name: TopicType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wstop_TopicSetType: + title: wstop_TopicSetType + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xml: + name: TopicSetType + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + AbsoluteMoveRequest: + title: AbsoluteMoveRequest + required: + - AbsoluteMove + type: object + properties: + AbsoluteMove: + allOf: + - $ref: '#/components/schemas/tns_AbsoluteMove' + - {} + AbsoluteMoveResponse: + title: AbsoluteMoveResponse + required: + - AbsoluteMoveResponse + type: object + properties: + AbsoluteMoveResponse: + allOf: + - $ref: '#/components/schemas/tns_AbsoluteMoveResponse' + - xml: + name: AbsoluteMoveResponse + attribute: false + wrapped: false + xml: + name: AbsoluteMoveResponse + attribute: false + wrapped: false + Choice0: + title: Choice0 + type: object + properties: + PresetToken: + maxLength: 64 + type: string + description: Option to specify the preset position with Preset Token defined in advance. + xml: + name: PresetToken + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice1: + title: Choice1 + type: object + properties: + Home: + type: boolean + 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. + xml: + name: Home + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice2: + title: Choice2 + type: object + properties: + PTZPosition: + allOf: + - $ref: '#/components/schemas/tt_PTZVector' + - description: Option to specify the preset position with vector of PTZ node directly. + xml: + name: PTZPosition + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Choice3: + title: Choice3 + type: object + properties: + TypeExtension: + allOf: + - $ref: '#/components/schemas/tt_PTZPresetTourTypeExtension' + - xml: + name: TypeExtension + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + ContinuousMoveRequest: + title: ContinuousMoveRequest + required: + - ContinuousMove + type: object + properties: + ContinuousMove: + allOf: + - $ref: '#/components/schemas/tns_ContinuousMove' + - {} + ContinuousMoveResponse: + title: ContinuousMoveResponse + required: + - ContinuousMoveResponse + type: object + properties: + ContinuousMoveResponse: + allOf: + - $ref: '#/components/schemas/tns_ContinuousMoveResponse' + - xml: + name: ContinuousMoveResponse + attribute: false + wrapped: false + xml: + name: ContinuousMoveResponse + attribute: false + wrapped: false + CreatePresetTourRequest: + title: CreatePresetTourRequest + required: + - CreatePresetTour + type: object + properties: + CreatePresetTour: + allOf: + - $ref: '#/components/schemas/tns_CreatePresetTour' + - {} + CreatePresetTourResponse: + title: CreatePresetTourResponse + required: + - CreatePresetTourResponse + type: object + properties: + CreatePresetTourResponse: + allOf: + - $ref: '#/components/schemas/tns_CreatePresetTourResponse' + - xml: + name: CreatePresetTourResponse + attribute: false + wrapped: false + xml: + name: CreatePresetTourResponse + attribute: false + wrapped: false + GeoMoveRequest: + title: GeoMoveRequest + required: + - GeoMove + type: object + properties: + GeoMove: + allOf: + - $ref: '#/components/schemas/tns_GeoMove' + - {} + GeoMoveResponse: + title: GeoMoveResponse + required: + - GeoMoveResponse + type: object + properties: + GeoMoveResponse: + allOf: + - $ref: '#/components/schemas/tns_GeoMoveResponse' + - xml: + name: GeoMoveResponse + attribute: false + wrapped: false + xml: + name: GeoMoveResponse + attribute: false + wrapped: false + GetCompatibleConfigurationsRequest: + title: GetCompatibleConfigurationsRequest + required: + - GetCompatibleConfigurations + type: object + properties: + GetCompatibleConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleConfigurations' + - {} + GetCompatibleConfigurationsResponse: + title: GetCompatibleConfigurationsResponse + required: + - GetCompatibleConfigurationsResponse + type: object + properties: + GetCompatibleConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetCompatibleConfigurationsResponse' + - xml: + name: GetCompatibleConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetCompatibleConfigurationsResponse + attribute: false + wrapped: false + GetConfigurationOptionsRequest: + title: GetConfigurationOptionsRequest + required: + - GetConfigurationOptions + type: object + properties: + GetConfigurationOptions: + allOf: + - $ref: '#/components/schemas/tns_GetConfigurationOptions' + - {} + GetConfigurationOptionsResponse: + title: GetConfigurationOptionsResponse + required: + - GetConfigurationOptionsResponse + type: object + properties: + GetConfigurationOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetConfigurationOptionsResponse' + - xml: + name: GetConfigurationOptionsResponse + attribute: false + wrapped: false + xml: + name: GetConfigurationOptionsResponse + attribute: false + wrapped: false + GetConfigurationRequest: + title: GetConfigurationRequest + required: + - GetConfiguration + type: object + properties: + GetConfiguration: + allOf: + - $ref: '#/components/schemas/tns_GetConfiguration' + - {} + GetConfigurationResponse: + title: GetConfigurationResponse + required: + - GetConfigurationResponse + type: object + properties: + GetConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_GetConfigurationResponse' + - xml: + name: GetConfigurationResponse + attribute: false + wrapped: false + xml: + name: GetConfigurationResponse + attribute: false + wrapped: false + GetConfigurationsRequest: + title: GetConfigurationsRequest + required: + - GetConfigurations + type: object + properties: + GetConfigurations: + allOf: + - $ref: '#/components/schemas/tns_GetConfigurations' + - {} + GetConfigurationsResponse: + title: GetConfigurationsResponse + required: + - GetConfigurationsResponse + type: object + properties: + GetConfigurationsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetConfigurationsResponse' + - xml: + name: GetConfigurationsResponse + attribute: false + wrapped: false + xml: + name: GetConfigurationsResponse + attribute: false + wrapped: false + GetNodeRequest: + title: GetNodeRequest + required: + - GetNode + type: object + properties: + GetNode: + allOf: + - $ref: '#/components/schemas/tns_GetNode' + - {} + GetNodeResponse: + title: GetNodeResponse + required: + - GetNodeResponse + type: object + properties: + GetNodeResponse: + allOf: + - $ref: '#/components/schemas/tns_GetNodeResponse' + - xml: + name: GetNodeResponse + attribute: false + wrapped: false + xml: + name: GetNodeResponse + attribute: false + wrapped: false + GetNodesRequest: + title: GetNodesRequest + required: + - GetNodes + type: object + properties: + GetNodes: + allOf: + - $ref: '#/components/schemas/tns_GetNodes' + - {} + GetNodesResponse: + title: GetNodesResponse + required: + - GetNodesResponse + type: object + properties: + GetNodesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetNodesResponse' + - xml: + name: GetNodesResponse + attribute: false + wrapped: false + xml: + name: GetNodesResponse + attribute: false + wrapped: false + GetPresetsRequest: + title: GetPresetsRequest + required: + - GetPresets + type: object + properties: + GetPresets: + allOf: + - $ref: '#/components/schemas/tns_GetPresets' + - {} + GetPresetsResponse: + title: GetPresetsResponse + required: + - GetPresetsResponse + type: object + properties: + GetPresetsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPresetsResponse' + - xml: + name: GetPresetsResponse + attribute: false + wrapped: false + xml: + name: GetPresetsResponse + attribute: false + wrapped: false + GetPresetTourOptionsRequest: + title: GetPresetTourOptionsRequest + required: + - GetPresetTourOptions + type: object + properties: + GetPresetTourOptions: + allOf: + - $ref: '#/components/schemas/tns_GetPresetTourOptions' + - {} + GetPresetTourOptionsResponse: + title: GetPresetTourOptionsResponse + required: + - GetPresetTourOptionsResponse + type: object + properties: + GetPresetTourOptionsResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPresetTourOptionsResponse' + - xml: + name: GetPresetTourOptionsResponse + attribute: false + wrapped: false + xml: + name: GetPresetTourOptionsResponse + attribute: false + wrapped: false + GetPresetTourRequest: + title: GetPresetTourRequest + required: + - GetPresetTour + type: object + properties: + GetPresetTour: + allOf: + - $ref: '#/components/schemas/tns_GetPresetTour' + - {} + GetPresetTourResponse: + title: GetPresetTourResponse + required: + - GetPresetTourResponse + type: object + properties: + GetPresetTourResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPresetTourResponse' + - xml: + name: GetPresetTourResponse + attribute: false + wrapped: false + xml: + name: GetPresetTourResponse + attribute: false + wrapped: false + GetPresetToursRequest: + title: GetPresetToursRequest + required: + - GetPresetTours + type: object + properties: + GetPresetTours: + allOf: + - $ref: '#/components/schemas/tns_GetPresetTours' + - {} + GetPresetToursResponse: + title: GetPresetToursResponse + required: + - GetPresetToursResponse + type: object + properties: + GetPresetToursResponse: + allOf: + - $ref: '#/components/schemas/tns_GetPresetToursResponse' + - xml: + name: GetPresetToursResponse + attribute: false + wrapped: false + xml: + name: GetPresetToursResponse + attribute: false + wrapped: false + GetServiceCapabilitiesRequest: + title: GetServiceCapabilitiesRequest + required: + - GetServiceCapabilities + type: object + properties: + GetServiceCapabilities: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilities' + - {} + GetServiceCapabilitiesResponse: + title: GetServiceCapabilitiesResponse + required: + - GetServiceCapabilitiesResponse + type: object + properties: + GetServiceCapabilitiesResponse: + allOf: + - $ref: '#/components/schemas/tns_GetServiceCapabilitiesResponse' + - xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + xml: + name: GetServiceCapabilitiesResponse + attribute: false + wrapped: false + GetStatusRequest: + title: GetStatusRequest + required: + - GetStatus + type: object + properties: + GetStatus: + allOf: + - $ref: '#/components/schemas/tns_GetStatus' + - {} + GetStatusResponse: + title: GetStatusResponse + required: + - GetStatusResponse + type: object + properties: + GetStatusResponse: + allOf: + - $ref: '#/components/schemas/tns_GetStatusResponse' + - xml: + name: GetStatusResponse + attribute: false + wrapped: false + xml: + name: GetStatusResponse + attribute: false + wrapped: false + GotoHomePositionRequest: + title: GotoHomePositionRequest + required: + - GotoHomePosition + type: object + properties: + GotoHomePosition: + allOf: + - $ref: '#/components/schemas/tns_GotoHomePosition' + - {} + GotoHomePositionResponse: + title: GotoHomePositionResponse + required: + - GotoHomePositionResponse + type: object + properties: + GotoHomePositionResponse: + allOf: + - $ref: '#/components/schemas/tns_GotoHomePositionResponse' + - xml: + name: GotoHomePositionResponse + attribute: false + wrapped: false + xml: + name: GotoHomePositionResponse + attribute: false + wrapped: false + GotoPresetRequest: + title: GotoPresetRequest + required: + - GotoPreset + type: object + properties: + GotoPreset: + allOf: + - $ref: '#/components/schemas/tns_GotoPreset' + - {} + GotoPresetResponse: + title: GotoPresetResponse + required: + - GotoPresetResponse + type: object + properties: + GotoPresetResponse: + allOf: + - $ref: '#/components/schemas/tns_GotoPresetResponse' + - xml: + name: GotoPresetResponse + attribute: false + wrapped: false + xml: + name: GotoPresetResponse + attribute: false + wrapped: false + ModifyPresetTourRequest: + title: ModifyPresetTourRequest + required: + - ModifyPresetTour + type: object + properties: + ModifyPresetTour: + allOf: + - $ref: '#/components/schemas/tns_ModifyPresetTour' + - {} + ModifyPresetTourResponse: + title: ModifyPresetTourResponse + required: + - ModifyPresetTourResponse + type: object + properties: + ModifyPresetTourResponse: + allOf: + - $ref: '#/components/schemas/tns_ModifyPresetTourResponse' + - xml: + name: ModifyPresetTourResponse + attribute: false + wrapped: false + xml: + name: ModifyPresetTourResponse + attribute: false + wrapped: false + MoveAndStartTrackingRequest: + title: MoveAndStartTrackingRequest + required: + - MoveAndStartTracking + type: object + properties: + MoveAndStartTracking: + allOf: + - $ref: '#/components/schemas/tns_MoveAndStartTracking' + - {} + MoveAndStartTrackingResponse: + title: MoveAndStartTrackingResponse + required: + - MoveAndStartTrackingResponse + type: object + properties: + MoveAndStartTrackingResponse: + allOf: + - $ref: '#/components/schemas/tns_MoveAndStartTrackingResponse' + - xml: + name: MoveAndStartTrackingResponse + attribute: false + wrapped: false + xml: + name: MoveAndStartTrackingResponse + attribute: false + wrapped: false + OperatePresetTourRequest: + title: OperatePresetTourRequest + required: + - OperatePresetTour + type: object + properties: + OperatePresetTour: + allOf: + - $ref: '#/components/schemas/tns_OperatePresetTour' + - {} + OperatePresetTourResponse: + title: OperatePresetTourResponse + required: + - OperatePresetTourResponse + type: object + properties: + OperatePresetTourResponse: + allOf: + - $ref: '#/components/schemas/tns_OperatePresetTourResponse' + - xml: + name: OperatePresetTourResponse + attribute: false + wrapped: false + xml: + name: OperatePresetTourResponse + attribute: false + wrapped: false + RelativeMoveRequest: + title: RelativeMoveRequest + required: + - RelativeMove + type: object + properties: + RelativeMove: + allOf: + - $ref: '#/components/schemas/tns_RelativeMove' + - {} + RelativeMoveResponse: + title: RelativeMoveResponse + required: + - RelativeMoveResponse + type: object + properties: + RelativeMoveResponse: + allOf: + - $ref: '#/components/schemas/tns_RelativeMoveResponse' + - xml: + name: RelativeMoveResponse + attribute: false + wrapped: false + xml: + name: RelativeMoveResponse + attribute: false + wrapped: false + RemovePresetRequest: + title: RemovePresetRequest + required: + - RemovePreset + type: object + properties: + RemovePreset: + allOf: + - $ref: '#/components/schemas/tns_RemovePreset' + - {} + RemovePresetResponse: + title: RemovePresetResponse + required: + - RemovePresetResponse + type: object + properties: + RemovePresetResponse: + allOf: + - $ref: '#/components/schemas/tns_RemovePresetResponse' + - xml: + name: RemovePresetResponse + attribute: false + wrapped: false + xml: + name: RemovePresetResponse + attribute: false + wrapped: false + RemovePresetTourRequest: + title: RemovePresetTourRequest + required: + - RemovePresetTour + type: object + properties: + RemovePresetTour: + allOf: + - $ref: '#/components/schemas/tns_RemovePresetTour' + - {} + RemovePresetTourResponse: + title: RemovePresetTourResponse + required: + - RemovePresetTourResponse + type: object + properties: + RemovePresetTourResponse: + allOf: + - $ref: '#/components/schemas/tns_RemovePresetTourResponse' + - xml: + name: RemovePresetTourResponse + attribute: false + wrapped: false + xml: + name: RemovePresetTourResponse + attribute: false + wrapped: false + SendAuxiliaryCommandRequest: + title: SendAuxiliaryCommandRequest + required: + - SendAuxiliaryCommand + type: object + properties: + SendAuxiliaryCommand: + allOf: + - $ref: '#/components/schemas/tns_SendAuxiliaryCommand' + - {} + SendAuxiliaryCommandResponse: + title: SendAuxiliaryCommandResponse + required: + - SendAuxiliaryCommandResponse + type: object + properties: + SendAuxiliaryCommandResponse: + allOf: + - $ref: '#/components/schemas/tns_SendAuxiliaryCommandResponse' + - xml: + name: SendAuxiliaryCommandResponse + attribute: false + wrapped: false + xml: + name: SendAuxiliaryCommandResponse + attribute: false + wrapped: false + SetConfigurationRequest: + title: SetConfigurationRequest + required: + - SetConfiguration + type: object + properties: + SetConfiguration: + allOf: + - $ref: '#/components/schemas/tns_SetConfiguration' + - {} + SetConfigurationResponse: + title: SetConfigurationResponse + required: + - SetConfigurationResponse + type: object + properties: + SetConfigurationResponse: + allOf: + - $ref: '#/components/schemas/tns_SetConfigurationResponse' + - xml: + name: SetConfigurationResponse + attribute: false + wrapped: false + xml: + name: SetConfigurationResponse + attribute: false + wrapped: false + SetHomePositionRequest: + title: SetHomePositionRequest + required: + - SetHomePosition + type: object + properties: + SetHomePosition: + allOf: + - $ref: '#/components/schemas/tns_SetHomePosition' + - {} + SetHomePositionResponse: + title: SetHomePositionResponse + required: + - SetHomePositionResponse + type: object + properties: + SetHomePositionResponse: + allOf: + - $ref: '#/components/schemas/tns_SetHomePositionResponse' + - xml: + name: SetHomePositionResponse + attribute: false + wrapped: false + xml: + name: SetHomePositionResponse + attribute: false + wrapped: false + SetPresetRequest: + title: SetPresetRequest + required: + - SetPreset + type: object + properties: + SetPreset: + allOf: + - $ref: '#/components/schemas/tns_SetPreset' + - {} + SetPresetResponse: + title: SetPresetResponse + required: + - SetPresetResponse + type: object + properties: + SetPresetResponse: + allOf: + - $ref: '#/components/schemas/tns_SetPresetResponse' + - xml: + name: SetPresetResponse + attribute: false + wrapped: false + xml: + name: SetPresetResponse + attribute: false + wrapped: false + StopRequest: + title: StopRequest + required: + - Stop + type: object + properties: + Stop: + allOf: + - $ref: '#/components/schemas/tns_Stop' + - {} + StopResponse: + title: StopResponse + required: + - StopResponse + type: object + properties: + StopResponse: + allOf: + - $ref: '#/components/schemas/tns_StopResponse' + - xml: + name: StopResponse + attribute: false + wrapped: false + xml: + name: StopResponse + attribute: false + wrapped: false + tns1_space: + title: tns1_space + enum: + - default + - preserve + type: string + description: '' + xml: + name: space + namespace: http://www.w3.org/XML/1998/namespace + prefix: tns1 + attribute: false + wrapped: false + tt_ColorCluster: + title: tt_ColorCluster + required: + - Color + type: object + properties: + Color: + allOf: + - $ref: '#/components/schemas/tt_Color' + - xml: + name: Color + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Weight: + type: number + xml: + name: Weight + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + Covariance: + allOf: + - $ref: '#/components/schemas/tt_ColorCovariance' + - xml: + name: Covariance + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: '' + xml: + name: ColorCluster + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice0: + title: tt_ColorOptionsChoice0 + type: object + properties: + ColorList: + type: array + items: + $ref: '#/components/schemas/tt_Color' + description: List the supported color. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ColorOptionsChoice1: + title: tt_ColorOptionsChoice1 + type: object + properties: + ColorspaceRange: + type: array + items: + $ref: '#/components/schemas/tt_ColorspaceRange' + description: Define the range of color supported. + xml: + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItem: + title: tt_ElementItem + required: + - Name + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + description: Complex value structure. + xml: + name: ElementItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_ElementItemDescription: + title: tt_ElementItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + description: The type of the item. The Type must reference a defined type. + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a complex type. The Type must reference a defined type. + xml: + name: ElementItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_Messages: + title: tt_Messages + allOf: + - $ref: '#/components/schemas/tt_MessageDescription' + - required: + - ParentTopic + type: object + properties: + ParentTopic: + type: string + description: The topic of the message. For historical reason the element is named ParentTopic, but the full topic is expected. + xml: + name: ParentTopic + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + xml: + name: Messages + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + description: >- + The analytics modules and rule engine produce Events, which must be listed within the Analytics Module Description. In order to do so + the structure of the Message is defined and consists of three groups: Source, Key, and Data. It is recommended to use SimpleItemDescriptions wherever applicable. + The name of all Items must be unique within all Items contained in any group of this Message. + Depending on the component multiple parameters or none may be needed to identify the component uniquely. + tt_SimpleItem: + title: tt_SimpleItem + required: + - Name + - Value + type: object + properties: + Name: + type: string + description: Item name. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Value: + type: string + description: Item value. The type is defined in the corresponding description. + xml: + name: Value + prefix: tt + attribute: true + wrapped: false + description: Value name pair as defined by the corresponding description. + xml: + name: SimpleItem + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SimpleItemDescription: + title: tt_SimpleItemDescription + required: + - Name + - Type + type: object + properties: + Name: + type: string + description: Item name. Must be unique within a list. + xml: + name: Name + prefix: tt + attribute: true + wrapped: false + Type: + type: string + xml: + name: Type + prefix: tt + attribute: true + wrapped: false + description: Description of a simple item. The type must be of cathegory simpleType (xs:string, xs:integer, xs:float, ...). + xml: + name: SimpleItemDescription + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + tt_SubscriptionPolicy: + title: tt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://www.onvif.org/ver10/schema + prefix: tt + attribute: false + wrapped: false + wsnt_Message: + title: wsnt_Message + type: object + description: '' + xml: + name: Message + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsnt_SubscriptionPolicy: + title: wsnt_SubscriptionPolicy + type: object + description: '' + xml: + name: SubscriptionPolicy + namespace: http://docs.oasis-open.org/wsn/b-2 + prefix: wsnt + attribute: false + wrapped: false + wsrf-bf_Description: + title: wsrf-bf_Description + type: object + properties: + lang: + oneOf: + - type: string + - type: string + description: >- + lang (as an attribute name) + denotes an attribute whose value + is a language code for the natural language of the content of + any element; its value is inherited. This name is reserved + by virtue of its definition in the XML specification. + xml: + name: lang + prefix: tns1 + attribute: true + wrapped: false + description: '' + xml: + name: Description + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_ErrorCode: + title: wsrf-bf_ErrorCode + required: + - dialect + type: object + properties: + dialect: + type: string + xml: + name: dialect + attribute: true + wrapped: false + description: '' + xml: + name: ErrorCode + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wsrf-bf_FaultCause: + title: wsrf-bf_FaultCause + type: object + description: '' + xml: + name: FaultCause + namespace: http://docs.oasis-open.org/wsrf/bf-2 + prefix: wsrf-bf + attribute: false + wrapped: false + wstop_Topic: + title: wstop_Topic + allOf: + - $ref: '#/components/schemas/wstop_TopicType' + - type: object + properties: + parent: + pattern: (([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)(/([\i-[:]][\c-[:]]*:)?[\i-[:]][\c-[:]]*)* + type: string + xml: + name: Topic + namespace: http://docs.oasis-open.org/wsn/t-1 + prefix: wstop + attribute: false + wrapped: false + description: '' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object +tags: +- name: PTZBinding + description: '' diff --git a/doc/openapi/sidecar.yaml b/doc/openapi/sidecar.yaml index 458be3be..35cb25fe 100644 --- a/doc/openapi/sidecar.yaml +++ b/doc/openapi/sidecar.yaml @@ -1,3 +1,395 @@ # This file contains additional OpenAPI metadata to be side-loaded into the final OpenAPI document + +# Note: Due to the use of ruamel.yaml, any blank lines or comments below will be copied as-is to the output file +# This may be a good thing, but also causes issues when an item is replicated/duplicated. + --- -todo: +requests: + edgex: + BaseNotificationSubscription: + properties: + InitialTerminationTime: + $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + TopicFilter: + type: string + type: object + PullPointSubscription: + properties: + MessageContentFilter: + type: string + InitialTerminationTime: + $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + MessageTimeout: + $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + type: object + UnsubscribeCameraEvent: + type: object + MACAddress: + type: string + FriendlyName: + type: string + CustomMetadata: + type: object + DeleteCustomMetadata: + type: array + items: + type: string + NetworkConfiguration: + type: object +responses: + onvif: + get: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + edgex: + Snapshot: + $ref: '#/components/schemas/BinaryEventResponse' + RebootNeeded: + $ref: '#/components/schemas/BoolEventResponse' + FriendlyName: + $ref: '#/components/schemas/StringEventResponse' + MACAddress: + $ref: '#/components/schemas/StringEventResponse' + CustomMetadata: + $ref: '#/components/schemas/ObjectEventResponse' + NetworkConfiguration: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + anyOf: + - properties: + objectValue: + canned: + '200': + description: "OK" + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/BaseResponse' + examples: + 200Example: + $ref: '#/components/examples/200Example' + '400': + description: "Request is in an invalid state" + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 400Example: + $ref: '#/components/examples/400Example' + '404': + description: "The requested resource does not exist" + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 404Example: + $ref: '#/components/examples/404Example' + '423': + description: "The device is locked (AdminState)" + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 423Example: + $ref: '#/components/examples/423Example' + '500': + description: "An unexpected error occurred on the server" + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 500Example: + $ref: '#/components/examples/500Example' + '503': + description: "Service Unavailable" + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorResponse' + examples: + 503Example: + $ref: '#/components/examples/503Example' +components: + headers: + correlatedResponseHeader: + description: "A response header that returns the unique correlation ID used to initiate the request." + schema: + type: string + format: uuid + example: "14a42ea6-c394-41c3-8bcd-a29b9f5e6835" + examples: + 200Example: + value: + apiVersion: v2 + statusCode: 200 + 400Example: + value: + apiVersion: "v2" + statusCode: 400 + message: "Bad Request" + 404Example: + value: + apiVersion: "v2" + statusCode: 404 + message: "The requested resource does not exist" + 416Example: + value: + apiVersion: "v2" + statusCode: 416 + message: "Range Not Satisfiable" + 423Example: + value: + apiVersion: "v2" + statusCode: 423 + message: "The device is locked (AdminState)" + 500Example: + value: + apiVersion: "v2" + statusCode: 500 + message: "Internal Server Error" + 503Example: + value: + apiVersion: "v2" + statusCode: 503 + message: "HTTP request timeout" + schemas: + Event: + description: "A discrete event containing one or more readings" + properties: + apiVersion: + description: "A version number shows the API version in DTOs." + type: string + id: + description: "The unique identifier for the event" + type: string + format: uuid + deviceName: + description: "The name of the device from which the event originated" + type: string + profileName: + description: "The name of the device profile from which the event originated" + type: string + sourceName: + description: "The name of the source device resource or command from which the event originated" + type: string + origin: + description: "A Unix timestamp indicating when the event was originated at the source device (can support nanoseconds)" + type: integer + readings: + description: "One or more readings captured at the time of the event" + type: array + items: + $ref: '#/components/schemas/BaseReading' + required: + - apiVersion + - id + - deviceName + - profileName + - sourceName + - origin + - readings + BaseEventResponse: + allOf: + - $ref: '#/components/schemas/BaseResponse' + - properties: + event: + $ref: '#/components/schemas/Event' + description: "A response type for returning an Event to the caller." + ObjectEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/ObjectReading' + BinaryEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/BinaryReading' + StringEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/StringReading' + BoolEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/BoolReading' + BaseResponse: + description: "Defines basic properties which all use-case specific response DTO instances should support" + type: object + properties: + apiVersion: + description: "A version number shows the API version in DTOs." + type: string + example: v2 + statusCode: + description: "A numeric code signifying the operational status of the response." + type: integer + BaseReading: + description: "A base reading type containing common properties from which more specific reading types inherit. This definition should not be implemented but is used elsewhere to indicate support for a mixed list of simple/binary readings in a single event." + type: object + properties: + id: + description: "The unique identifier for the reading" + type: string + format: uuid + origin: + description: "A Unix timestamp indicating when the reading was originated at the source device (can support nanoseconds)" + type: integer + deviceName: + description: "The name of the device from which the reading originated" + type: string + resourceName: + description: "The device resource name for the reading" + type: string + profileName: + description: "The device profile name for the reading" + type: string + valueType: + description: "Indicates the datatype of the value property" + type: string + enum: + - Bool + - String + - Object + - Binary + required: + - apiVersion + - deviceName + - resourceName + - profileName + - origin + - valueType + BoolReading: + description: "An event reading for a bool data type" + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + example: Bool + value: + description: "A string representation of the reading's value" + type: string + enum: + - "true" + - "false" + required: + - value + StringReading: + description: "An event reading for a string data type" + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + example: String + value: + description: "A string representation of the reading's value" + type: string + required: + - value + ObjectReading: + description: "An event reading for an object data type" + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + example: Object + value: + description: "Use objectValue instead." + type: string + example: "" + objectValue: + description: "Object representation of the reading's value" + type: object + required: + - objectValue + BinaryReading: + description: "An event reading for a binary data type" + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + description: "Indicates the datatype of the value property" + type: string + example: Binary + enum: + - Binary + binaryValue: + description: "If the value of the reading is binary, it will be found in this property as a base64 string" + type: string + format: base64 + mediaType: + description: "E.g. MIME Type, indicates what the content type of the binaryValue property is if it's populated." + type: string + example: image/jpeg + value: + description: "Use binaryValue instead." + type: string + example: "" + required: + - binaryValue + - mediaType + ErrorResponse: + allOf: + - $ref: '#/components/schemas/BaseResponse' + - properties: + message: + description: "A field that can contain a free-form message, such as an error message." + type: string + description: "A response type for returning a generic error to the caller." + type: object diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 2b707608..0f5b3087 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -1,10364 +1,20678 @@ +openapi: 3.0.0 info: - description: EdgeX Onvif Device Service REST APIs title: EdgeX Onvif Device Service + description: EdgeX Onvif Device Service REST APIs version: 2.2.0 -openapi: 3.0.0 +servers: +- url: http://0.0.0.0:59882 +tags: +- name: Network Configuration +- name: System Function +- name: Metadata Configuration +- name: Video Streaming +- name: Video Encoder Configuration +- name: User Handling +- name: Auto Discovery +- name: PTZ +- name: PTZ - Capabilities +- name: PTZ - Configuration +- name: PTZ - Actuation +- name: PTZ - Preset +- name: PTZ - Home Position +- name: PTZ - Auxiliary +- name: Event Handling +- name: Analytics +- name: Analytics - Profile Configuration +- name: Analytics - Modules +- name: Analytics - Rules +- name: Custom + description: >- + Custom commands outside of the ONVIF spec handled by the device service + directly. paths: - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AbsoluteMove: - put: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.AbsoluteMove + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Hostname: + get: + tags: + - Network Configuration + summary: Hostname + 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. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - AbsoluteMove: - Position: - PanTilt: - x: 0 - y: 0 - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' - properties: - AbsoluteMove: - properties: - Position: - properties: - PanTilt: - properties: - x: - type: number - y: - type: number - type: object - type: object - ProfileToken: - type: string - type: object - type: object + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetHostnameResponse' example: apiVersion: v2 statusCode: 200 + event: + apiVersion: v2 + id: 6ad6d2d6-51af-4084-8a6a-952928942732 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: Hostname + origin: 1659655574277981200 + readings: + - id: b8e4ba90-2aeb-4336-a5ca-923456cff383 + origin: 1659655574277981200 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: Hostname + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + HostnameInformation: + FromDHCP: false + Name: hostname + '400': &id001 + description: Request is in an invalid state + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK + $ref: '#/components/schemas/ErrorResponse' + examples: + 400Example: + $ref: '#/components/examples/400Example' + '404': &id002 + description: The requested resource does not exist headers: - Content-Length: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: '37' - type: integer - Content-Type: + $ref: '#/components/schemas/ErrorResponse' + examples: + 404Example: + $ref: '#/components/examples/404Example' + '423': &id003 + description: The device is locked (AdminState) + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: application/json - type: string - Date: + $ref: '#/components/schemas/ErrorResponse' + examples: + 423Example: + $ref: '#/components/examples/423Example' + '500': &id004 + description: An unexpected error occurred on the server + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: Tue, 11 Oct 2022 03:24:42 GMT - type: string + $ref: '#/components/schemas/ErrorResponse' + examples: + 500Example: + $ref: '#/components/examples/500Example' + '503': &id005 + description: Service Unavailable + headers: X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: ee6ad0a6-5f98-4d65-a1dc-a5047f1bfd38 - type: string - summary: AbsoluteMove - tags: - - PTZ - Actuation - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddConfiguration: - put: - 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.' + $ref: '#/components/schemas/ErrorResponse' + examples: + 503Example: + $ref: '#/components/examples/503Example' externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.AddConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetHostname + put: + tags: + - Network Configuration + summary: SetHostname + 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 formatted according to RFC 1123 section 2.1 + or alternatively to RFC 952, other string shall be considered as invalid + strings. requestBody: content: application/json: schema: - example: - AddConfiguration: - Configuration: - - Token: '{{ANALYTIC_CONFIG_TOKEN}}' - Type: Analytics - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' properties: - AddConfiguration: - properties: - Configuration: - items: - properties: - Token: - type: string - Type: - type: string - type: object - type: array - ProfileToken: - type: string - type: object + Hostname: + $ref: '#/components/schemas/device_SetHostname' + required: + - Hostname type: object + example: + Hostname: + Name: localhost555 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': + '200': &id006 + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: - application/json: {} - description: Successful response - summary: AddConfiguration - tags: - - Analytics - Profile Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddMetadataConfiguration: - put: - 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. + application/json: + schema: + $ref: '#/components/schemas/BaseResponse' + examples: + 200Example: + $ref: '#/components/examples/200Example' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.AddMetadataConfiguration + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetHostname + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DNS: + get: + tags: + - Network Configuration + summary: DNS + description: >- + This operation gets the DNS settings from a device. The device shall + return its DNS configurations through the GetDNS command. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - AddMetadataConfiguration: - ConfigurationToken: '{{MEDIA_CONFIG_TOKEN}}' - ProfileToken: '{{MEDIA_PROFILE}}' - properties: - AddMetadataConfiguration: - properties: - ConfigurationToken: - type: string - ProfileToken: - type: string - type: object - type: object + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetDNSResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:13:44 GMT - type: string - X-Correlation-Id: - schema: - example: 9aaf8833-760d-4e7b-ac10-123c36fa71fb - type: string - summary: AddMetadataConfiguration - tags: - - Metadata Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddPTZConfiguration: - put: - description: Add a new PTZConfiguration on the device. + event: + apiVersion: v2 + id: d2d2541f-2feb-490f-bf89-b7407d3078d3 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: DNS + origin: 1659671999397808400 + readings: + - id: 3ad48fbe-1e98-4c90-a26e-f83a391c4d8c + origin: 1659671999397808400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: DNS + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + DNSInformation: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.AddPTZConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDNS + put: + tags: + - Network Configuration + summary: SetDNS + description: >- + This operation sets the DNS settings on a device. It shall be possible + to set the device DNS configurations through the SetDNS command. requestBody: content: application/json: schema: - example: - AddPTZConfiguration: - ConfigurationToken: '{{PTZ_CONFIG_TOKEN}}' - ProfileToken: '{{MEDIA_PROFILE}}' properties: - AddPTZConfiguration: - properties: - ConfigurationToken: - type: string - ProfileToken: - type: string - type: object + DNS: + $ref: '#/components/schemas/device_SetDNS' + required: + - DNS type: object + example: + DNS: + FromDHCP: true + DNSManual: + Type: IPv4 + IPv4Address: 192.168.12.1 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDNS + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkInterfaces: + get: + tags: + - Network Configuration + summary: NetworkInterfaces + 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. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetNetworkInterfacesResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 18:27:21 GMT - type: string - X-Correlation-Id: - schema: - example: d264aa4d-1b3f-4788-8807-00acc18388eb - type: string - summary: AddPTZConfiguration - tags: - - PTZ - Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddScopes: - put: - 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. + event: + apiVersion: v2 + id: acc3a74d-852a-4c0c-bf31-dbc06d8a0782 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: NetworkInterfaces + origin: 1659655709817960400 + readings: + - id: 74571fe4-731a-4925-99eb-7d4c317834f6 + origin: 1659655709817960400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkInterfaces + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkInterfaces: + Enabled: true + IPv4: + Config: + DHCP: false + Manual: + Address: 10.0.0.195 + PrefixLength: 24 + Enabled: true + Info: + HwAddress: 10:27:F5:EA:88:F4 + MTU: 1500 + Name: eth0 + Token: eth0 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.AddScopes - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkInterfaces + put: + tags: + - Network Configuration + summary: SetNetworkInterfaces + 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. requestBody: content: application/json: schema: - example: - AddScopes: - ScopeItem: - - http//:123 properties: - AddScopes: - properties: - ScopeItem: - items: - type: string - type: array - type: object + NetworkInterfaces: + $ref: '#/components/schemas/device_SetNetworkInterfaces' + required: + - NetworkInterfaces type: object + example: + NetworkInterfaces: + InterfaceToken: eth0 + NetworkInterface: + Enabled: true + IPv4: + DHCP: true + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkInterfaces + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkProtocols: + get: + tags: + - Network Configuration + summary: NetworkProtocols + description: >- + This operation gets defined network protocols from a device. The device + shall support the GetNetworkProtocols command returning configured + network protocols. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetNetworkProtocolsResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Sun, 25 Sep 2022 03:41:03 GMT - type: string - X-Correlation-Id: - schema: - example: 6c1402e7-4516-4661-9ba7-b486dc20336f - type: string - summary: Add Scopes + event: + apiVersion: v2 + id: 193b3677-23c8-4d89-852e-73a1aabf445e + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: NetworkProtocols + origin: 1659671976670370300 + readings: + - id: d3a47ec4-3b43-413a-9a67-42f54487cfa5 + origin: 1659671976670370300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkProtocols + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkProtocols: + - Enabled: true + Name: HTTPS + Port: 443 + - Enabled: true + Name: RTSP + Port: 554 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkProtocols + put: tags: - - Auto Discovery - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AnalyticsModules: - get: - description: List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. + - Network Configuration + summary: SetNetworkProtocols + description: >- + This operation configures defined network protocols on a device. The + device shall support configuration of defined network protocols through + the SetNetworkProtocols command. + requestBody: + content: + application/json: + schema: + properties: + NetworkProtocols: + $ref: '#/components/schemas/device_SetNetworkProtocols' + required: + - NetworkProtocols + type: object + example: + NetworkProtocols: + NetworkProtocols: + - Name: HTTP + Enabled: true + Port: 2020 + - Name: HTTPS + Enabled: false + Port: 443 + - Name: RTSP + Enabled: true + Port: 554 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetAnalyticsModules + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkProtocols + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkDefaultGateway: + get: + tags: + - Network Configuration + summary: NetworkDefaultGateway + description: >- + This operation gets the default gateway settings from a device. The + device shall support the GetNetworkDefaultGateway command returning + configured default gateway address(es). parameters: - - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetNetworkDefaultGatewayResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 76f908cd-6b34-477f-9a03-5eea4021b416 - origin: 1665460175164294000 + id: 78915210-fab0-4018-a8ed-72f793c2cbc7 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera + sourceName: NetworkDefaultGateway + origin: 1659671987813255200 readings: - - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: c5f01e17-9b31-43eb-bc55-2417617ef530 - objectValue: - AnalyticsModule: - - Name: MyCellMotionModule - Parameters: - SimpleItem: - - Name: Sensitivity - Value: '6' - Type: tt:CellMotionEngine - origin: 1665460175164294000 - profileName: onvif-camera - resourceName: AnalyticsModules - value: '' - valueType: Object - sourceName: AnalyticsModules - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - AnalyticsModule: - items: - properties: - Name: - type: string - Parameters: - properties: - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - type: object - type: array - type: object - Type: - type: string - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '678' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:49:35 GMT - type: string - X-Correlation-Id: - schema: - example: e1799801-2c54-4816-b766-2d93caee89c9 - type: string - summary: GetAnalyticsModules - tags: - - Analytics - Modules - put: - 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. + - id: c348128d-0c51-4470-a978-b431302906a0 + origin: 1659671987813255200 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkDefaultGateway + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkGateway: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.ModifyAnalyticsModules - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkDefaultGateway + put: + tags: + - Network Configuration + summary: SetNetworkDefaultGateway + description: >- + This operation sets the default gateway settings on a device. The device + shall support configuration of default gateway through the + SetNetworkDefaultGateway command. requestBody: content: application/json: schema: - example: - AnalyticsModules: - AnalyticsModule: - - Name: Viproc - Parameters: - SimpleItem: - - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' - Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' - Type: '{{ANALYTIC_MODULE_TYPE}}' - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' properties: - AnalyticsModules: - properties: - AnalyticsModule: - items: - properties: - Name: - type: string - Parameters: - properties: - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - type: object - type: array - type: object - Type: - type: string - type: object - type: array - ConfigurationToken: - type: string - type: object + NetworkDefaultGateway: + $ref: '#/components/schemas/device_SetNetworkDefaultGateway' + required: + - NetworkDefaultGateway type: object + example: + NetworkDefaultGateway: + IPv4Address: 192.168.12.1 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkDefaultGateway + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkConfiguration: + get: + tags: + - Network Configuration + summary: NetworkConfiguration + description: >- + Used to retrieve network resources for a device such as Hostname, DNS, + NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: - application/json: {} - description: Successful response - summary: ModifyAnalyticsModules - tags: - - Analytics - Modules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/BaseNotificationSubscription: + application/json: + schema: + type: object + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: b34fe9d1-78f9-4b49-961b-80a252e084c4 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: NetworkConfiguration + origin: 1659656577804929300 + readings: + - id: 67e318f5-4426-48ff-8235-4a2471e47baf + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: Hostname + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + HostnameInformation: + FromDHCP: false + Name: hostname + - id: 76cfd2b5-f178-4d16-88d1-6b04f129a867 + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: DNS + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + DNSInformation: {} + - id: 301b79ab-c92d-4a3f-9776-9a71f6c3c340 + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkInterfaces + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkInterfaces: + Enabled: true + IPv4: + Config: + DHCP: false + Manual: + Address: 10.0.0.188 + PrefixLength: 24 + Enabled: true + Info: + HwAddress: 10:27:F5:EA:88:F4 + MTU: 1500 + Name: eth0 + Token: eth0 + - id: cc1d5230-06a8-4515-822e-187ba07d0efc + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkProtocols + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkProtocols: + - Enabled: true + Name: HTTPS + Port: 443 + - Enabled: true + Name: RTSP + Port: 554 + - id: 81f9c4e6-1cfd-487a-a05b-b8ea5b39ffcf + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkDefaultGateway + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkGateway: {} put: - description: Create a subscription to subscribe the event from the camera - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - Network Configuration + summary: SetNetworkConfiguration + description: >- + Used to configure network resources for a device such as Hostname, DNS, + NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. requestBody: content: application/json: schema: - example: - BaseNotificationSubscription: - InitialTerminationTime: PT180S - TopicFilter: tns1:RuleEngine/TamperDetector/Tamper - properties: - BaseNotificationSubscription: - properties: - InitialTerminationTime: - type: string - TopicFilter: - type: string - type: object type: object + example: + Hostname: + Name: localhost + DNS: + FromDHCP: false + DNSManual: + Type: IPv4 + IPv4Address: 192.168.12.1 + NetworkInterfaces: + InterfaceToken: eth0 + NetworkInterface: + Enabled: true + IPv4: + DHCP: false + NetworkProtocols: + NetworkProtocols: + - Name: HTTP + Enabled: true + Port: 80 + NetworkDefaultGateway: + IPv4Address: 192.168.12.1 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + type: object example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 21:56:11 GMT - type: string - X-Correlation-Id: - schema: - example: 9ad845c6-441e-42fb-bb3c-f2399aa22e34 - type: string - summary: BaseNotificationSubscription - tags: - - Event Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CompatibleMetadataConfigurations: + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeviceInformation: get: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetCompatibleMetadataConfigurations + tags: + - System Function + summary: DeviceInformation + description: This operation gets basic device information from the device. parameters: - - example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetDeviceInformationResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: a025e1b1-7e2b-4db8-95b6-7dac978e9c97 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 410b5658-82d9-488c-a5c4-c69f0ff6d273 - origin: 1659659188300470500 profileName: onvif-camera + sourceName: DeviceInformation + origin: 1659672857568971800 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 86aa4298-c8ee-4c74-afc9-73104bb3cd11 - objectValue: - Configurations: {} - origin: 1659659188300470500 - profileName: onvif-camera - resourceName: CompatibleMetadataConfigurations - value: '' - valueType: Object - sourceName: CompatibleMetadataConfigurations - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Configurations: - properties: {} - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '580' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:28 GMT - type: string - X-Correlation-Id: - schema: - example: 362fa295-c750-49a8-a457-a5b5d1486cc6 - type: string - summary: CompatibleMetadataConfigurations - tags: - - Metadata Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Configuration: - get: - 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.' + - id: 3039ffbc-165a-46ef-849b-95c7df9aacfa + origin: 1659672857568971800 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: DeviceInformation + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + FirmwareVersion: 1.1.16 Build 211209 Rel.37726n(4555) + HardwareId: '1.0' + Manufacturer: TP-Link + Model: C200 + SerialNumber: 00c20000 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetConfiguration + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDeviceInformation + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemDateAndTime: + get: + tags: + - System Function + summary: SystemDateAndTime + 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. parameters: - - description: '{"PTZConfigurationToken": "PTZConfiguration0"}' - example: eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetSystemDateAndTimeResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: da6f552e-e4b3-4d75-a2ce-989745b8ef7b deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 13f39ebb-cde4-4d99-bbc2-b207c4a40ca3 - origin: 1659656383599131400 profileName: onvif-camera + sourceName: SystemDateAndTime + origin: 1659672865881317600 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 3a5e5c97-268a-4c84-ae79-f51ada66889e - objectValue: - PTZConfiguration: - DefaultAbsolutePantTiltPositionSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - DefaultContinuousPanTiltVelocitySpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - DefaultPTZSpeed: {} - DefaultPTZTimeout: PT0H0M20S - DefaultRelativePanTiltTranslationSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - PanTiltLimits: - Range: - URI: '' - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: PTZConfiguration0 - origin: 1659656383599131400 - profileName: onvif-camera - resourceName: Configuration - value: '' - valueType: Object - sourceName: Configuration - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - PTZConfiguration: - properties: - DefaultAbsolutePantTiltPositionSpace: - type: string - DefaultContinuousPanTiltVelocitySpace: - type: string - DefaultPTZSpeed: - properties: {} - type: object - DefaultPTZTimeout: - type: string - DefaultRelativePanTiltTranslationSpace: - type: string - PanTiltLimits: - properties: - Range: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - Token: - type: string - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1053' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:39:43 GMT - type: string - X-Correlation-Id: - schema: - example: 38e09ee2-1b82-4112-b928-214417616d76 - type: string - summary: GetConfiguration - tags: - - PTZ - Configuration - put: - description: Set/update a existing PTZConfiguration on the device. + - id: aa61a541-beb5-4be0-bb7a-625ce60a980e + origin: 1659672865881317600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: SystemDateAndTime + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + SystemDateAndTime: + DateTimeType: NTP + DaylightSavings: true + Extension: '' + LocalDateTime: + Date: + Month: '8' + Year: '2022' + Time: + Hour: '21' + Minute: '14' + Second: '25' + TimeZone: + TZ: > + GMT+08:00DST+07:00,M3.2.0/02:00:00,M11.1.0/02:00:00 + UTCDateTime: + Date: + Month: '8' + Year: '2022' + Time: + Hour: '4' + Minute: '14' + Second: '25' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SetConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetSystemDateAndTime + put: + tags: + - System Function + summary: SetSystemDateAndTime + 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. requestBody: content: application/json: schema: - example: - Configuration: - PTZConfiguration: - NodeToken: '{{PTZ_NODE_TOKEN}}' - PanTiltLimits: - Range: - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: '{{PTZ_CONFIG_TOKEN}}' properties: - Configuration: - properties: - PTZConfiguration: - properties: - NodeToken: - type: string - PanTiltLimits: - properties: - Range: - properties: - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - Token: - type: string - type: object - type: object + SystemDateAndTime: + $ref: '#/components/schemas/device_SetSystemDateAndTime' + required: + - SystemDateAndTime type: object + example: + SystemDateAndTime: + DateTimeType: Manual + DaylightSavings: false + UTCDateTime: + Date: + Month: 12 + Year: 2021 + Day: 11 + Time: + Hour: 5 + Minute: 48 + Second: 20 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 18:05:10 GMT - type: string - X-Correlation-Id: - schema: - example: 907ca3c4-30ed-442c-b9c6-2ba7742e073a - type: string - summary: SetConfiguration - tags: - - PTZ - Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/ContinuousMove: - put: - 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. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.ContinuousMove - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemDateAndTime + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetSystemFactoryDefault: + put: + tags: + - System Function + summary: SetSystemFactoryDefault + description: >- + This operation reloads the parameters on the device to their factory + default values. requestBody: content: application/json: schema: - example: - ContinuousMove: - ProfileToken: '{{MEDIA_PROFILE}}' - Velocity: - PanTilt: - x: -1 - y: -1 properties: - ContinuousMove: - properties: - ProfileToken: - type: string - Velocity: - properties: - PanTilt: - properties: - x: - type: number - y: - type: number - type: object - type: object - type: object + SetSystemFactoryDefault: + $ref: '#/components/schemas/device_SetSystemFactoryDefault' + required: + - SetSystemFactoryDefault type: object + example: + SetSystemFactoryDefault: + FactoryDefault: Soft + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemFactoryDefault + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RebootNeeded: + get: + tags: + - System Function + summary: RebootNeeded + description: >- + Indicates whether or not a reboot is required after configuration + updates. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + $ref: '#/components/schemas/BoolEventResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 18:27:42 GMT - type: string - X-Correlation-Id: - schema: - example: a09ac058-3809-47a7-b90e-cfdb6d6a7231 - type: string - summary: ContinuousMove - tags: - - PTZ - Actuation - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateAnalyticsModules: + event: + apiVersion: v2 + id: cb3b3a49-86e4-44e3-b2a0-426b08168ae1 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: RebootNeeded + origin: 1659672882772484400 + readings: + - id: f56f48df-d664-4179-98d1-abcb496f07bc + origin: 1659672882772484400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: RebootNeeded + profileName: onvif-camera + valueType: Bool + value: 'false' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemReboot: put: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.CreateAnalyticsModules - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - System Function + summary: SystemReboot requestBody: content: application/json: schema: - example: - CreateAnalyticsModules: - AnalyticsModule: - - Name: TestAnalyticsModule - Parameters: - SimpleItem: - - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' - Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' - Type: '{{ANALYTIC_MODULE_TYPE}}' - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' properties: - CreateAnalyticsModules: - properties: - AnalyticsModule: - items: - properties: - Name: - type: string - Parameters: - properties: - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - type: object - type: array - type: object - Type: - type: string - type: object - type: array - ConfigurationToken: - type: string - type: object + SystemReboot: + $ref: '#/components/schemas/device_SystemReboot' + required: + - SystemReboot type: object + example: + SystemReboot: {} + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SystemReboot + description: This operation reboots the device. + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurations: + get: + tags: + - Metadata Configuration + summary: MetadataConfigurations + description: >- + This operation lists all existing metadata configurations. The client + need not know anything apriori about the metadata in order to use the + command. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetMetadataConfigurationsResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 22:08:45 GMT - type: string - X-Correlation-Id: - schema: - example: fe3cf678-d914-4729-805c-1e08d930a1b2 - type: string - summary: CreateAnalyticsModules + event: + apiVersion: v2 + id: 1acba723-b1b1-4790-8e80-9d554cacaedc + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: MetadataConfigurations + origin: 1659659180814799600 + readings: + - id: 8c59a3a8-401b-4e18-8af5-9a98efe7f410 + origin: 1659659180814799600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: MetadataConfigurations + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Configurations: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfiguration: + get: tags: - - Analytics - Modules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateRules: - put: - 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. + - Metadata Configuration + summary: MetadataConfiguration + description: |- + The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. +
- Pass unique module names which can be later used as reference. The Parameters - of the rules must match those of the corresponding description. + **`jsonObject` Schema:** + _See: [media_GetMetadataConfiguration](#media_GetMetadataConfiguration)_ - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.CreateRules + ```yaml + { + "ConfigurationToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - CreateRules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' - Rule: - - Name: Object Counting - Parameters: - ElementItem: - - Name: Segments - Polyline: - Point: - - x: '0.16' - y: '0.5' - - x: '0.16' - y: '-0.5' - SimpleItem: - - Name: Armed - Value: 'true' - Type: tt:LineCounting - properties: - CreateRules: - properties: - ConfigurationToken: - type: string - Rule: - items: - properties: - Name: - type: string - Parameters: - properties: - ElementItem: - items: - properties: - Name: - type: string - Polyline: - properties: - Point: - items: - properties: - x: - type: string - y: - type: string - required: - - x - - y - type: object - type: array - type: object - type: object - type: array - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - type: object - type: array - type: object - Type: - type: string - type: object - type: array - type: object - type: object + - name: jsonObject + in: query + schema: + type: string + example: '{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetMetadataConfigurationResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 22:19:30 GMT - type: string - X-Correlation-Id: - schema: - example: f4fb4b14-0de5-4a00-9646-1fc10b772b61 - type: string - summary: CreateRules - tags: - - Analytics - Rules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateUsers: - put: - 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.' + event: + apiVersion: v2 + id: 53480499-ece4-4437-b795-0ff4f57a564a + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + profileName: onvif-camera + sourceName: MetadataConfiguration + origin: 1663974689815368400 + readings: + - id: b6cda316-6a50-4990-8279-e2777be95c79 + origin: 1663974689815368400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + resourceName: MetadataConfiguration + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Configuration: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.CreateUsers - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfiguration + put: + tags: + - Metadata Configuration + summary: SetMetadataConfiguration + 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. requestBody: content: application/json: schema: - example: - CreateUsers: - User: - - Password: Password1! - UserLevel: User - Username: user1 - - Password: Password1! - UserLevel: User - Username: user2 properties: - CreateUsers: - properties: - User: - items: - properties: - Password: - type: string - UserLevel: - type: string - Username: - type: string - required: - - Username - - Password - - UserLevel - type: object - type: array - type: object + MetadataConfiguration: + $ref: '#/components/schemas/media_SetMetadataConfiguration' + required: + - MetadataConfiguration type: object + example: + MetadataConfiguration: + ForcePersistence: true + Configuration: + token: '{{MEDIA_CONFIG_TOKEN}}' + Analytics: true + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetMetadataConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CompatibleMetadataConfigurations: + get: + tags: + - Metadata Configuration + summary: CompatibleMetadataConfigurations + 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. + +
+ + **`jsonObject` Schema:** + + _See: [media_GetCompatibleMetadataConfigurations](#media_GetCompatibleMetadataConfigurations)_ + + ```yaml + { + "ProfileToken": "" + } + ``` + parameters: + - name: jsonObject + in: query + schema: + type: string + example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: schema: - example: Sun, 25 Sep 2022 03:40:48 GMT - type: string - X-Correlation-Id: - schema: - example: e772e887-419e-4647-ae97-59722fbc7317 - type: string - summary: Create Users - tags: - - User Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CustomMetadata: - get: - description: This command returns the user specified custom metadata associated - with a device. - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - responses: - '200': - content: - application/json: - examples: - example-0: - summary: Get CustomMetadata - value: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - id: 6905a513-3aff-454b-981d-ea8e0c79f195 - origin: 1663976147356099300 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - id: c90f88b6-7e2f-4e37-8fa7-b173a4d6ffec - objectValue: - Business: John's Grocery Store - Install Date: 01/01/1970 - Location: Front door - origin: 1663976147356099300 - profileName: onvif-camera - resourceName: CustomMetadata - value: '' - valueType: Object - sourceName: CustomMetadata - statusCode: 200 - example-1: - summary: GetSpecificCustomMetadata-multipleFields Copy - value: - apiVersion: v2 + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - id: 0749ab9c-05b4-4515-a2b0-5d253aeb8be9 - origin: 1663976177486172000 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - id: 295d2e23-ffae-4c7e-9440-6be14fc1c93e - objectValue: - Business: John's Grocery Store - Location: Front door - origin: 1663976177486172000 - profileName: onvif-camera - resourceName: CustomMetadata - value: '' - valueType: Object - sourceName: CustomMetadata - statusCode: 200 - schema: - type: object - description: OK - headers: - Content-Length: - schema: - example: '610' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:35:47 GMT - type: string - X-Correlation-Id: - schema: - example: 286e0f26-f708-457d-ba3e-af6203e85c72 - type: string - summary: Get CustomMetadata - tags: - - Custom - put: - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - CustomMetadata: - Business: John's Grocery Store - Install Date: 01/01/1970 - Location: Front door - properties: - CustomMetadata: - properties: - Business: - type: string - Install Date: - type: string - Location: - type: string - type: object - type: object - responses: - '200': - content: - application/json: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetCompatibleMetadataConfigurationsResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:35:38 GMT - type: string - X-Correlation-Id: - schema: - example: 65511822-66bc-48e5-94fc-71d393be11a4 - type: string - summary: Set CustomMetadata - tags: - - Custom - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DNS: - get: - description: This operation gets the DNS settings from a device. The device - shall return its DNS configurations through the GetDNS command. + event: + apiVersion: v2 + id: 410b5658-82d9-488c-a5c4-c69f0ff6d273 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: CompatibleMetadataConfigurations + origin: 1659659188300470500 + readings: + - id: 86aa4298-c8ee-4c74-afc9-73104bb3cd11 + origin: 1659659188300470500 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: CompatibleMetadataConfigurations + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Configurations: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDNS + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetCompatibleMetadataConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurationOptions: + get: + tags: + - Metadata Configuration + summary: MetadataConfigurationOptions + description: |- + This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. + +
+ + **`jsonObject` Schema:** + + _See: [media_GetMetadataConfigurationOptions](#media_GetMetadataConfigurationOptions)_ + + ```yaml + { + "ConfigurationToken": "", + "ProfileToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + example: '{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetMetadataConfigurationOptionsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: f296e8b5-707f-4e66-9388-918821b83a19 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: d2d2541f-2feb-490f-bf89-b7407d3078d3 - origin: 1659671999397808400 profileName: onvif-camera + sourceName: MetadataConfigurationOptions + origin: 1659659194429862100 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 3ad48fbe-1e98-4c90-a26e-f83a391c4d8c - objectValue: - DNSInformation: {} - origin: 1659671999397808400 - profileName: onvif-camera - resourceName: DNS - value: '' - valueType: Object - sourceName: DNS - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - DNSInformation: - properties: {} - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '522' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 03:59:59 GMT - type: string - X-Correlation-Id: - schema: - example: d1eccd37-33c0-4c5d-bbb3-434b384399d2 - type: string - summary: DNS - tags: - - Network Configuration - put: - description: This operation sets the DNS settings on a device. It shall be possible - to set the device DNS configurations through the SetDNS command. + - id: f8efa15a-612d-4532-b40b-4e895cecb3bd + origin: 1659659194429862100 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: MetadataConfigurationOptions + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Options: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDNS - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurationOptions + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddMetadataConfiguration: + put: + tags: + - Metadata Configuration + summary: AddMetadataConfiguration + 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. requestBody: content: application/json: schema: - example: - DNS: - DNSManual: - IPv4Address: 192.168.12.1 - Type: IPv4 - FromDHCP: true properties: - DNS: - properties: - DNSManual: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - FromDHCP: - type: boolean - type: object + AddMetadataConfiguration: + $ref: '#/components/schemas/media_AddMetadataConfiguration' + required: + - AddMetadataConfiguration type: object + example: + AddMetadataConfiguration: + ProfileToken: '{{MEDIA_PROFILE}}' + ConfigurationToken: '{{MEDIA_CONFIG_TOKEN}}' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:19:16 GMT - type: string - X-Correlation-Id: - schema: - example: f596f4f6-812f-4124-a502-f427f3a8ac7b - type: string - summary: SetDNS - tags: - - Network Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteAnalyticsModules: - put: - description: Remove one or more analytics modules from a VideoAnalyticsConfiguration - referenced by their names. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.DeleteAnalyticsModules - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.AddMetadataConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveMetadataConfiguration: + put: + tags: + - Metadata Configuration + summary: RemoveMetadataConfiguration + 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. requestBody: content: application/json: schema: - example: - DeleteAnalyticsModules: - AnalyticsModuleName: - - TestAnalyticsModule - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' properties: - DeleteAnalyticsModules: - properties: - AnalyticsModuleName: - items: - type: string - type: array - ConfigurationToken: - type: string - type: object + RemoveMetadataConfiguration: + $ref: '#/components/schemas/media_RemoveMetadataConfiguration' + required: + - RemoveMetadataConfiguration type: object + example: + RemoveMetadataConfiguration: + ProfileToken: '{{MEDIA_PROFILE}}' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Mon, 10 Oct 2022 16:01:37 GMT - type: string - X-Correlation-Id: - schema: - example: ffb1e371-1a66-4f14-94e1-e24b440f2cb3 - type: string - summary: DeleteAnalyticsModules + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.RemoveMetadataConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Profiles: + get: tags: - - Analytics - Modules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteCustomMetadata: - put: + - Video Streaming + summary: Profiles + 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. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - DeleteCustomMetadata: - - Location - - Color - properties: - DeleteCustomMetadata: - items: - type: string - type: array - type: object + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetProfilesResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 21:57:55 GMT - type: string - X-Correlation-Id: - schema: - example: a0fd5620-29fa-4588-8bf3-e97e9aabec80 - type: string - summary: Delete CustomMetadata - tags: - - Custom - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteRules: - put: - description: Remove one or more rules from a VideoAnalyticsConfiguration. + event: + apiVersion: v2 + id: e6560b52-1952-4d66-9f53-3cf27d48b3c0 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: Profiles + origin: 1659656314715442700 + readings: + - id: 5c7bc03c-308f-4b2c-8bc9-2e59da7d6f65 + origin: 1659656314715442700 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: Profiles + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Profiles: + - AudioEncoderConfiguration: + Bitrate: 131072 + Encoding: G711 + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: AudioEncoder_1 + SampleRate: 8000 + SessionTimeout: PT0H1M5S + Token: microphone + UseCount: 2 + AudioSourceConfiguration: + Name: AudioSourceConfig + SourceToken: raw_as1 + Token: asconf + UseCount: 2 + Extension: + Fixed: true + MetadataConfiguration: + Name: mainStream + PTZConfiguration: + DefaultAbsolutePantTiltPositionSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + DefaultContinuousPanTiltVelocitySpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + DefaultPTZSpeed: {} + DefaultPTZTimeout: PT0H0M20S + DefaultRelativePanTiltTranslationSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + PanTiltLimits: + Range: + URI: '' + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + Token: PTZConfiguration0 + Token: profile_1 + VideoAnalyticsConfiguration: + AnalyticsEngineConfiguration: + AnalyticsModule: + - Name: MyCellMotionModule + Parameters: + ElementItem: + - Name: Layout + SimpleItem: + - Name: Sensitivity + Value: medium + - Name: Enabled + Value: off + Type: tt:CellMotionEngine + - Name: MyTamperDetecModule + Parameters: + SimpleItem: + - Name: Sensitivity + - Name: Enabled + Type: tt:TamperEngine + Name: VideoAnalyticsName + RuleEngineConfiguration: + Rule: + Name: MyTamperDetectorRule + Parameters: + SimpleItem: + - Name: ActiveCells + Value: 0P8A8A== + - Name: MinCount + Value: '5' + - Name: AlarmOnDelay + Value: '1000' + - Name: AlarmOffDelay + Value: '1000' + Type: tt:TamperDetector + Token: VideoAnalyticsToken + UseCount: 2 + VideoEncoderConfiguration: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_1 + Quality: 3 + RateControl: + BitrateLimit: 1024 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 1080 + Width: 1920 + SessionTimeout: PT0H1M5S + Token: main + UseCount: 1 + VideoSourceConfiguration: + Bounds: + Height: 720 + Width: 1280 + X: 0 + Y: 0 + Extension: + Name: VideoSourceConfig + SourceToken: raw_vs1 + Token: vsconf + UseCount: 2 + ViewMode: '' + - AudioEncoderConfiguration: + Bitrate: 131072 + Encoding: G711 + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: AudioEncoder_1 + SampleRate: 8000 + SessionTimeout: PT0H1M5S + Token: microphone + UseCount: 2 + AudioSourceConfiguration: + Name: AudioSourceConfig + SourceToken: raw_as1 + Token: asconf + UseCount: 2 + Extension: + Fixed: true + MetadataConfiguration: + Name: minorStream + PTZConfiguration: + DefaultAbsolutePantTiltPositionSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + DefaultContinuousPanTiltVelocitySpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + DefaultPTZSpeed: {} + DefaultPTZTimeout: PT0H0M20S + DefaultRelativePanTiltTranslationSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + PanTiltLimits: + Range: + URI: '' + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + Token: PTZConfiguration0 + Token: profile_2 + VideoAnalyticsConfiguration: + AnalyticsEngineConfiguration: + AnalyticsModule: + - Name: MyCellMotionModule + Parameters: + ElementItem: + - Name: Layout + SimpleItem: + - Name: Sensitivity + Value: medium + - Name: Enabled + Value: off + Type: tt:CellMotionEngine + - Name: MyTamperDetecModule + Parameters: + SimpleItem: + - Name: Sensitivity + - Name: Enabled + Type: tt:TamperEngine + Name: VideoAnalyticsName + RuleEngineConfiguration: + Rule: + Name: MyTamperDetectorRule + Parameters: + SimpleItem: + - Name: ActiveCells + Value: 0P8A8A== + - Name: MinCount + Value: '5' + - Name: AlarmOnDelay + Value: '1000' + - Name: AlarmOffDelay + Value: '1000' + Type: tt:TamperDetector + Token: VideoAnalyticsToken + UseCount: 2 + VideoEncoderConfiguration: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_2 + Quality: 3 + RateControl: + BitrateLimit: 256 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 360 + Width: 640 + SessionTimeout: PT0H1M5S + Token: minor + UseCount: 1 + VideoSourceConfiguration: + Bounds: + Height: 720 + Width: 1280 + X: 0 + Y: 0 + Extension: + Name: VideoSourceConfig + SourceToken: raw_vs1 + Token: vsconf + UseCount: 2 + ViewMode: '' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.DeleteRules + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetProfiles + /api/v2/device/name/{EDGEX_DEVICE_NAME}/StreamUri: + get: + tags: + - Video Streaming + summary: StreamUri + 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. + +
+ + **`jsonObject` Schema:** + + _See: [media_GetStreamUri](#media_GetStreamUri)_ + + ```yaml + { + "ProfileToken": "", + "StreamSetup": { + "Stream": "", + "Transport": { + "Protocol": "", + "Tunnel": { $ref: onvif_Transport } + } + } + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - DeleteRules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' - RuleName: - - Object Counting - properties: - DeleteRules: - properties: - ConfigurationToken: - type: string - RuleName: - items: - type: string - type: array - type: object - type: object + - name: jsonObject + in: query + schema: + type: string + example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetStreamUriResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Mon, 10 Oct 2022 16:01:21 GMT - type: string - X-Correlation-Id: - schema: - example: 96730551-cf42-4d2c-8918-aa0c694cbe9c - type: string - summary: DeleteRules - tags: - - Analytics - Rules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteUsers: - put: - 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. + event: + apiVersion: v2 + id: 0ef64d9b-ba26-49a9-9a9f-5ec6f7b47190 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: StreamUri + origin: 1659656323588827000 + readings: + - id: 255085ba-4399-489d-aa34-cab5e1379281 + origin: 1659656323588827000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: StreamUri + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + MediaUri: + InvalidAfterConnect: false + InvalidAfterReboot: false + Timeout: PT0H0M2S + Uri: rtsp://10.0.0.188:554/stream1 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.DeleteUsers + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetStreamUri + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Snapshot: + get: + tags: + - Video Streaming + summary: Snapshot + description: >- + This request returns a snapshot of the video stream at the time the + command is given. + + + It is returned in a binary format. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - DeleteUsers: - Username: - - user1 - - user2 - properties: - DeleteUsers: - properties: - Username: - items: - type: string - type: array - type: object - type: object + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + $ref: '#/components/schemas/BinaryEventResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Sun, 25 Sep 2022 03:40:57 GMT - type: string - X-Correlation-Id: - schema: - example: 12780a21-c3b4-42b1-9e46-11369a5926de - type: string - summary: Delete users - tags: - - User Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeviceInformation: + event: + apiVersion: v2 + id: 5fdf593f-2a92-4a71-b08c-791d7a27fdff + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + profileName: onvif-camera + sourceName: Snapshot + origin: 1665415500727830500 + readings: + - id: d04a9dad-feb9-4099-a524-8a4b4cf2cc37 + origin: 1665415500727830500 + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + resourceName: Snapshot + profileName: onvif-camera + valueType: Binary + binaryValue: >- + /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACAAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDzGwiBtoGx/wAs1/kK0BGPSotPH+g23/XFP5CreKxOyOwxVqTYuOlAWn7eKQFd1VQDtH3hUgtoz1QUsq/u2PoM1PikBCLWL+4KelkhOQSAOp3dKoX+sQWalVO+X0HasB9bumOfMP0oDmR2T6c/klt/4d/5VRvNOkhxvQrkcblH4/rmsaz8TT25bzP3qMCNp7Z9K3IvGcU0C211F5kROTnG4dOh7dKYXTMPysXeMV0MKgDpVC4+xTXiy2QkMXPDNuI4rRgGcUBYsqgFSgUiLUoFMmwzbU8a0wLzVmMAimMlij713+h2a2lhEpX52G5vxrj9Nthc3kUJGQx5HtXoUaYFBUELIgYZ2ivLviHKJ47tAoxDAyj8ia9TkkWGF5HOFUc15H4oJm03UZW5LQyH9DTiKo9DmdPQ/YbbH/PFP5CrgWoNNP8AxLbX/rin8hVwVIR2GBacFp4UU8LSAryL8hqrqF4LTTTICN54XNaEi/Ka5LXpi8kcfZF6e5oAxXcscmoy1KetMaqSMGLuGacGqIU8A02gNK0vWhTAJByDXX6bMLiFXXvXBxiur8NSMZBGx+X0rKRvTd3Y6VBUyjirM1uoCOg4bP5j/IqMJirTHKNhgFSxjmgJTo1IamSdL4Xh3X5fH3Vrs8Yrl/Csf7yZ/Yf1rqyKGaIyddlMemOF43naa8419c6HqJx/y7Sf+gmvQPExItIVHQuc/lXB6+MeH9SP/TtJ/wCgmtYGFU5jTVH9mWn/AFxT+Qq2FqjppP8AZ1qP+mKfyFaS9KxNI7ABTgKUCngDFICMjiuG1cEXsoPrXdtiuP8AEUW25V/7wNBMjnj1ptPbrTcc1Zix8MZedR2zzVuWEKpUDBBp1lDj5z+FWbiA7t46GspT1OmnT0uVbOHfLg9K9G0Lw8xtYLuAr5chYZZuflxk1wtpFtkz2r03w5K7aBdRXczrHbyRNGuBwH3A4+vH6UblU9GdHe2sP2Nx5iBtxK57np/9euaxTjfSSjBOBTQaqBdRp7CgU9Rg01aeOtUYnV+FjzN9BXUiuS8Ln/SWX1WuvUc0MtGJ4nQ/Z7Y44yf6VwfiEY8P6l/17Sf+gmvR/ESb9MiOORJ/MH/CvP8AxGn/ABT2pHt9lk/9BNbwOeocPp0MzWFqwdR+5T+Qq4ILr+8lJpqj+zbP/rhH/wCg1eVaxNY7FURXX95Kf9nu/wC+lWwKkAqWhmU7XKnBWsvWIxJYuzD5lwRXTyRFkIUZasPVrO5Ns6LBISeOmR+lAmjidhJp6QMx6VrLpk0Ry8R/KmPHtbGMVnKdg5CONdiYFWuGhwagqzEm5BWL1N4qxNZoN4wK9C1R/M0jSQEVWNth2A5faxVc/QAVwtpGVbPpXpviH+zrTR9Ks1niFxDHlgvcNz/P+daxYmjnIweKsqKbGqkDBzU6rWyMhB0p69aAlSpHVNEm1oD7L+L3OK7pBXnunnyriJ/Rga9CRuhpFplTWofM05sdVIavPfEq48Nap/16S/8AoBr064QTwPGf4gRXm/iZMeGtVyOlpLn/AL5NaQdkY1Fc4fTR/wASyz/64R/+gitFU4qrpUQ/sqyZ8qot48+v3RVpbiVFkiixhxg5QE/gSMj8KzNI7DguFLZGB1yRU9ncWRLLc7xgfK688+mPSs1oHbr+tK6i3i3NwPWpGaUVxam4wqMAOjMe/wBKW8vbSGM+dIq56AnrXPPeSSf8e2UTvIR/IUiwRiOS6nbeQPvSck0mxsklubedW8mVW9s1nOFOeBVS65BuYE8tg33R3FSRP5ihgeDUNDI3t1ZvkGCe1WLa3YcEVNboplBIq/GirIDjjvUuJdN62Io4SozViOEzq4X74rUisEnjPkgucZwAc04RQ2MrJEfMZ12yHHAPfFZ6nZaJjQve2hyrnGehGQa7BrcMsUsQIiliWQE+pHI/A5H4VkSxqyHI6dvSum0TbqPh2W3zmeyJdB3MZ64+h5/GtoHNWguhnhcdadkZ4pWpoHNanMWYeor0G1ffBG2eqivPYuldxob79PXnOKBo0+1cL42h8rQ9ZHrZyn/xw13ijNcj4/hx4c1WT1sZh+SGriRI820qEyaZp/p9mj/9BFX/ALKELEjHyk1Z0qK3g8M6bPMQo+yQkk+6CqNzJc3zYhR0i6Db94/X0qTSOxBcXKR/u41MkvoOg+pqolpNeEGYb8fgo/DvWpDpSR7TIM8Z254/+vV4g8jtxxQBhLZbPv8AJxj2rO1k+UkcC/Vh/KukkT94KwdcXzbmCJRl8HP41IGBGXkcKo9eKfYj9y6n7ytW9Y6X9nUtImZT+lZWwWepTQkYWTFS0ImgilyCBVxGYfeHNWEgCqAKUw07DLNrfvAwaGRo3HQqcVNJ4j1JeWuBKAc/vYlfH0yKzfLxUU/EJpWK5mbNv4kt7ydY9StIgrHDS267Hx/ujg/lWnaXn/CO67b3sJM9jJkpIoIEsZ4I+o9PUVwg4OeldZ4d1GC7h/si+ZVhIzDKesT+v0PQ/wD1qaQc76nS3doslst/asj28nQK2Sh9D+uKoVZ0OO7sdSksJ4d0E64kiZlyfQqSeTyDx1pLu0ksrh4ZR8ynGexHqKohjI+ldd4ZkzbyR+hBrkYq6Xw04W4ZP7woBHVKOK5vx9Hu8Fas392zm/8AQDXTAVheN03+BtcA6ixmP/jhoTJkeZeHLO717TtOjJKWsFtEq8dwgGa6+TSI7WFYoo8d/c1ifDS8M1ra2RXIS3VgfbA6/mK7u5T94D6AD880zWOxxU0Oxm44BqnIPmf6VuXsWC59WNY7rjf+FANFJxjrWNEq3XiBuMiPp9f8mtq6bylZj0GKo+H7cOs923LSNwfYf/XzQKxcljwM4rkNfQpepMBkcV2tyMRmuU1yJpIjjtzQFjT2DaCPTNMJpdOzLpcUjctt5PrSN1pNA0Rmqs/3TVo1Vn+6akCi9EZ/eDmnPUaffBpCO80u7l1fTWtnAluI1zbydHXH8Oe4PTnuRWvaX8eu2yQ3Mu27hG1JG4Dj0Y/ng/nWH4UMQdAW2kNuVj0Hrn/Pb61P4gtRo2us8OPKb54+OxP9Dx+FaDZfMTRMVdSpBxg1q6LKIr6LJwCcU2yceIbMTmBI5EGxpI3ySccbl9Kr2hMcqHuDQQeg1i+M/wDkR9e/7B8//otq2QQyhhyCMg1jeMv+RH1//sHT/wDotqhEyPK/BVzNptnZ6pAhkighjS6XuFIHP0+6fqK9ZiCXUMkqOGVgpUjuMZz+teWeE3XTH0l35tru0ijnB6cxjr7cg13VnIfDepCwlY/2bdHNu78+W3dCfx4qzaOwavCqwu4HaudnGE3Y9K7PVYF+zyrjI25FchIM24GOQcH8KCjn9dfZa3PbGz9RV7TrT7JYRRbcYHP1qjrdu1zfQQJ/y3Khh64P+Ga2ieKDMqXY+Suc1FC6sAOororr7hrHukySfagaZR0K7zpzI3WJsEexq64RvmQ9e1ZGiyiLUrq2b+Mfyz/jWq8TQZK8x9vagZC/ANUZjk1cnOY2+lZrNkVBJHIeaYpwaefmBpi9aQjc0q+e2ZSDxmuo1S5i1rTkjRv9Ig+aMqOq/wAQ/kR9CPSuDSUoKtW+rzWjAxvg1SYzsfD815YKZIbqAQvjzY2BLcfh/UVsEICrxNlHG9T/AD/XIrz2PV5RNuAVAeyjArqfD9691DJGzjMeHUH0PDY/Hb+tO4HpumS+bpsDbs8YNUPGX/Ij6/8A9g6f/wBFtS+HHLWTgn7r8UnjL/kR9f8A+wdP/wCi2oM5H//Z + mediaType: image/jpeg + value: '' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetVideoEncoderConfigurations: get: - description: This operation gets basic device information from the device. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDeviceInformation + tags: + - Video Encoder Configuration + summary: VideoEncoderConfigurations + 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. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetVideoEncoderConfigurationsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 1ee4ca7f-fb95-46b3-8e6d-8542b45b22d4 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: a025e1b1-7e2b-4db8-95b6-7dac978e9c97 - origin: 1659672857568971800 profileName: onvif-camera + sourceName: GetVideoEncoderConfigurations + origin: 1659659203023412500 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 3039ffbc-165a-46ef-849b-95c7df9aacfa - objectValue: - FirmwareVersion: 1.1.16 Build 211209 Rel.37726n(4555) - HardwareId: '1.0' - Manufacturer: TP-Link - Model: C200 - SerialNumber: 00c20000 - origin: 1659672857568971800 - profileName: onvif-camera - resourceName: DeviceInformation - value: '' - valueType: Object - sourceName: DeviceInformation - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - FirmwareVersion: - type: string - HardwareId: - type: string - Manufacturer: - type: string - Model: - type: string - SerialNumber: - type: string - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '672' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 04:14:17 GMT - type: string - X-Correlation-Id: - schema: - example: 76d81da0-eba7-4e98-9d92-b60560c20a94 - type: string - summary: DeviceInformation - tags: - - System Function - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DiscoveryMode: - get: - 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. + - id: dd2b4e0e-9a62-49bc-a80b-071d4b1ed8e1 + origin: 1659659203023412500 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetVideoEncoderConfigurations + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Configurations: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_2 + Quality: 3 + RateControl: + BitrateLimit: 256 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 360 + Width: 640 + SessionTimeout: PT0H1M5S + Token: minor + UseCount: 1 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDiscoveryMode + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfiguration: + get: + tags: + - Video Encoder Configuration + summary: VideoEncoderConfiguration + description: |- + If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. + +
+ + **`jsonObject` Schema:** + + _See: [media_GetVideoEncoderConfiguration](#media_GetVideoEncoderConfiguration)_ + + ```yaml + { + "ConfigurationToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + example: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetVideoEncoderConfigurationResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 598079d0-d169-4385-86f3-cb7a106345a5 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 8155efce-41b5-412f-a25d-b63bed015d63 - origin: 1659656339306907600 profileName: onvif-camera + sourceName: VideoEncoderConfiguration + origin: 1659659207626081000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 099efd6b-d5fa-44a3-98f2-67eb72a1659f - objectValue: - DiscoveryMode: Discoverable - origin: 1659656339306907600 - profileName: onvif-camera - resourceName: DiscoveryMode - value: '' - valueType: Object - sourceName: DiscoveryMode - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - DiscoveryMode: - type: string - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '553' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:38:59 GMT - type: string - X-Correlation-Id: - schema: - example: e81b8fb3-4bc4-4aab-a56f-5ff1ed41c123 - type: string - summary: GetDiscoveryMode - tags: - - Auto Discovery - put: - 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. + - id: 86aed436-65cb-4162-b3e6-14def8e4e4d3 + origin: 1659659207626081000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: VideoEncoderConfiguration + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Configuration: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_1 + Quality: 3 + RateControl: + BitrateLimit: 1024 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 1080 + Width: 1920 + SessionTimeout: PT0H1M5S + Token: main + UseCount: 1 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDiscoveryMode - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfiguration + put: + tags: + - Video Encoder Configuration + summary: SetVideoEncoderConfiguration + 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. requestBody: content: application/json: schema: - example: - DiscoveryMode: - DiscoveryMode: Discoverable properties: - DiscoveryMode: - properties: - DiscoveryMode: - type: string - type: object + VideoEncoderConfiguration: + $ref: '#/components/schemas/media_SetVideoEncoderConfiguration' + required: + - VideoEncoderConfiguration type: object + example: + VideoEncoderConfiguration: + ForcePersistence: false + Configuration: + token: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}' + Encoding: H264 + Quality: 3 + Resolution: + Width: 1920 + Height: 1080 + Multicast: + Address: + Type: IPv4 + IPv4Address: 0.0.0.0 + Port: 8860 + TTL: 1 + AutoStart: false + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': + '500': + description: Internal Server Error + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: - example: - apiVersion: v2 - statusCode: 200 schema: - properties: - apiVersion: - type: string - statusCode: - type: number type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:39:15 GMT - type: string - X-Correlation-Id: - schema: - example: 99ed7b8d-81cc-4046-8ac9-ea8dd9013fb2 - type: string - summary: Set DiscoveryMode - tags: - - Auto Discovery - /api/v2/device/name/{EDGEX_DEVICE_NAME}/FriendlyName: + example: + apiVersion: v2 + message: >- + request failed, status code: 500, err: + {"apiVersion":"v2","message":"error writing DeviceResourece + VideoEncoderConfiguration for + TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e + failed to execute write command, \u003cnil\u003e -\u003e + invalid request for the function + 'SetVideoEncoderConfiguration' of web service 'Media'. Onvif + error: fault reason: , fault detail: , fault code: + SOAP-ENV:Sender ","statusCode":500} + statusCode: 500 + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetVideoEncoderConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfigurationOptions: get: - description: This operation is used by an endpoint to get the FriendlyName from - a device. This is a name given to a device by a user to make the device more - identifiable. + tags: + - Video Encoder Configuration + summary: VideoEncoderConfigurationOptions + 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. + +
+ + **`jsonObject` Schema:** + + _See: [media_GetVideoEncoderConfigurationOptions](#media_GetVideoEncoderConfigurationOptions)_ + + ```yaml + { + "ConfigurationToken": "", + "ProfileToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + example: '{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetVideoEncoderConfigurationOptionsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 187b2e94-6efe-421f-b618-186a20fd41df deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 0505a28a-0fd9-41d4-8044-784cc089894b - origin: 1659657288410588400 profileName: onvif-camera + sourceName: VideoEncoderConfigurationOptions + origin: 1659659212171416600 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 2d0def92-9e38-46bd-a72f-b512be4d5345 - origin: 1659657288410588400 - profileName: onvif-camera - resourceName: FriendlyName - value: TP-Link C200 - valueType: String - sourceName: FriendlyName - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object + - id: 0b709715-f644-4cf0-a477-dcc3b5ef218c + origin: 1659659212171416600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: VideoEncoderConfigurationOptions + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Options: + Extension: + H264: + BitrateRange: + Max: 1024 + Min: 256 + EncodingIntervalRange: + Max: 1 + Min: 1 + FrameRateRange: + Max: 15 + Min: 1 + GovLengthRange: + Max: 25 + Min: 25 + H264ProfilesSupported: + - Main + ResolutionsAvailable: + - Height: 1080 + Width: 1920 + - Height: 720 + Width: 1280 + - Height: 360 + Width: 640 + H264: + EncodingIntervalRange: + Max: 1 + Min: 1 + FrameRateRange: + Max: 15 + Min: 1 + GovLengthRange: + Max: 25 + Min: 25 + H264ProfilesSupported: + - Main + ResolutionsAvailable: + - Height: 1080 + Width: 1920 + - Height: 720 + Width: 1280 + - Height: 360 + Width: 640 + QualityRange: + Max: 5 + Min: 1 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurationOptions + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Users: + get: + tags: + - User Handling + summary: Get users + 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. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': description: OK headers: - Content-Length: - schema: - example: '516' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:54:48 GMT - type: string X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: f8f02197-312e-4c53-99d0-a34edc96c768 - type: string - summary: Get FriendlyName + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetUsersResponse' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 8e524ecd-674d-4dd8-b728-de78b8245189 + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + profileName: onvif-camera + sourceName: Users + origin: 1664077238993899500 + readings: + - id: f5086b88-9876-4627-91d5-7ce39431652e + origin: 1664077238993899500 + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + resourceName: Users + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + User: + - UserLevel: Administrator + Username: admin + - UserLevel: User + Username: user + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetUsers + put: tags: - - Custom + - User Handling + summary: Set users + 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. + requestBody: + content: + application/json: + schema: + properties: + Users: + $ref: '#/components/schemas/device_SetUser' + required: + - Users + type: object + example: + Users: + User: + - Username: user1 + Password: Password1! + UserLevel: Administrator + - Username: user2 + Password: Password1! + UserLevel: Operator + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetUser + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateUsers: put: - description: This operation is used by an endpoint to set the FriendlyName of - a device. This is a name given to a device by a user to make the device more - identifiable. + tags: + - User Handling + summary: Create Users + 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. + requestBody: + content: + application/json: + schema: + properties: + CreateUsers: + $ref: '#/components/schemas/device_CreateUsers' + required: + - CreateUsers + type: object + example: + CreateUsers: + User: + - Username: user1 + Password: Password1! + UserLevel: User + - Username: user2 + Password: Password1! + UserLevel: User parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.CreateUsers + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteUsers: + put: + tags: + - User Handling + summary: Delete users + 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. requestBody: content: application/json: schema: - example: - FriendlyName: - FriendlyName: My Camera properties: - FriendlyName: - properties: - FriendlyName: - type: string - type: object + DeleteUsers: + $ref: '#/components/schemas/device_DeleteUsers' + required: + - DeleteUsers type: object + example: + DeleteUsers: + Username: + - user1 + - user2 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.DeleteUsers + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DiscoveryMode: + get: + tags: + - Auto Discovery + summary: GetDiscoveryMode + 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. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetDiscoveryModeResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:55:01 GMT - type: string - X-Correlation-Id: - schema: - example: 9ed55755-1b15-4352-affe-b6d105e73e0c - type: string - summary: Set FriendlyName - tags: - - Custom - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetAnalyticsConfigurations: - get: - 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. - externalDocs: + event: + apiVersion: v2 + id: 8155efce-41b5-412f-a25d-b63bed015d63 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: DiscoveryMode + origin: 1659656339306907600 + readings: + - id: 099efd6b-d5fa-44a3-98f2-67eb72a1659f + origin: 1659656339306907600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: DiscoveryMode + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + DiscoveryMode: Discoverable + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.GetAnalyticsConfigurations + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDiscoveryMode + put: + tags: + - Auto Discovery + summary: Set DiscoveryMode + 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. + requestBody: + content: + application/json: + schema: + properties: + DiscoveryMode: + $ref: '#/components/schemas/device_SetDiscoveryMode' + required: + - DiscoveryMode + type: object + example: + DiscoveryMode: + DiscoveryMode: Discoverable parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '500': - content: - application/json: - example: - apiVersion: v2 - message: 'request failed, status code: 500, err: {"apiVersion":"v2","message":"error - reading DeviceResourece GetAnalyticsConfigurations for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - -\u003e failed to execute read command -\u003e invalid request for - the function ''GetAnalyticsConfigurations'' of web service ''Media2''. - Onvif error: fault reason: Method ''tr2:GetAnalyticsConfigurations'' - not implemented: method name or namespace not recognized, fault - detail: , fault code: SOAP-ENV:Sender ","statusCode":500}' - statusCode: 500 - schema: - properties: - apiVersion: - type: string - message: - type: string - statusCode: - type: number - type: object - description: Internal Server Error - headers: - Content-Length: - schema: - example: '565' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 03:58:29 GMT - type: string - X-Correlation-Id: - schema: - example: dc78312b-f01c-49f3-9a48-8ceb07b07a15 - type: string - summary: GetAnalyticsConfigurations + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDiscoveryMode + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddScopes: + put: tags: - - Analytics - Profile Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetAnalyticsModuleOptions: - get: - description: Return the options for the supported analytics modules that specify - an Option attribute. + - Auto Discovery + summary: Add Scopes + 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. + requestBody: + content: + application/json: + schema: + properties: + AddScopes: + $ref: '#/components/schemas/device_AddScopes' + required: + - AddScopes + type: object + example: + AddScopes: + ScopeItem: + - http//:123 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetAnalyticsModuleOptions + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.AddScopes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Scopes: + get: + tags: + - Auto Discovery + summary: Get Scopes + 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. parameters: - - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetScopesResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 460b6e4f-88d7-476d-ab9c-d46c5f656124 - origin: 1665460132225688000 + id: 05f573f4-0836-45ad-b9ba-c393f9927586 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera + sourceName: Scopes + origin: 1659659228090509000 readings: - - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 42a9e19c-82f6-4552-9f1d-459bfc55600a - objectValue: - Options: - - IntRange: - Max: 100 - Min: 0 - Name: Sensitivity - Type: tt:IntRange - origin: 1665460132225688000 - profileName: onvif-camera - resourceName: GetAnalyticsModuleOptions - value: '' - valueType: Object - sourceName: GetAnalyticsModuleOptions - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Options: - items: - properties: - IntRange: - properties: - Max: - type: number - Min: - type: number - type: object - Name: - type: string - Type: - type: string - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '639' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:48:52 GMT - type: string - X-Correlation-Id: - schema: - example: 52340a61-2358-4d2b-be02-25cbe079baa6 - type: string - summary: GetAnalyticsModuleOptions + - id: ea858652-cb16-432c-bf45-f9785cd00d85 + origin: 1659659228090509000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: Scopes + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Scopes: + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/name/TP-IPC + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/hardware/MODEL + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/Profile/Streaming + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/location/ShenZhen + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/type/NetworkVideoTransmitter + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetScopes + put: tags: - - Analytics - Modules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetConfigurationOptions: - get: - 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. + - Auto Discovery + summary: Put Scopes + 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. + requestBody: + content: + application/json: + schema: + properties: + Scopes: + $ref: '#/components/schemas/device_SetScopes' + required: + - Scopes + type: object + example: + Scopes: + Scopes: + - http//:123 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetConfigurationOptions + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetScopes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveScopes: + put: + tags: + - Auto Discovery + summary: Remove Scopes + 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 + requestBody: + content: + application/json: + schema: + properties: + RemoveScopes: + $ref: '#/components/schemas/device_RemoveScopes' + required: + - RemoveScopes + type: object + example: + RemoveScopes: + ScopeItem: + - onvif://www.onvif.org/name/Geovision parameters: - - description: '{"ConfigurationToken": "PTZConfiguration0"}' - example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': + '500': + description: Internal Server Error + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 418fbbf5-6628-4033-8d7b-0811968dcee8 - origin: 1659671766926306000 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 7ceb7891-b7af-4cfe-9bbb-2d0fb3bead14 - objectValue: - PTZConfigurationOptions: - PTZTimeout: - Max: PT0H0M20S - Min: PT0H0M20S - Spaces: - AbsolutePanTiltPositionSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - AbsoluteZoomPositionSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - ContinuousPanTiltVelocitySpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - XRange: - Max: 1 - Min: -1 - YRange: - Max: 1 - Min: -1 - ContinuousZoomVelocitySpace: - URI: '' - XRange: - Max: 0 - Min: 0 - Extension: '' - PanTiltSpeedSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace - XRange: - Max: 0 - Min: 0 - RelativePanTiltTranslationSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - RelativeZoomTranslationSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - ZoomSpeedSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - origin: 1659671766926306000 - profileName: onvif-camera - resourceName: GetConfigurationOptions - value: '' - valueType: Object - sourceName: GetConfigurationOptions - statusCode: 200 schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - PTZConfigurationOptions: - properties: - PTZTimeout: - properties: - Max: - type: string - Min: - type: string - type: object - Spaces: - properties: - AbsolutePanTiltPositionSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - AbsoluteZoomPositionSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ContinuousPanTiltVelocitySpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ContinuousZoomVelocitySpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - Extension: - type: string - PanTiltSpeedSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - RelativePanTiltTranslationSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - RelativeZoomTranslationSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ZoomSpeedSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number type: object - description: OK - headers: - Content-Length: - schema: - example: '1538' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 03:56:06 GMT - type: string - X-Correlation-Id: - schema: - example: 6b954ddf-abe0-4ba7-b761-22a99aa13e96 - type: string - summary: GetConfigurationOptions - tags: - - PTZ - Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetConfigurations: - get: - 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.' + example: + apiVersion: v2 + message: >- + request failed, status code: 500, err: + {"apiVersion":"v2","message":"error writing DeviceResourece + RemoveScopes for + Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 -\u003e + failed to execute write command, \u003cnil\u003e -\u003e + invalid request for the function 'RemoveScopes' of web service + 'Device'. Onvif error: fault reason: Trying to Remove scope + which does not exist, fault detail: , fault code: s:Sender + ter:InvalidArgVal ter:NoScope","statusCode":500} + statusCode: 500 + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetConfigurations + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.RemoveScopes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetNodes: + get: + tags: + - PTZ - Capabilities + summary: GetNodes + 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. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetNodesResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: dfe1b38e-1590-43c4-ab12-432ed5219476 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: b46d0e1e-f173-4bf0-8e35-984395952b09 - origin: 1659656376998679000 profileName: onvif-camera + sourceName: GetNodes + origin: 1659656363928092200 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: edf84087-d700-4967-bf5a-3e76e3c8ec18 - objectValue: - PTZConfiguration: - - DefaultAbsolutePantTiltPositionSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - DefaultContinuousPanTiltVelocitySpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - DefaultPTZSpeed: {} - DefaultPTZTimeout: PT0H0M20S - DefaultRelativePanTiltTranslationSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - PanTiltLimits: - Range: - URI: '' - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: PTZConfiguration0 - origin: 1659656376998679000 - profileName: onvif-camera - resourceName: GetConfigurations - value: '' - valueType: Object - sourceName: GetConfigurations - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - PTZConfiguration: - items: - properties: - DefaultAbsolutePantTiltPositionSpace: - type: string - DefaultContinuousPanTiltVelocitySpace: - type: string - DefaultPTZSpeed: - properties: {} - type: object - DefaultPTZTimeout: - type: string - DefaultRelativePanTiltTranslationSpace: - type: string - PanTiltLimits: - properties: - Range: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - Token: - type: string - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1063' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:39:36 GMT - type: string - X-Correlation-Id: - schema: - example: d7a9c8e5-2ee2-4088-abe5-6ee8e51ebb1f - type: string - summary: GetConfigurations - tags: - - PTZ - Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetEventProperties: - get: - 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. + - id: a47fe9e2-b007-4b5e-891b-3d50062b468f + origin: 1659656363928092200 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetNodes + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + PTZNode: + - HomeSupported: true + Name: Node0 + SupportedPTZSpaces: + AbsolutePanTiltPositionSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + AbsoluteZoomPositionSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + ContinuousPanTiltVelocitySpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + XRange: + Max: 1 + Min: -1 + YRange: + Max: 1 + Min: -1 + ContinuousZoomVelocitySpace: + URI: '' + XRange: + Max: 0 + Min: 0 + Extension: '' + PanTiltSpeedSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace + XRange: + Max: 0 + Min: 0 + RelativePanTiltTranslationSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + RelativeZoomTranslationSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + ZoomSpeedSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + Token: Node0 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/events/wsdl/event.wsdl#op.GetEventProperties + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetNodes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetNode: + get: + tags: + - PTZ - Capabilities + summary: GetNode + description: |- + Get a specific PTZ Node identified by a reference token or a name. + +
+ + **`jsonObject` Schema:** + + _See: [ptz_GetNode](#ptz_GetNode)_ + + ```yaml + { + "NodeToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + description: '{"NodeToken": "Node0"}' + example: eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ== + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetNodeResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 713edf3b-f049-456b-8f3b-4a2dccca683f deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 925ca37f-2ed6-43f9-b9e3-4c31849325b7 - origin: 1659659240585563600 profileName: onvif-camera + sourceName: GetNode + origin: 1659656370279599600 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: dc1e5896-00d9-4e4d-85f7-2dbca9a4b8cb - objectValue: - FixedTopicSet: true - MessageContentFilterDialect: http://www.onvif.org/ver10/tev/messageContentFilter/ItemFilter - MessageContentSchemaLocation: http://www.onvif.org/onvif/ver10/schema/onvif.xsd - TopicExpressionDialect: http://docs.oasis-open.org/wsn/t-1/TopicExpression/Concrete - TopicNamespaceLocation: http://www.onvif.org/onvif/ver10/topics/topicns.xml - TopicSet: - tns1:RuleEngine: - '#seq': 0 - CellMotionDetector: - '#seq': 0 - Motion: - '#attr': - wstop:topic: - '#seq': 0 - '#text': 'true' - '#seq': 0 - tt:MessageDescription: - '#attr': - IsProperty: - '#seq': 0 - '#text': 'true' - '#seq': 0 - tt:Data: - '#seq': 1 - tt:SimpleItemDescription: - '#attr': - Name: - '#seq': 1 - '#text': IsMotion - Type: - '#seq': 0 - '#text': xsd:boolean - '#seq': 0 - tt:Source: - '#seq': 0 - tt:SimpleItemDescription: - - '#attr': - Name: - '#seq': 1 - '#text': VideoSourceConfigurationToken - Type: - '#seq': 0 - '#text': tt:ReferenceToken - '#seq': 0 - - '#attr': - Name: - '#seq': 1 - '#text': VideoAnalyticsConfigurationToken - Type: - '#seq': 0 - '#text': tt:ReferenceToken - '#seq': 1 - - '#attr': - Name: - '#seq': 1 - '#text': Rule - Type: - '#seq': 0 - '#text': xsd:string - '#seq': 2 - TamperDetector: - '#seq': 1 - Tamper: - '#attr': - wstop:topic: - '#seq': 0 - '#text': 'true' - '#seq': 0 - tt:MessageDescription: - '#attr': - IsProperty: - '#seq': 0 - '#text': 'true' - '#seq': 0 - tt:Data: - '#seq': 1 - tt:SimpleItemDescription: - '#attr': - Name: - '#seq': 1 - '#text': IsTamper - Type: - '#seq': 0 - '#text': xsd:boolean - '#seq': 0 - tt:Source: - '#seq': 0 - tt:SimpleItemDescription: - - '#attr': - Name: - '#seq': 1 - '#text': VideoSourceConfigurationToken - Type: - '#seq': 0 - '#text': tt:ReferenceToken - '#seq': 0 - - '#attr': - Name: - '#seq': 1 - '#text': VideoAnalyticsConfigurationToken - Type: - '#seq': 0 - '#text': tt:ReferenceToken - '#seq': 1 - - '#attr': - Name: - '#seq': 1 - '#text': Rule - Type: - '#seq': 0 - '#text': xsd:string - '#seq': 2 - origin: 1659659240585563600 - profileName: onvif-camera - resourceName: GetEventProperties - value: '' - valueType: Object - sourceName: GetEventProperties - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - FixedTopicSet: - type: boolean - MessageContentFilterDialect: - type: string - MessageContentSchemaLocation: - type: string - TopicExpressionDialect: - type: string - TopicNamespaceLocation: - type: string - TopicSet: - properties: - tns1:RuleEngine: - properties: - '#seq': - type: number - CellMotionDetector: - properties: - '#seq': - type: number - Motion: - properties: - '#attr': - properties: - wstop:topic: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - tt:MessageDescription: - properties: - '#attr': - properties: - IsProperty: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - tt:Data: - properties: - '#seq': - type: number - tt:SimpleItemDescription: - properties: - '#attr': - properties: - Name: - properties: - '#seq': - type: number - '#text': - type: string - type: object - Type: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - type: object - type: object - tt:Source: - properties: - '#seq': - type: number - tt:SimpleItemDescription: - items: - properties: - '#attr': - properties: - Name: - properties: - '#seq': - type: number - '#text': - type: string - type: object - Type: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - required: - - '#attr' - - '#seq' - type: object - type: array - type: object - type: object - type: object - type: object - TamperDetector: - properties: - '#seq': - type: number - Tamper: - properties: - '#attr': - properties: - wstop:topic: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - tt:MessageDescription: - properties: - '#attr': - properties: - IsProperty: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - tt:Data: - properties: - '#seq': - type: number - tt:SimpleItemDescription: - properties: - '#attr': - properties: - Name: - properties: - '#seq': - type: number - '#text': - type: string - type: object - Type: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - type: object - type: object - tt:Source: - properties: - '#seq': - type: number - tt:SimpleItemDescription: - items: - properties: - '#attr': - properties: - Name: - properties: - '#seq': - type: number - '#text': - type: string - type: object - Type: - properties: - '#seq': - type: number - '#text': - type: string - type: object - type: object - '#seq': - type: number - required: - - '#attr' - - '#seq' - type: object - type: array - type: object - type: object - type: object - type: object - type: object - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:27:20 GMT - type: string - Transfer-Encoding: - schema: - example: chunked - type: string - X-Correlation-Id: - schema: - example: 4ddb3f14-46d5-43b5-9c36-220b5ae53545 - type: string - summary: GetEventProperties - tags: - - Event Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetNode: - get: - description: Get a specific PTZ Node identified by a reference token or a name. + - id: 42af41ee-f72d-4f0c-95cf-0e8326f6d154 + origin: 1659656370279599600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetNode + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + PTZNode: + HomeSupported: true + Name: Node0 + SupportedPTZSpaces: + AbsolutePanTiltPositionSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + AbsoluteZoomPositionSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + ContinuousPanTiltVelocitySpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + XRange: + Max: 1 + Min: -1 + YRange: + Max: 1 + Min: -1 + ContinuousZoomVelocitySpace: + URI: '' + XRange: + Max: 0 + Min: 0 + Extension: '' + PanTiltSpeedSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace + XRange: + Max: 0 + Min: 0 + RelativePanTiltTranslationSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + RelativeZoomTranslationSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + ZoomSpeedSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + Token: Node0 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetNode + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetConfigurations: + get: + tags: + - PTZ - Configuration + summary: GetConfigurations + 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. parameters: - - description: '{"NodeToken": "Node0"}' - example: eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ== - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetConfigurationsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: b46d0e1e-f173-4bf0-8e35-984395952b09 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 713edf3b-f049-456b-8f3b-4a2dccca683f - origin: 1659656370279599600 profileName: onvif-camera + sourceName: GetConfigurations + origin: 1659656376998679000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 42af41ee-f72d-4f0c-95cf-0e8326f6d154 - objectValue: - PTZNode: - HomeSupported: true - Name: Node0 - SupportedPTZSpaces: - AbsolutePanTiltPositionSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - AbsoluteZoomPositionSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - ContinuousPanTiltVelocitySpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - XRange: - Max: 1 - Min: -1 - YRange: - Max: 1 - Min: -1 - ContinuousZoomVelocitySpace: - URI: '' - XRange: - Max: 0 - Min: 0 - Extension: '' - PanTiltSpeedSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace - XRange: - Max: 0 - Min: 0 - RelativePanTiltTranslationSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - RelativeZoomTranslationSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - ZoomSpeedSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - Token: Node0 - origin: 1659656370279599600 - profileName: onvif-camera - resourceName: GetNode - value: '' - valueType: Object - sourceName: GetNode - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - PTZNode: - properties: - HomeSupported: - type: boolean - Name: - type: string - SupportedPTZSpaces: - properties: - AbsolutePanTiltPositionSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - AbsoluteZoomPositionSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ContinuousPanTiltVelocitySpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ContinuousZoomVelocitySpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - Extension: - type: string - PanTiltSpeedSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - RelativePanTiltTranslationSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - RelativeZoomTranslationSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ZoomSpeedSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - Token: - type: string - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1503' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:39:30 GMT - type: string - X-Correlation-Id: - schema: - example: 16c90e5b-0360-4dad-b48e-d8faf485d9e7 - type: string - summary: GetNode - tags: - - PTZ - Capabilities - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetNodes: + - id: edf84087-d700-4967-bf5a-3e76e3c8ec18 + origin: 1659656376998679000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetConfigurations + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + PTZConfiguration: + - DefaultAbsolutePantTiltPositionSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + DefaultContinuousPanTiltVelocitySpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + DefaultPTZSpeed: {} + DefaultPTZTimeout: PT0H0M20S + DefaultRelativePanTiltTranslationSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + PanTiltLimits: + Range: + URI: '' + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + Token: PTZConfiguration0 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Configuration: get: - description: 'Get the descriptions of the available PTZ Nodes. + tags: + - PTZ - Configuration + summary: GetConfiguration + 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. - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetNodes + 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. + +
+ + **`jsonObject` Schema:** + + _See: [ptz_GetConfiguration](#ptz_GetConfiguration)_ + + ```yaml + { + "PTZConfigurationToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + description: '{"PTZConfigurationToken": "PTZConfiguration0"}' + example: eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetConfigurationResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 13f39ebb-cde4-4d99-bbc2-b207c4a40ca3 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: dfe1b38e-1590-43c4-ab12-432ed5219476 - origin: 1659656363928092200 profileName: onvif-camera + sourceName: Configuration + origin: 1659656383599131400 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: a47fe9e2-b007-4b5e-891b-3d50062b468f - objectValue: - PTZNode: - - HomeSupported: true - Name: Node0 - SupportedPTZSpaces: - AbsolutePanTiltPositionSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - AbsoluteZoomPositionSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - ContinuousPanTiltVelocitySpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - XRange: - Max: 1 - Min: -1 - YRange: - Max: 1 - Min: -1 - ContinuousZoomVelocitySpace: - URI: '' - XRange: - Max: 0 - Min: 0 - Extension: '' - PanTiltSpeedSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace - XRange: - Max: 0 - Min: 0 - RelativePanTiltTranslationSpace: - URI: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - RelativeZoomTranslationSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - ZoomSpeedSpace: - URI: '' - XRange: - Max: 0 - Min: 0 - Token: Node0 - origin: 1659656363928092200 - profileName: onvif-camera - resourceName: GetNodes - value: '' - valueType: Object - sourceName: GetNodes - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - PTZNode: - items: - properties: - HomeSupported: - type: boolean - Name: - type: string - SupportedPTZSpaces: - properties: - AbsolutePanTiltPositionSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - AbsoluteZoomPositionSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ContinuousPanTiltVelocitySpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ContinuousZoomVelocitySpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - Extension: - type: string - PanTiltSpeedSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - RelativePanTiltTranslationSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - RelativeZoomTranslationSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - ZoomSpeedSpace: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - Token: - type: string - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1507' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:39:23 GMT - type: string - X-Correlation-Id: - schema: - example: b44d79fd-24db-4fa1-b85d-686031dd94ea - type: string - summary: GetNodes + - id: 3a5e5c97-268a-4c84-ae79-f51ada66889e + origin: 1659656383599131400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: Configuration + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + PTZConfiguration: + DefaultAbsolutePantTiltPositionSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + DefaultContinuousPanTiltVelocitySpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + DefaultPTZSpeed: {} + DefaultPTZTimeout: PT0H0M20S + DefaultRelativePanTiltTranslationSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + PanTiltLimits: + Range: + URI: '' + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + Token: PTZConfiguration0 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetConfiguration + put: tags: - - PTZ - Capabilities - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetPresets: - get: - 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. + - PTZ - Configuration + summary: SetConfiguration + description: Set/update a existing PTZConfiguration on the device. + requestBody: + content: + application/json: + schema: + properties: + Configuration: + $ref: '#/components/schemas/ptz_SetConfiguration' + required: + - Configuration + type: object + example: + Configuration: + PTZConfiguration: + Token: '{{PTZ_CONFIG_TOKEN}}' + NodeToken: '{{PTZ_NODE_TOKEN}}' + PanTiltLimits: + Range: + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetPresets + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SetConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetConfigurationOptions: + get: + tags: + - PTZ - Configuration + summary: GetConfigurationOptions + 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. + +
+ + **`jsonObject` Schema:** + + _See: [ptz_GetConfigurationOptions](#ptz_GetConfigurationOptions)_ + + ```yaml + { + "ConfigurationToken": "" + } + ``` parameters: - - description: '{"ProfileToken":"profile_1"}' - example: '{{PTZ_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + description: '{"ConfigurationToken": "PTZConfiguration0"}' + example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetConfigurationOptionsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 418fbbf5-6628-4033-8d7b-0811968dcee8 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 79dde7e3-9730-4d33-aa9f-48e499b23207 - origin: 1659659260936957200 profileName: onvif-camera + sourceName: GetConfigurationOptions + origin: 1659671766926306000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 5816a933-ec39-4c58-b8cf-aa3fc8dcbd19 - objectValue: - Preset: - - Name: Marked Position 2 - PTZPosition: - PanTilt: - Space: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - X: 169 - Y: -5 - Token: Preset2 - - Name: Marked Position 3 - PTZPosition: - PanTilt: - Space: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - X: 115 - Y: 13 - Token: Preset3 - - Name: preset4 - PTZPosition: - PanTilt: - Space: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - X: 134 - Y: 13 - Token: Preset4 - origin: 1659659260936957200 - profileName: onvif-camera - resourceName: GetPresets - value: '' - valueType: Object - sourceName: GetPresets - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Preset: - items: - properties: - Name: - type: string - PTZPosition: - properties: - PanTilt: - properties: - Space: - type: string - X: - type: number - Y: - type: number - type: object - type: object - Token: - type: string - required: - - Name - - PTZPosition - - Token - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1018' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:27:40 GMT - type: string - X-Correlation-Id: - schema: - example: 25e64454-55f1-4448-94b3-ec8487bc4cbe - type: string - summary: GetPresets - tags: - - PTZ - Preset - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetRuleOptions: - get: - description: Return the options for the supported rules that specify an Option - attribute. + - id: 7ceb7891-b7af-4cfe-9bbb-2d0fb3bead14 + origin: 1659671766926306000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetConfigurationOptions + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + PTZConfigurationOptions: + PTZTimeout: + Max: PT0H0M20S + Min: PT0H0M20S + Spaces: + AbsolutePanTiltPositionSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + AbsoluteZoomPositionSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + ContinuousPanTiltVelocitySpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + XRange: + Max: 1 + Min: -1 + YRange: + Max: 1 + Min: -1 + ContinuousZoomVelocitySpace: + URI: '' + XRange: + Max: 0 + Min: 0 + Extension: '' + PanTiltSpeedSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/GenericSpeedSpace + XRange: + Max: 0 + Min: 0 + RelativePanTiltTranslationSpace: + URI: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + RelativeZoomTranslationSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + ZoomSpeedSpace: + URI: '' + XRange: + Max: 0 + Min: 0 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetRuleOptions + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetConfigurationOptions + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddPTZConfiguration: + put: + tags: + - PTZ - Configuration + summary: AddPTZConfiguration + description: Add a new PTZConfiguration on the device. + requestBody: + content: + application/json: + schema: + properties: + AddPTZConfiguration: + $ref: '#/components/schemas/media_AddPTZConfiguration' + required: + - AddPTZConfiguration + type: object + example: + AddPTZConfiguration: + ProfileToken: '{{MEDIA_PROFILE}}' + ConfigurationToken: '{{PTZ_CONFIG_TOKEN}}' parameters: - - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: bf7a5fc7-7523-4690-87b7-273b2a373ed3 - origin: 1665460126357157600 - profileName: onvif-camera - readings: - - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 2bdd1ff4-7d2a-441b-bbc3-dfa50c27b096 - objectValue: - RuleOptions: - - MotionRegionConfigOptions: - DisarmSupport: false - PolygonLimits: - Max: 0 - Min: 0 - PolygonSupport: false - Name: MotionRegion - Type: axt:MotionRegionConfigOptions - origin: 1665460126357157600 - profileName: onvif-camera - resourceName: GetRuleOptions - value: '' - valueType: Object - sourceName: GetRuleOptions - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - RuleOptions: - items: - properties: - MotionRegionConfigOptions: - properties: - DisarmSupport: - type: boolean - PolygonLimits: - properties: - Max: - type: number - Min: - type: number - type: object - PolygonSupport: - type: boolean - type: object - Name: - type: string - Type: - type: string - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '718' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:48:46 GMT - type: string - X-Correlation-Id: - schema: - example: 463ddd87-95fc-46f3-bdd7-d05ed5a94fd8 - type: string - summary: GetRuleOptions - tags: - - Analytics - Rules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetStatus: - get: - description: Operation to request PTZ status for the Node in the selected profile. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetStatus + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.AddPTZConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemovePTZConfiguration: + put: + tags: + - PTZ - Configuration + summary: RemovePTZConfiguration + description: Remove a PTZConfiguration on the device. + requestBody: + content: + application/json: + schema: + properties: + RemovePTZConfiguration: + $ref: '#/components/schemas/media_RemovePTZConfiguration' + required: + - RemovePTZConfiguration + type: object + example: + RemovePTZConfiguration: + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' parameters: - - description: '{"ProfileToken":"profile_1"}' - example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: c8ad64b4-db58-4c9b-9896-82fff02544c9 - origin: 1659659252963492000 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 71444c1c-9e85-4852-9c1e-9bd9eba8d616 - objectValue: - PTZStatus: - MoveStatus: - PanTilt: IDLE - Position: - PanTilt: - Space: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - X: 82 - Y: -5 - UtcTime: '2022-08-05T00:27:32Z' - origin: 1659659252963492000 - profileName: onvif-camera - resourceName: GetStatus - value: '' - valueType: Object - sourceName: GetStatus - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - PTZStatus: - properties: - MoveStatus: - properties: - PanTilt: - type: string - type: object - Position: - properties: - PanTilt: - properties: - Space: - type: string - X: - type: number - Y: - type: number - type: object - type: object - UtcTime: - type: string - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '709' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:27:32 GMT - type: string - X-Correlation-Id: - schema: - example: 53763243-40d8-4d96-a2ae-97f77f2550e0 - type: string - summary: GetStatus - tags: - - PTZ - Actuation - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetSupportedAnalyticsModules: - get: - description: List all analytics modules that are supported by the given VideoAnalyticsConfiguration. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetSupportedAnalyticsModules + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.RemovePTZConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AbsoluteMove: + put: + tags: + - PTZ - Actuation + summary: AbsoluteMove + 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. + requestBody: + content: + application/json: + schema: + properties: + AbsoluteMove: + $ref: '#/components/schemas/ptz_AbsoluteMove' + required: + - AbsoluteMove + type: object + example: + AbsoluteMove: + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + Position: + PanTilt: + x: 0 + y: 0 parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: {} - description: Successful response - summary: GetSupportedAnalyticsModules - tags: - - Analytics - Modules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetSupportedRules: - get: - description: List all rules that are supported by the given VideoAnalyticsConfiguration. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetSupportedRules + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.AbsoluteMove + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RelativeMove: + put: + tags: + - PTZ - Actuation + summary: RelativeMove + 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. + requestBody: + content: + application/json: + schema: + properties: + RelativeMove: + $ref: '#/components/schemas/ptz_RelativeMove' + required: + - RelativeMove + type: object + example: + RelativeMove: + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + Translation: + PanTilt: + x: 0 + y: 0 parameters: - - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 4694424b-74bb-45ee-a014-ebb6d09855f9 - origin: 1665460098832568300 - profileName: onvif-camera - readings: - - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 155dc49e-caa7-492c-be74-0cf150ca2302 - objectValue: - SupportedRules: - RuleContentSchemaLocation: http://www.w3.org/2001/XMLSchema - RuleDescription: - - Fixed: false - MaxInstances: 10 - Messages: - Data: - SimpleItemDescription: - - Name: IsMotion - Type: xs:boolean - IsProperty: true - ParentTopic: tns1:RuleEngine/CellMotionDetector/Motion - Source: - SimpleItemDescription: - - Name: VideoSourceConfigurationToken - Type: tt:ReferenceToken - - Name: VideoAnalyticsConfigurationToken - Type: tt:ReferenceToken - - Name: Rule - Type: xs:string - Name: tt:CellMotionDetector - Parameters: - SimpleItemDescription: - - Name: MinCount - Type: xs:integer - - Name: AlarmOnDelay - Type: xs:integer - - Name: AlarmOffDelay - Type: xs:integer - - Name: ActiveCells - Type: xs:base64Binary - - Fixed: false - MaxInstances: 10 - Messages: - Data: - SimpleItemDescription: - - Name: State - Type: xs:boolean - IsProperty: true - ParentTopic: tns1:RuleEngine/MotionRegionDetector/Motion - Source: - SimpleItemDescription: - - Name: VideoSource - Type: tt:ReferenceToken - - Name: RuleName - Type: xs:string - Name: tt:MotionRegionDetector - Parameters: - ElementItemDescription: - - Name: MotionRegion - - Fixed: false - MaxInstances: 1 - Messages: - Data: - ElementItemDescription: - - Name: Image - - Name: BoundingBox - SimpleItemDescription: - - Name: Likelihood - Type: xs:float - - Name: Label - Type: xs:string - - Name: ImageUri - Type: xs:anyURI - - Name: EnrollmentID - Type: xs:string - - Name: RefImageUri - Type: xs:anyURI - IsProperty: true - ParentTopic: tns1:RuleEngine/Recognition/Face - Source: - SimpleItemDescription: - - Name: VideoSource - Type: tt:ReferenceToken - - Name: AnalyticsConfiguration - Type: tt:ReferenceToken - - Name: Rule - Type: xs:string - Name: tt:FaceRecognition - Parameters: - SimpleItemDescription: - - Name: IncludeImage - Type: xs:string - - Fixed: false - MaxInstances: 1 - Messages: - Data: - ElementItemDescription: - - Name: BoundingBox - - Name: Image - - Name: LicensePlateInfo - - Name: VehicleInfo - - Name: VehicleImage - SimpleItemDescription: - - Name: Likelihood - Type: xs:float - - Name: Label - Type: xs:string - - Name: ImageUri - Type: xs:anyURI - - Name: VehicleImageURI - Type: xs:anyURI - IsProperty: true - ParentTopic: tns1:RuleEngine/Recognition/LicensePlate - Source: - SimpleItemDescription: - - Name: VideoSource - Type: tt:ReferenceToken - - Name: AnalyticsConfiguration - Type: tt:ReferenceToken - - Name: Rule - Type: xs:string - Name: tt:LicensePlateRecognition - Parameters: - ElementItemDescription: - - Name: Region - - Name: SnapLine - SimpleItemDescription: - - Name: IncludeImage - Type: xs:string - - Name: PlateLocation - Type: xs:string - - Fixed: false - MaxInstances: 1 - Messages: - Data: - SimpleItemDescription: - - Name: Count - Type: xs:int - IsProperty: true - ParentTopic: tns1:RuleEngine/CountAggregation/Counter - Source: - SimpleItemDescription: - - Name: VideoSource - Type: tt:ReferenceToken - - Name: AnalyticsConfiguration - Type: tt:ReferenceToken - - Name: Rule - Type: xs:string - Name: tt:LineCounting - Parameters: - ElementItemDescription: - - Name: Segments - SimpleItemDescription: - - Name: ReportTimeInterval - Type: xs:duration - - Name: ResetTime - Type: xs:time - - Name: Direction - Type: tt:Direction - - Name: PassAllPolylines - Type: xs:boolean - origin: 1665460098832568300 - profileName: onvif-camera - resourceName: GetSupportedRules - value: '' - valueType: Object - sourceName: GetSupportedRules - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - SupportedRules: - properties: - RuleContentSchemaLocation: - type: string - RuleDescription: - items: - properties: - Fixed: - type: boolean - MaxInstances: - type: number - Messages: - properties: - Data: - properties: - ElementItemDescription: - items: - properties: - Name: - type: string - required: - - Name - type: object - type: array - SimpleItemDescription: - items: - properties: - Name: - type: string - Type: - type: string - required: - - Name - - Type - type: object - type: array - type: object - IsProperty: - type: boolean - ParentTopic: - type: string - Source: - properties: - SimpleItemDescription: - items: - properties: - Name: - type: string - Type: - type: string - required: - - Name - - Type - type: object - type: array - type: object - type: object - Name: - type: string - Parameters: - properties: - ElementItemDescription: - items: - properties: - Name: - type: string - required: - - Name - type: object - type: array - SimpleItemDescription: - items: - properties: - Name: - type: string - Type: - type: string - required: - - Name - - Type - type: object - type: array - type: object - required: - - Fixed - - MaxInstances - - Messages - - Name - - Parameters - type: object - type: array - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:48:18 GMT - type: string - Transfer-Encoding: - schema: - example: chunked - type: string - X-Correlation-Id: - schema: - example: 9c7bcb9a-4316-4905-a08d-abfe644ce0fb - type: string - summary: GetSupportedRules + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.RelativeMove + /api/v2/device/name/{EDGEX_DEVICE_NAME}/ContinuousMove: + put: tags: - - Analytics - Rules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetVideoEncoderConfigurations: - get: - 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. + - PTZ - Actuation + summary: ContinuousMove + 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. + requestBody: + content: + application/json: + schema: + properties: + ContinuousMove: + $ref: '#/components/schemas/ptz_ContinuousMove' + required: + - ContinuousMove + type: object + example: + ContinuousMove: + ProfileToken: '{{MEDIA_PROFILE}}' + Velocity: + PanTilt: + x: -1 + y: -1 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurations + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.ContinuousMove + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetStatus: + get: + tags: + - PTZ - Actuation + summary: GetStatus + description: |- + Operation to request PTZ status for the Node in the selected profile. + +
+ + **`jsonObject` Schema:** + + _See: [ptz_GetStatus](#ptz_GetStatus)_ + + ```yaml + { + "ProfileToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + description: '{"ProfileToken":"profile_1"}' + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetStatusResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: c8ad64b4-db58-4c9b-9896-82fff02544c9 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 1ee4ca7f-fb95-46b3-8e6d-8542b45b22d4 - origin: 1659659203023412500 profileName: onvif-camera + sourceName: GetStatus + origin: 1659659252963492000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: dd2b4e0e-9a62-49bc-a80b-071d4b1ed8e1 - objectValue: - Configurations: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_2 - Quality: 3 - RateControl: - BitrateLimit: 256 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 360 - Width: 640 - SessionTimeout: PT0H1M5S - Token: minor - UseCount: 1 - origin: 1659659203023412500 - profileName: onvif-camera - resourceName: GetVideoEncoderConfigurations - value: '' - valueType: Object - sourceName: GetVideoEncoderConfigurations - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Configurations: - properties: - Encoding: - type: string - H264: - properties: - GovLength: - type: number - H264Profile: - type: string - type: object - Multicast: - properties: - Address: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - AutoStart: - type: boolean - Port: - type: number - TTL: - type: number - type: object - Name: - type: string - Quality: - type: number - RateControl: - properties: - BitrateLimit: - type: number - EncodingInterval: - type: number - FrameRateLimit: - type: number - type: object - Resolution: - properties: - Height: - type: number - Width: - type: number - type: object - SessionTimeout: - type: string - Token: - type: string - UseCount: - type: number - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '944' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:43 GMT - type: string - X-Correlation-Id: - schema: - example: 7330109d-9cd8-4d4d-9334-4d39860e62b3 - type: string - summary: VideoEncoderConfigurations - tags: - - Video Encoder Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GotoHomePosition: - put: - 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. + - id: 71444c1c-9e85-4852-9c1e-9bd9eba8d616 + origin: 1659659252963492000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetStatus + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + PTZStatus: + MoveStatus: + PanTilt: IDLE + Position: + PanTilt: + Space: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + X: 82 + Y: -5 + UtcTime: '2022-08-05T00:27:32Z' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GotoHomePosition - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetStatus + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Stop: + put: + tags: + - PTZ - Actuation + summary: Stop + 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. requestBody: content: application/json: schema: - example: - GotoHomePosition: - ProfileToken: '{{MEDIA_PROFILE}}' properties: - GotoHomePosition: - properties: - ProfileToken: - type: string - type: object + Stop: + $ref: '#/components/schemas/ptz_Stop' + required: + - Stop type: object + example: + Stop: + ProfileToken: '{{MEDIA_PROFILE}}' + PanTilt: true + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:27:58 GMT - type: string - X-Correlation-Id: - schema: - example: 5f34a9a0-2e59-4a63-91bb-d9fe59a5d293 - type: string - summary: GotoHomePosition - tags: - - PTZ - Home Position - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GotoPreset: - put: - 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. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GotoPreset - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.Stop + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetPreset: + put: + tags: + - PTZ - Preset + summary: SetPreset + 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. requestBody: content: application/json: schema: - example: - GotoPreset: - PresetToken: Preset1 - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' properties: - GotoPreset: - properties: - PresetToken: - type: string - ProfileToken: - type: string - type: object + SetPreset: + $ref: '#/components/schemas/ptz_SetPreset' + required: + - SetPreset type: object + example: + SetPreset: + PresetName: Preset1 + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: {} - description: Successful response - summary: GotoPreset - tags: - - PTZ - Preset - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Hostname: - get: - 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. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetHostname + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SetPreset + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetPresets: + get: + tags: + - PTZ - Preset + summary: GetPresets + 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. + +
+ + **`jsonObject` Schema:** + + _See: [ptz_GetPresets](#ptz_GetPresets)_ + + ```yaml + { + "ProfileToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + description: '{"ProfileToken":"profile_1"}' + example: '{{PTZ_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/ptz_GetPresetsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 79dde7e3-9730-4d33-aa9f-48e499b23207 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 6ad6d2d6-51af-4084-8a6a-952928942732 - origin: 1659655574277981200 profileName: onvif-camera + sourceName: GetPresets + origin: 1659659260936957200 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: b8e4ba90-2aeb-4336-a5ca-923456cff383 - objectValue: - HostnameInformation: - FromDHCP: false - Name: hostname - origin: 1659655574277981200 - profileName: onvif-camera - resourceName: Hostname - value: '' - valueType: Object - sourceName: Hostname - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - HostnameInformation: - properties: - FromDHCP: - type: boolean - Name: - type: string - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '571' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:26:14 GMT - type: string - X-Correlation-Id: - schema: - example: 08d01c8d-a9cd-4ece-b8e6-4a052af9e391 - type: string - summary: Hostname - tags: - - Network Configuration - put: - 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 formatted according to RFC 1123 section 2.1 or - alternatively to RFC 952, other string shall be considered as invalid strings.' + - id: 5816a933-ec39-4c58-b8cf-aa3fc8dcbd19 + origin: 1659659260936957200 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetPresets + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Preset: + - Name: Marked Position 2 + PTZPosition: + PanTilt: + Space: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + X: 169 + Y: -5 + Token: Preset2 + - Name: Marked Position 3 + PTZPosition: + PanTilt: + Space: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + X: 115 + Y: 13 + Token: Preset3 + - Name: preset4 + PTZPosition: + PanTilt: + Space: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + X: 134 + Y: 13 + Token: Preset4 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetHostname - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GetPresets + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GotoPreset: + put: + tags: + - PTZ - Preset + summary: GotoPreset + 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. requestBody: content: application/json: schema: - example: - Hostname: - Name: localhost555 properties: - Hostname: - properties: - Name: - type: string - type: object + GotoPreset: + $ref: '#/components/schemas/ptz_GotoPreset' + required: + - GotoPreset type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:18:17 GMT - type: string - X-Correlation-Id: - schema: - example: 8ff7406a-6544-4c19-9205-9c81e24cb090 - type: string - summary: SetHostname - tags: - - Network Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MACAddress: - get: - description: This command returns the MAC address associated with a device. + example: + GotoPreset: + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + PresetToken: Preset1 parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 92336908-8de3-458b-9f0c-3a0d5daaf721 - origin: 1659657259559177500 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 6d54121c-2d9b-4d2f-ac14-29246fb15e31 - origin: 1659657259559177500 - profileName: onvif-camera - resourceName: MACAddress - value: 10:27:F5:EA:88:F4 - valueType: String - sourceName: MACAddress - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '517' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:54:19 GMT - type: string - X-Correlation-Id: - schema: - example: e109dbc1-aa02-49c7-8663-454b6c973c3b - type: string - summary: Get MACAddress - tags: - - Custom + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GotoPreset + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemovePreset: put: - description: This command sets the MAC address associated with a device. - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - PTZ - Preset + summary: RemovePreset + 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. requestBody: content: application/json: schema: - example: - MACAddress: 10-27-f5-ea-88-f4 properties: - MACAddress: - type: string + RemovePreset: + $ref: '#/components/schemas/ptz_RemovePreset' + required: + - RemovePreset type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:54:38 GMT - type: string - X-Correlation-Id: - schema: - example: ac51855e-532b-4244-8774-c0fde0d70f4b - type: string - summary: Set MACAddress - tags: - - Custom - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Media2Profiles: - get: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.GetProfiles + example: + RemovePreset: + ProfileToken: '{{MEDIA_PROFILE}}' + PresetToken: Preset1 parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '500': - content: - application/json: - example: - apiVersion: v2 - message: 'request failed, status code: 500, err: {"apiVersion":"v2","message":"error - reading DeviceResourece Media2Profiles for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - -\u003e failed to execute read command -\u003e invalid request for - the function ''GetProfiles'' of web service ''Media2''. Onvif error: - fault reason: Method ''tr2:GetProfiles'' not implemented: method - name or namespace not recognized, fault detail: , fault code: SOAP-ENV:Sender ","statusCode":500}' - statusCode: 500 - schema: - properties: - apiVersion: - type: string - message: - type: string - statusCode: - type: number - type: object - description: Internal Server Error - headers: - Content-Length: - schema: - example: '523' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 03:58:10 GMT - type: string - X-Correlation-Id: - schema: - example: 5508bc60-f875-4895-86ae-2ed70fe8b7f0 - type: string - summary: GetProfiles - tags: - - Analytics - Profile Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfiguration: - get: - description: The GetMetadataConfiguration command fetches the metadata configuration - if the metadata token is known. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfiguration + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.RemovePreset + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GotoHomePosition: + put: + tags: + - PTZ - Home Position + summary: GotoHomePosition + 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. + requestBody: + content: + application/json: + schema: + properties: + GotoHomePosition: + $ref: '#/components/schemas/ptz_GotoHomePosition' + required: + - GotoHomePosition + type: object + example: + GotoHomePosition: + ProfileToken: '{{MEDIA_PROFILE}}' parameters: - - example: '{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - id: 53480499-ece4-4437-b795-0ff4f57a564a - origin: 1663974689815368400 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - id: b6cda316-6a50-4990-8279-e2777be95c79 - objectValue: - Configuration: {} - origin: 1663974689815368400 - profileName: onvif-camera - resourceName: MetadataConfiguration - value: '' - valueType: Object - sourceName: MetadataConfiguration - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Configuration: - properties: {} - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '557' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:11:29 GMT - type: string - X-Correlation-Id: - schema: - example: 96f2ec58-26af-410c-8264-5c62c45425eb - type: string - summary: MetadataConfiguration - tags: - - Metadata Configuration - put: - 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. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetMetadataConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.GotoHomePosition + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetHomePosition: + put: + tags: + - PTZ - Home Position + summary: SetHomePosition + 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. requestBody: content: application/json: schema: - example: - MetadataConfiguration: - Configuration: - Analytics: true - token: '{{MEDIA_CONFIG_TOKEN}}' - ForcePersistence: true properties: - MetadataConfiguration: - properties: - Configuration: - properties: - Analytics: - type: boolean - token: - type: string - type: object - ForcePersistence: - type: boolean - type: object + SetHomePosition: + $ref: '#/components/schemas/ptz_SetHomePosition' + required: + - SetHomePosition type: object + example: + SetHomePosition: + ProfileToken: '{{MEDIA_PROFILE}}' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:13:37 GMT - type: string - X-Correlation-Id: - schema: - example: f9b22e19-bfba-4bb3-84bf-48ed200b9cf1 - type: string - summary: SetMetadataConfiguration - tags: - - Metadata Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurationOptions: - get: - description: This operation returns the available options (supported values - and ranges for metadata configuration parameters) for changing the metadata - configuration. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurationOptions - parameters: - - example: '{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: - type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: f296e8b5-707f-4e66-9388-918821b83a19 - origin: 1659659194429862100 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: f8efa15a-612d-4532-b40b-4e895cecb3bd - objectValue: - Options: {} - origin: 1659659194429862100 - profileName: onvif-camera - resourceName: MetadataConfigurationOptions - value: '' - valueType: Object - sourceName: MetadataConfigurationOptions - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Options: - properties: {} - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '565' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:34 GMT - type: string - X-Correlation-Id: - schema: - example: fcbe3f78-3851-44ac-a75f-238527b90ea7 - type: string - summary: MetadataConfigurationOptions + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SetHomePosition + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SendAuxiliaryCommand: + put: tags: - - Metadata Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurations: - get: - description: This operation lists all existing metadata configurations. The - client need not know anything apriori about the metadata in order to use the + - PTZ - Auxiliary + summary: SendAuxiliaryCommand + 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. + requestBody: + content: + application/json: + schema: + properties: + SendAuxiliaryCommand: + $ref: '#/components/schemas/ptz_SendAuxiliaryCommand' + required: + - SendAuxiliaryCommand + type: object + example: + SendAuxiliaryCommand: + ProfileToken: '{{MEDIA_PROFILE}}' + AuxiliaryData: '123' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurations + url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SendAuxiliaryCommand + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetEventProperties: + get: + tags: + - Event Handling + summary: GetEventProperties + 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. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 1acba723-b1b1-4790-8e80-9d554cacaedc - origin: 1659659180814799600 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 8c59a3a8-401b-4e18-8af5-9a98efe7f410 - objectValue: - Configurations: {} - origin: 1659659180814799600 - profileName: onvif-camera - resourceName: MetadataConfigurations - value: '' - valueType: Object - sourceName: MetadataConfigurations - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Configurations: - properties: {} - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object description: OK headers: - Content-Length: - schema: - example: '560' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:20 GMT - type: string X-Correlation-Id: - schema: - example: 7358d440-ed28-4f52-ab63-d28fb53d7c51 - type: string - summary: MetadataConfigurations - tags: - - Metadata Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkConfiguration: - get: - description: Used to retrieve network resources for a device such as Hostname, - DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - responses: - '200': + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/event_GetEventPropertiesResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 + id: 925ca37f-2ed6-43f9-b9e3-4c31849325b7 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: b34fe9d1-78f9-4b49-961b-80a252e084c4 - origin: 1659656577804929300 profileName: onvif-camera + sourceName: GetEventProperties + origin: 1659659240585563600 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 67e318f5-4426-48ff-8235-4a2471e47baf - objectValue: - HostnameInformation: - FromDHCP: false - Name: hostname - origin: 1659656577804929300 - profileName: onvif-camera - resourceName: Hostname - value: '' - valueType: Object - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 76cfd2b5-f178-4d16-88d1-6b04f129a867 - objectValue: - DNSInformation: {} - origin: 1659656577804929300 - profileName: onvif-camera - resourceName: DNS - value: '' - valueType: Object - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 301b79ab-c92d-4a3f-9776-9a71f6c3c340 - objectValue: - NetworkInterfaces: - Enabled: true - IPv4: - Config: - DHCP: false - Manual: - Address: 10.0.0.188 - PrefixLength: 24 - Enabled: true - Info: - HwAddress: 10:27:F5:EA:88:F4 - MTU: 1500 - Name: eth0 - Token: eth0 - origin: 1659656577804929300 - profileName: onvif-camera - resourceName: NetworkInterfaces - value: '' - valueType: Object - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: cc1d5230-06a8-4515-822e-187ba07d0efc - objectValue: - NetworkProtocols: - - Enabled: true - Name: HTTPS - Port: 443 - - Enabled: true - Name: RTSP - Port: 554 - origin: 1659656577804929300 - profileName: onvif-camera - resourceName: NetworkProtocols - value: '' - valueType: Object - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 81f9c4e6-1cfd-487a-a05b-b8ea5b39ffcf - objectValue: - NetworkGateway: {} - origin: 1659656577804929300 - profileName: onvif-camera - resourceName: NetworkDefaultGateway - value: '' - valueType: Object - sourceName: NetworkConfiguration - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - DNSInformation: - properties: {} - type: object - HostnameInformation: - properties: - FromDHCP: - type: boolean - Name: - type: string - type: object - NetworkGateway: - properties: {} - type: object - NetworkInterfaces: - properties: - Enabled: - type: boolean - IPv4: - properties: - Config: - properties: - DHCP: - type: boolean - Manual: - properties: - Address: - type: string - PrefixLength: - type: number - type: object - type: object - Enabled: - type: boolean - type: object - Info: - properties: - HwAddress: - type: string - MTU: - type: number - Name: - type: string - type: object - Token: - type: string - type: object - NetworkProtocols: - items: - properties: - Enabled: - type: boolean + - id: dc1e5896-00d9-4e4d-85f7-2dbca9a4b8cb + origin: 1659659240585563600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: GetEventProperties + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + FixedTopicSet: true + MessageContentFilterDialect: >- + http://www.onvif.org/ver10/tev/messageContentFilter/ItemFilter + MessageContentSchemaLocation: http://www.onvif.org/onvif/ver10/schema/onvif.xsd + TopicExpressionDialect: >- + http://docs.oasis-open.org/wsn/t-1/TopicExpression/Concrete + TopicNamespaceLocation: http://www.onvif.org/onvif/ver10/topics/topicns.xml + TopicSet: + tns1:RuleEngine: + '#seq': 0 + CellMotionDetector: + '#seq': 0 + Motion: + '#attr': + wstop:topic: + '#seq': 0 + '#text': 'true' + '#seq': 0 + tt:MessageDescription: + '#attr': + IsProperty: + '#seq': 0 + '#text': 'true' + '#seq': 0 + tt:Data: + '#seq': 1 + tt:SimpleItemDescription: + '#attr': Name: - type: string - Port: - type: number - required: - - Enabled - - Name - - Port - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - required: - - id - - origin - - deviceName - - resourceName - - profileName - - valueType - - value - - objectValue - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1944' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:42:57 GMT - type: string - X-Correlation-Id: - schema: - example: eef44832-ed52-4799-be75-9d247984114f - type: string - summary: NetworkConfiguration - tags: - - Network Configuration + '#seq': 1 + '#text': IsMotion + Type: + '#seq': 0 + '#text': xsd:boolean + '#seq': 0 + tt:Source: + '#seq': 0 + tt:SimpleItemDescription: + - '#attr': + Name: + '#seq': 1 + '#text': VideoSourceConfigurationToken + Type: + '#seq': 0 + '#text': tt:ReferenceToken + '#seq': 0 + - '#attr': + Name: + '#seq': 1 + '#text': VideoAnalyticsConfigurationToken + Type: + '#seq': 0 + '#text': tt:ReferenceToken + '#seq': 1 + - '#attr': + Name: + '#seq': 1 + '#text': Rule + Type: + '#seq': 0 + '#text': xsd:string + '#seq': 2 + TamperDetector: + '#seq': 1 + Tamper: + '#attr': + wstop:topic: + '#seq': 0 + '#text': 'true' + '#seq': 0 + tt:MessageDescription: + '#attr': + IsProperty: + '#seq': 0 + '#text': 'true' + '#seq': 0 + tt:Data: + '#seq': 1 + tt:SimpleItemDescription: + '#attr': + Name: + '#seq': 1 + '#text': IsTamper + Type: + '#seq': 0 + '#text': xsd:boolean + '#seq': 0 + tt:Source: + '#seq': 0 + tt:SimpleItemDescription: + - '#attr': + Name: + '#seq': 1 + '#text': VideoSourceConfigurationToken + Type: + '#seq': 0 + '#text': tt:ReferenceToken + '#seq': 0 + - '#attr': + Name: + '#seq': 1 + '#text': VideoAnalyticsConfigurationToken + Type: + '#seq': 0 + '#text': tt:ReferenceToken + '#seq': 1 + - '#attr': + Name: + '#seq': 1 + '#text': Rule + Type: + '#seq': 0 + '#text': xsd:string + '#seq': 2 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/events/wsdl/event.wsdl#op.GetEventProperties + /api/v2/device/name/{EDGEX_DEVICE_NAME}/BaseNotificationSubscription: put: - description: Used to configure network resources for a device such as Hostname, - DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - Event Handling + summary: BaseNotificationSubscription + description: Create a subscription to subscribe the event from the camera requestBody: content: application/json: schema: - example: - DNS: - DNSManual: - IPv4Address: 192.168.12.1 - Type: IPv4 - FromDHCP: false - Hostname: - Name: localhost - NetworkDefaultGateway: - IPv4Address: 192.168.12.1 - NetworkInterfaces: - InterfaceToken: eth0 - NetworkInterface: - Enabled: true - IPv4: - DHCP: false - NetworkProtocols: - NetworkProtocols: - - Enabled: true - Name: HTTP - Port: 80 properties: - DNS: - properties: - DNSManual: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - FromDHCP: - type: boolean - type: object - Hostname: + BaseNotificationSubscription: properties: - Name: + InitialTerminationTime: + $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + TopicFilter: type: string type: object - NetworkDefaultGateway: + required: + - BaseNotificationSubscription + type: object + example: + BaseNotificationSubscription: + TopicFilter: tns1:RuleEngine/TamperDetector/Tamper + InitialTerminationTime: PT180S + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/PullPointSubscription: + put: + tags: + - Event Handling + summary: PullPointSubscription + 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. + requestBody: + content: + application/json: + schema: + properties: + PullPointSubscription: properties: - IPv4Address: + MessageContentFilter: type: string + InitialTerminationTime: + $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + MessageTimeout: + $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' type: object - NetworkInterfaces: - properties: - InterfaceToken: - type: string - NetworkInterface: - properties: - Enabled: - type: boolean - IPv4: - properties: - DHCP: - type: boolean - type: object - type: object - type: object - NetworkProtocols: - properties: - NetworkProtocols: - items: - properties: - Enabled: - type: boolean - Name: - type: string - Port: - type: number - type: object - type: array + required: + - PullPointSubscription + type: object + example: + PullPointSubscription: + MessageContentFilter: boolean(//tt:SimpleItem[@Name="Rule"]) + InitialTerminationTime: PT120S + MessageTimeout: PT20S + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/UnsubscribeCameraEvent: + put: + tags: + - Event Handling + summary: UnsubscribeCameraEvent + 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. + requestBody: + content: + application/json: + schema: + properties: + UnsubscribeCameraEvent: type: object + required: + - UnsubscribeCameraEvent type: object + example: + UnsubscribeCameraEvent: {} + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Media2Profiles: + get: + tags: + - Analytics - Profile Configuration + summary: GetProfiles + 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. + +
+ + **`jsonObject` Schema:** + + _See: [media2_GetProfiles](#media2_GetProfiles)_ + + ```yaml + { + "Token": "", + "Type": [] + } + ``` + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '500': + description: Internal Server Error + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: - example: - apiVersion: v2 - statusCode: 200 schema: - properties: - apiVersion: - type: string - statusCode: - type: number type: object + example: + apiVersion: v2 + message: >- + request failed, status code: 500, err: + {"apiVersion":"v2","message":"error reading DeviceResourece + Media2Profiles for + TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e + failed to execute read command -\u003e invalid request for the + function 'GetProfiles' of web service 'Media2'. Onvif error: + fault reason: Method 'tr2:GetProfiles' not implemented: method + name or namespace not recognized, fault detail: , fault code: + SOAP-ENV:Sender ","statusCode":500} + statusCode: 500 + '200': description: OK headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:10:59 GMT - type: string X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: 2955d163-0007-4fa3-9a2c-267510c01e44 - type: string - summary: SetNetworkConfiguration - tags: - - Network Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkDefaultGateway: - get: - description: This operation gets the default gateway settings from a device. - The device shall support the GetNetworkDefaultGateway command returning configured - default gateway address(es). + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media2_GetProfilesResponse' + examples: + 200Example: + $ref: '#/components/examples/200Example' + '400': *id001 + '404': *id002 + '423': *id003 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkDefaultGateway + url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.GetProfiles + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetAnalyticsConfigurations: + get: + tags: + - Analytics - Profile Configuration + summary: GetAnalyticsConfigurations + 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. parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': + '500': + description: Internal Server Error + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 78915210-fab0-4018-a8ed-72f793c2cbc7 - origin: 1659671987813255200 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: c348128d-0c51-4470-a978-b431302906a0 - objectValue: - NetworkGateway: {} - origin: 1659671987813255200 - profileName: onvif-camera - resourceName: NetworkDefaultGateway - value: '' - valueType: Object - sourceName: NetworkDefaultGateway - statusCode: 200 schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - NetworkGateway: - properties: {} - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number type: object + example: + apiVersion: v2 + message: >- + request failed, status code: 500, err: + {"apiVersion":"v2","message":"error reading DeviceResourece + GetAnalyticsConfigurations for + TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e + failed to execute read command -\u003e invalid request for the + function 'GetAnalyticsConfigurations' of web service 'Media2'. + Onvif error: fault reason: Method + 'tr2:GetAnalyticsConfigurations' not implemented: method name + or namespace not recognized, fault detail: , fault code: + SOAP-ENV:Sender ","statusCode":500} + statusCode: 500 + '200': description: OK headers: - Content-Length: - schema: - example: '558' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 03:59:47 GMT - type: string X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: e24e3e01-1680-40c6-ae25-3151ff5aafef - type: string - summary: NetworkDefaultGateway - tags: - - Network Configuration - put: - description: This operation sets the default gateway settings on a device. The - device shall support configuration of default gateway through the SetNetworkDefaultGateway - command. + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media2_GetAnalyticsConfigurationsResponse' + examples: + 200Example: + $ref: '#/components/examples/200Example' + '400': *id001 + '404': *id002 + '423': *id003 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkDefaultGateway + url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.GetAnalyticsConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddConfiguration: + put: + tags: + - Analytics - Profile Configuration + summary: AddConfiguration + 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. + requestBody: + content: + application/json: + schema: + properties: + AddConfiguration: + $ref: '#/components/schemas/media2_AddConfiguration' + required: + - AddConfiguration + type: object + example: + AddConfiguration: + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + Configuration: + - Type: Analytics + Token: '{{ANALYTIC_CONFIG_TOKEN}}' parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.AddConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveConfiguration: + put: + tags: + - Analytics - Profile Configuration + summary: RemoveConfiguration + 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. requestBody: content: application/json: schema: - example: - NetworkDefaultGateway: - IPv4Address: 192.168.12.1 properties: - NetworkDefaultGateway: - properties: - IPv4Address: - type: string - type: object + RemoveConfiguration: + $ref: '#/components/schemas/media2_RemoveConfiguration' + required: + - RemoveConfiguration type: object + example: + RemoveConfiguration: + ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + Configuration: + - Type: Analytics + Token: '{{ANALYTIC_CONFIG_TOKEN}}' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.RemoveConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetSupportedAnalyticsModules: + get: + tags: + - Analytics - Modules + summary: GetSupportedAnalyticsModules + description: |- + List all analytics modules that are supported by the given VideoAnalyticsConfiguration. + +
+ + **`jsonObject` Schema:** + + _See: [analytics_GetSupportedAnalyticsModules](#analytics_GetSupportedAnalyticsModules)_ + + ```yaml + { + "ConfigurationToken": "" + } + ``` + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object description: OK headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:26:55 GMT - type: string X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: 84ab80db-4334-49e7-a956-e2ce4aab9b99 - type: string - summary: SetNetworkDefaultGateway - tags: - - Network Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkInterfaces: - get: - 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. + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/analytics_GetSupportedAnalyticsModulesResponse' + examples: + 200Example: + $ref: '#/components/examples/200Example' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkInterfaces + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetSupportedAnalyticsModules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AnalyticsModules: + get: + tags: + - Analytics - Modules + summary: GetAnalyticsModules + description: |- + List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. + +
+ + **`jsonObject` Schema:** + + _See: [analytics_GetAnalyticsModules](#analytics_GetAnalyticsModules)_ + + ```yaml + { + "ConfigurationToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/analytics_GetAnalyticsModulesResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: acc3a74d-852a-4c0c-bf31-dbc06d8a0782 - origin: 1659655709817960400 + id: 76f908cd-6b34-477f-9a03-5eea4021b416 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 profileName: onvif-camera + sourceName: AnalyticsModules + origin: 1665460175164294000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 74571fe4-731a-4925-99eb-7d4c317834f6 - objectValue: - NetworkInterfaces: - Enabled: true - IPv4: - Config: - DHCP: false - Manual: - Address: 10.0.0.195 - PrefixLength: 24 - Enabled: true - Info: - HwAddress: 10:27:F5:EA:88:F4 - MTU: 1500 - Name: eth0 - Token: eth0 - origin: 1659655709817960400 - profileName: onvif-camera - resourceName: NetworkInterfaces - value: '' - valueType: Object - sourceName: NetworkInterfaces - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - NetworkInterfaces: - properties: - Enabled: - type: boolean - IPv4: - properties: - Config: - properties: - DHCP: - type: boolean - Manual: - properties: - Address: - type: string - PrefixLength: - type: number - type: object - type: object - Enabled: - type: boolean - type: object - Info: - properties: - HwAddress: - type: string - MTU: - type: number - Name: - type: string - type: object - Token: - type: string - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '748' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:28:29 GMT - type: string - X-Correlation-Id: - schema: - example: 241016a3-ff95-4002-9499-81e793002f9c - type: string - summary: NetworkInterfaces - tags: - - Network Configuration - put: - 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.\n\nFor 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\u2019\ - t present in the request." + - id: c5f01e17-9b31-43eb-bc55-2417617ef530 + origin: 1665460175164294000 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + resourceName: AnalyticsModules + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + AnalyticsModule: + - Name: MyCellMotionModule + Parameters: + SimpleItem: + - Name: Sensitivity + Value: '6' + Type: tt:CellMotionEngine + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkInterfaces - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetAnalyticsModules + put: + tags: + - Analytics - Modules + summary: ModifyAnalyticsModules + 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. requestBody: content: application/json: schema: - example: - NetworkInterfaces: - InterfaceToken: eth0 - NetworkInterface: - Enabled: true - IPv4: - DHCP: true properties: - NetworkInterfaces: - properties: - InterfaceToken: - type: string - NetworkInterface: - properties: - Enabled: - type: boolean - IPv4: - properties: - DHCP: - type: boolean - type: object - type: object - type: object + AnalyticsModules: + $ref: '#/components/schemas/analytics_ModifyAnalyticsModules' + required: + - AnalyticsModules type: object + example: + AnalyticsModules: + ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + AnalyticsModule: + - Name: Viproc + Type: '{{ANALYTIC_MODULE_TYPE}}' + Parameters: + SimpleItem: + - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' + Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:19:43 GMT - type: string - X-Correlation-Id: - schema: - example: 1ccf5e8a-352b-4a85-8ea7-71f9333a5bf4 - type: string - summary: SetNetworkInterfaces - tags: - - Network Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkProtocols: - get: - description: This operation gets defined network protocols from a device. The - device shall support the GetNetworkProtocols command returning configured - network protocols. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkProtocols + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.ModifyAnalyticsModules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateAnalyticsModules: + put: + tags: + - Analytics - Modules + summary: CreateAnalyticsModules + 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. + requestBody: + content: + application/json: + schema: + properties: + CreateAnalyticsModules: + $ref: '#/components/schemas/analytics_CreateAnalyticsModules' + required: + - CreateAnalyticsModules + type: object + example: + CreateAnalyticsModules: + ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + AnalyticsModule: + - Name: TestAnalyticsModule + Type: '{{ANALYTIC_MODULE_TYPE}}' + Parameters: + SimpleItem: + - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' + Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 193b3677-23c8-4d89-852e-73a1aabf445e - origin: 1659671976670370300 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: d3a47ec4-3b43-413a-9a67-42f54487cfa5 - objectValue: - NetworkProtocols: - - Enabled: true - Name: HTTPS - Port: 443 - - Enabled: true - Name: RTSP - Port: 554 - origin: 1659671976670370300 - profileName: onvif-camera - resourceName: NetworkProtocols - value: '' - valueType: Object - sourceName: NetworkProtocols - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - NetworkProtocols: - items: - properties: - Enabled: - type: boolean - Name: - type: string - Port: - type: number - required: - - Enabled - - Name - - Port - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '634' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 03:59:36 GMT - type: string - X-Correlation-Id: - schema: - example: 96d41685-1184-43f4-a5bf-580fcb5f7011 - type: string - summary: NetworkProtocols - tags: - - Network Configuration - put: - description: This operation configures defined network protocols on a device. - The device shall support configuration of defined network protocols through - the SetNetworkProtocols command. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkProtocols - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.CreateAnalyticsModules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteAnalyticsModules: + put: + tags: + - Analytics - Modules + summary: DeleteAnalyticsModules + description: >- + Remove one or more analytics modules from a VideoAnalyticsConfiguration + referenced by their names. requestBody: content: application/json: schema: - example: - NetworkProtocols: - NetworkProtocols: - - Enabled: true - Name: HTTP - Port: 2020 - - Enabled: false - Name: HTTPS - Port: 443 - - Enabled: true - Name: RTSP - Port: 554 properties: - NetworkProtocols: - properties: - NetworkProtocols: - items: - properties: - Enabled: - type: boolean - Name: - type: string - Port: - type: number - required: - - Name - - Enabled - - Port - type: object - type: array - type: object + DeleteAnalyticsModules: + $ref: '#/components/schemas/analytics_DeleteAnalyticsModules' + required: + - DeleteAnalyticsModules type: object + example: + DeleteAnalyticsModules: + ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + AnalyticsModuleName: + - TestAnalyticsModule + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:26:38 GMT - type: string - X-Correlation-Id: - schema: - example: a7f75e35-bb5c-46b2-a502-c269c574a7b0 - type: string - summary: SetNetworkProtocols - tags: - - Network Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Profiles: - get: - 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. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetProfiles + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.DeleteAnalyticsModules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetAnalyticsModuleOptions: + get: + tags: + - Analytics - Modules + summary: GetAnalyticsModuleOptions + description: |- + Return the options for the supported analytics modules that specify an Option attribute. + +
+ + **`jsonObject` Schema:** + + _See: [analytics_GetAnalyticsModuleOptions](#analytics_GetAnalyticsModuleOptions)_ + + ```yaml + { + "ConfigurationToken": "", + "Type": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/analytics_GetAnalyticsModuleOptionsResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: e6560b52-1952-4d66-9f53-3cf27d48b3c0 - origin: 1659656314715442700 + id: 460b6e4f-88d7-476d-ab9c-d46c5f656124 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 profileName: onvif-camera + sourceName: GetAnalyticsModuleOptions + origin: 1665460132225688000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 5c7bc03c-308f-4b2c-8bc9-2e59da7d6f65 - objectValue: - Profiles: - - AudioEncoderConfiguration: - Bitrate: 131072 - Encoding: G711 - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: AudioEncoder_1 - SampleRate: 8000 - SessionTimeout: PT0H1M5S - Token: microphone - UseCount: 2 - AudioSourceConfiguration: - Name: AudioSourceConfig - SourceToken: raw_as1 - Token: asconf - UseCount: 2 - Extension: null - Fixed: true - MetadataConfiguration: null - Name: mainStream - PTZConfiguration: - DefaultAbsolutePantTiltPositionSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - DefaultContinuousPanTiltVelocitySpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - DefaultPTZSpeed: {} - DefaultPTZTimeout: PT0H0M20S - DefaultRelativePanTiltTranslationSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - PanTiltLimits: - Range: - URI: '' - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: PTZConfiguration0 - Token: profile_1 - VideoAnalyticsConfiguration: - AnalyticsEngineConfiguration: - AnalyticsModule: - - Name: MyCellMotionModule - Parameters: - ElementItem: - - Name: Layout - SimpleItem: - - Name: Sensitivity - Value: medium - - Name: Enabled - Value: 'off' - Type: tt:CellMotionEngine - - Name: MyTamperDetecModule - Parameters: - SimpleItem: - - Name: Sensitivity - - Name: Enabled - Type: tt:TamperEngine - Name: VideoAnalyticsName - RuleEngineConfiguration: - Rule: - Name: MyTamperDetectorRule - Parameters: - SimpleItem: - - Name: ActiveCells - Value: 0P8A8A== - - Name: MinCount - Value: '5' - - Name: AlarmOnDelay - Value: '1000' - - Name: AlarmOffDelay - Value: '1000' - Type: tt:TamperDetector - Token: VideoAnalyticsToken - UseCount: 2 - VideoEncoderConfiguration: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_1 - Quality: 3 - RateControl: - BitrateLimit: 1024 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 1080 - Width: 1920 - SessionTimeout: PT0H1M5S - Token: main - UseCount: 1 - VideoSourceConfiguration: - Bounds: - Height: 720 - Width: 1280 - X: 0 - Y: 0 - Extension: null - Name: VideoSourceConfig - SourceToken: raw_vs1 - Token: vsconf - UseCount: 2 - ViewMode: '' - - AudioEncoderConfiguration: - Bitrate: 131072 - Encoding: G711 - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: AudioEncoder_1 - SampleRate: 8000 - SessionTimeout: PT0H1M5S - Token: microphone - UseCount: 2 - AudioSourceConfiguration: - Name: AudioSourceConfig - SourceToken: raw_as1 - Token: asconf - UseCount: 2 - Extension: null - Fixed: true - MetadataConfiguration: null - Name: minorStream - PTZConfiguration: - DefaultAbsolutePantTiltPositionSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - DefaultContinuousPanTiltVelocitySpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - DefaultPTZSpeed: {} - DefaultPTZTimeout: PT0H0M20S - DefaultRelativePanTiltTranslationSpace: http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - PanTiltLimits: - Range: - URI: '' - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: PTZConfiguration0 - Token: profile_2 - VideoAnalyticsConfiguration: - AnalyticsEngineConfiguration: - AnalyticsModule: - - Name: MyCellMotionModule - Parameters: - ElementItem: - - Name: Layout - SimpleItem: - - Name: Sensitivity - Value: medium - - Name: Enabled - Value: 'off' - Type: tt:CellMotionEngine - - Name: MyTamperDetecModule - Parameters: - SimpleItem: - - Name: Sensitivity - - Name: Enabled - Type: tt:TamperEngine - Name: VideoAnalyticsName - RuleEngineConfiguration: - Rule: - Name: MyTamperDetectorRule - Parameters: - SimpleItem: - - Name: ActiveCells - Value: 0P8A8A== - - Name: MinCount - Value: '5' - - Name: AlarmOnDelay - Value: '1000' - - Name: AlarmOffDelay - Value: '1000' - Type: tt:TamperDetector - Token: VideoAnalyticsToken - UseCount: 2 - VideoEncoderConfiguration: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_2 - Quality: 3 - RateControl: - BitrateLimit: 256 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 360 - Width: 640 - SessionTimeout: PT0H1M5S - Token: minor - UseCount: 1 - VideoSourceConfiguration: - Bounds: - Height: 720 - Width: 1280 - X: 0 - Y: 0 - Extension: null - Name: VideoSourceConfig - SourceToken: raw_vs1 - Token: vsconf - UseCount: 2 - ViewMode: '' - origin: 1659656314715442700 - profileName: onvif-camera - resourceName: Profiles - value: '' - valueType: Object - sourceName: Profiles - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Profiles: - items: - properties: - AudioEncoderConfiguration: - properties: - Bitrate: - type: number - Encoding: - type: string - Multicast: - properties: - Address: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - AutoStart: - type: boolean - Port: - type: number - TTL: - type: number - type: object - Name: - type: string - SampleRate: - type: number - SessionTimeout: - type: string - Token: - type: string - UseCount: - type: number - type: object - AudioSourceConfiguration: - properties: - Name: - type: string - SourceToken: - type: string - Token: - type: string - UseCount: - type: number - type: object - Extension: - type: object - Fixed: - type: boolean - MetadataConfiguration: - type: object - Name: - type: string - PTZConfiguration: - properties: - DefaultAbsolutePantTiltPositionSpace: - type: string - DefaultContinuousPanTiltVelocitySpace: - type: string - DefaultPTZSpeed: - properties: {} - type: object - DefaultPTZTimeout: - type: string - DefaultRelativePanTiltTranslationSpace: - type: string - PanTiltLimits: - properties: - Range: - properties: - URI: - type: string - XRange: - properties: - Max: - type: number - Min: - type: number - type: object - YRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - Token: - type: string - type: object - Token: - type: string - VideoAnalyticsConfiguration: - properties: - AnalyticsEngineConfiguration: - properties: - AnalyticsModule: - items: - properties: - Name: - type: string - Parameters: - properties: - ElementItem: - items: - properties: - Name: - type: string - required: - - Name - type: object - type: array - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - required: - - Name - - Value - type: object - type: array - type: object - Type: - type: string - required: - - Name - - Parameters - - Type - type: object - type: array - type: object - Name: - type: string - RuleEngineConfiguration: - properties: - Rule: - properties: - Name: - type: string - Parameters: - properties: - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - required: - - Name - - Value - type: object - type: array - type: object - Type: - type: string - type: object - type: object - Token: - type: string - UseCount: - type: number - type: object - VideoEncoderConfiguration: - properties: - Encoding: - type: string - H264: - properties: - GovLength: - type: number - H264Profile: - type: string - type: object - Multicast: - properties: - Address: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - AutoStart: - type: boolean - Port: - type: number - TTL: - type: number - type: object - Name: - type: string - Quality: - type: number - RateControl: - properties: - BitrateLimit: - type: number - EncodingInterval: - type: number - FrameRateLimit: - type: number - type: object - Resolution: - properties: - Height: - type: number - Width: - type: number - type: object - SessionTimeout: - type: string - Token: - type: string - UseCount: - type: number - type: object - VideoSourceConfiguration: - properties: - Bounds: - properties: - Height: - type: number - Width: - type: number - X: - type: number - Y: - type: number - type: object - Extension: - type: object - Name: - type: string - SourceToken: - type: string - Token: - type: string - UseCount: - type: number - ViewMode: - type: string - type: object - required: - - AudioEncoderConfiguration - - AudioSourceConfiguration - - Extension - - Fixed - - MetadataConfiguration - - Name - - PTZConfiguration - - Token - - VideoAnalyticsConfiguration - - VideoEncoderConfiguration - - VideoSourceConfiguration - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:38:34 GMT - type: string - Transfer-Encoding: - schema: - example: chunked - type: string - X-Correlation-Id: - schema: - example: 00d76d82-033a-4787-ac76-3e049ca16294 - type: string - summary: Profiles + - id: 42a9e19c-82f6-4552-9f1d-459bfc55600a + origin: 1665460132225688000 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + resourceName: GetAnalyticsModuleOptions + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Options: + - IntRange: + Max: 100 + Min: 0 + Name: Sensitivity + Type: tt:IntRange + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetAnalyticsModuleOptions + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetSupportedRules: + get: tags: - - Video Streaming - /api/v2/device/name/{EDGEX_DEVICE_NAME}/PullPointSubscription: - put: - 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. + - Analytics - Rules + summary: GetSupportedRules + description: |- + List all rules that are supported by the given VideoAnalyticsConfiguration. +
- If no Filter is specified the pullpoint notifies all occurring events to the - client. + **`jsonObject` Schema:** + _See: [analytics_GetSupportedRules](#analytics_GetSupportedRules)_ - This method is mandatory.' + ```yaml + { + "ConfigurationToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - example: - PullPointSubscription: - InitialTerminationTime: PT120S - MessageContentFilter: boolean(//tt:SimpleItem[@Name="Rule"]) - MessageTimeout: PT20S - properties: - PullPointSubscription: - properties: - InitialTerminationTime: - type: string - MessageContentFilter: - type: string - MessageTimeout: - type: string - type: object - type: object + - name: jsonObject + in: query + schema: + type: string + example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/analytics_GetSupportedRulesResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 21:56:15 GMT - type: string - X-Correlation-Id: - schema: - example: d7f2c6d0-443f-4958-b224-d840c59eb3c3 - type: string - summary: PullPointSubscription - tags: - - Event Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RebootNeeded: + event: + apiVersion: v2 + id: 4694424b-74bb-45ee-a014-ebb6d09855f9 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + profileName: onvif-camera + sourceName: GetSupportedRules + origin: 1665460098832568300 + readings: + - id: 155dc49e-caa7-492c-be74-0cf150ca2302 + origin: 1665460098832568300 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + resourceName: GetSupportedRules + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + SupportedRules: + RuleContentSchemaLocation: http://www.w3.org/2001/XMLSchema + RuleDescription: + - Fixed: false + MaxInstances: 10 + Messages: + Data: + SimpleItemDescription: + - Name: IsMotion + Type: xs:boolean + IsProperty: true + ParentTopic: tns1:RuleEngine/CellMotionDetector/Motion + Source: + SimpleItemDescription: + - Name: VideoSourceConfigurationToken + Type: tt:ReferenceToken + - Name: VideoAnalyticsConfigurationToken + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:CellMotionDetector + Parameters: + SimpleItemDescription: + - Name: MinCount + Type: xs:integer + - Name: AlarmOnDelay + Type: xs:integer + - Name: AlarmOffDelay + Type: xs:integer + - Name: ActiveCells + Type: xs:base64Binary + - Fixed: false + MaxInstances: 10 + Messages: + Data: + SimpleItemDescription: + - Name: State + Type: xs:boolean + IsProperty: true + ParentTopic: tns1:RuleEngine/MotionRegionDetector/Motion + Source: + SimpleItemDescription: + - Name: VideoSource + Type: tt:ReferenceToken + - Name: RuleName + Type: xs:string + Name: tt:MotionRegionDetector + Parameters: + ElementItemDescription: + - Name: MotionRegion + - Fixed: false + MaxInstances: 1 + Messages: + Data: + ElementItemDescription: + - Name: Image + - Name: BoundingBox + SimpleItemDescription: + - Name: Likelihood + Type: xs:float + - Name: Label + Type: xs:string + - Name: ImageUri + Type: xs:anyURI + - Name: EnrollmentID + Type: xs:string + - Name: RefImageUri + Type: xs:anyURI + IsProperty: true + ParentTopic: tns1:RuleEngine/Recognition/Face + Source: + SimpleItemDescription: + - Name: VideoSource + Type: tt:ReferenceToken + - Name: AnalyticsConfiguration + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:FaceRecognition + Parameters: + SimpleItemDescription: + - Name: IncludeImage + Type: xs:string + - Fixed: false + MaxInstances: 1 + Messages: + Data: + ElementItemDescription: + - Name: BoundingBox + - Name: Image + - Name: LicensePlateInfo + - Name: VehicleInfo + - Name: VehicleImage + SimpleItemDescription: + - Name: Likelihood + Type: xs:float + - Name: Label + Type: xs:string + - Name: ImageUri + Type: xs:anyURI + - Name: VehicleImageURI + Type: xs:anyURI + IsProperty: true + ParentTopic: tns1:RuleEngine/Recognition/LicensePlate + Source: + SimpleItemDescription: + - Name: VideoSource + Type: tt:ReferenceToken + - Name: AnalyticsConfiguration + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:LicensePlateRecognition + Parameters: + ElementItemDescription: + - Name: Region + - Name: SnapLine + SimpleItemDescription: + - Name: IncludeImage + Type: xs:string + - Name: PlateLocation + Type: xs:string + - Fixed: false + MaxInstances: 1 + Messages: + Data: + SimpleItemDescription: + - Name: Count + Type: xs:int + IsProperty: true + ParentTopic: tns1:RuleEngine/CountAggregation/Counter + Source: + SimpleItemDescription: + - Name: VideoSource + Type: tt:ReferenceToken + - Name: AnalyticsConfiguration + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:LineCounting + Parameters: + ElementItemDescription: + - Name: Segments + SimpleItemDescription: + - Name: ReportTimeInterval + Type: xs:duration + - Name: ResetTime + Type: xs:time + - Name: Direction + Type: tt:Direction + - Name: PassAllPolylines + Type: xs:boolean + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetSupportedRules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Rules: get: - description: Indicates whether or not a reboot is required after configuration - updates. + tags: + - Analytics - Rules + summary: GetRules + description: |- + List the currently assigned set of rules of a VideoAnalyticsConfiguration. + +
+ + **`jsonObject` Schema:** + + _See: [analytics_GetRules](#analytics_GetRules)_ + + ```yaml + { + "ConfigurationToken": "" + } + ``` parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + - name: jsonObject + in: query + schema: + type: string + example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/analytics_GetRulesResponse' example: apiVersion: v2 + statusCode: 200 event: apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: cb3b3a49-86e4-44e3-b2a0-426b08168ae1 - origin: 1659672882772484400 + id: 16f84c82-ee09-41bb-a012-27b46cff27fe + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 profileName: onvif-camera + sourceName: Rules + origin: 1665460089922944000 readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: f56f48df-d664-4179-98d1-abcb496f07bc - origin: 1659672882772484400 - profileName: onvif-camera - resourceName: RebootNeeded - value: 'false' - valueType: Bool - sourceName: RebootNeeded - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '507' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 04:14:42 GMT - type: string - X-Correlation-Id: - schema: - example: 88967d2b-dc04-4cd8-9cad-9c82c92ded44 - type: string - summary: RebootNeeded - tags: - - System Function - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RelativeMove: - put: - 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.' + - id: 2f46e1f1-6f39-449a-bd68-6387db6a1008 + origin: 1665460089922944000 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + resourceName: Rules + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Rule: + - Name: MyMotionDetectorRule + Parameters: + SimpleItem: + - Name: MinCount + Value: '5' + - Name: AlarmOnDelay + Value: '1000' + - Name: AlarmOffDelay + Value: '1000' + - Name: ActiveCells + Value: zwA= + Type: tt:CellMotionDetector + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.RelativeMove - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetRules + put: + tags: + - Analytics - Rules + summary: ModifyRules + description: >- + Modify one or more rules of a VideoAnalyticsConfiguration. The rules are + referenced by their names. requestBody: content: application/json: schema: - example: - RelativeMove: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' - Translation: - PanTilt: - x: 0 - y: 0 properties: - RelativeMove: - properties: - ProfileToken: - type: string - Translation: - properties: - PanTilt: - properties: - x: - type: number - y: - type: number - type: object - type: object - type: object + Rules: + $ref: '#/components/schemas/analytics_ModifyRules' + required: + - Rules type: object + example: + Rules: + ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + Rule: + - Name: MyMotionDetectorRule + Type: tt:ObjectInField + Parameters: + SimpleItem: + - Name: ClassFilter + Value: ' Bike Car Truck' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.ModifyRules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetRuleOptions: + get: + tags: + - Analytics - Rules + summary: GetRuleOptions + description: |- + Return the options for the supported rules that specify an Option attribute. + +
+ + **`jsonObject` Schema:** + + _See: [analytics_GetRuleOptions](#analytics_GetRuleOptions)_ + + ```yaml + { + "ConfigurationToken": "", + "RuleType": "" + } + ``` + parameters: + - name: jsonObject + in: query + schema: + type: string + example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': description: OK headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:25:28 GMT - type: string X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: 700ccf33-2db1-4646-9c7b-383910df2e23 - type: string - summary: RelativeMove - tags: - - PTZ - Actuation - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveConfiguration: - put: - 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. + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/analytics_GetRuleOptionsResponse' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: bf7a5fc7-7523-4690-87b7-273b2a373ed3 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + profileName: onvif-camera + sourceName: GetRuleOptions + origin: 1665460126357157600 + readings: + - id: 2bdd1ff4-7d2a-441b-bbc3-dfa50c27b096 + origin: 1665460126357157600 + deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + resourceName: GetRuleOptions + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + RuleOptions: + - MotionRegionConfigOptions: + DisarmSupport: false + PolygonLimits: + Max: 0 + Min: 0 + PolygonSupport: false + Name: MotionRegion + Type: axt:MotionRegionConfigOptions + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver20/media/wsdl/media.wsdl#op.RemoveConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetRuleOptions + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateRules: + put: + tags: + - Analytics - Rules + summary: CreateRules + 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. requestBody: content: application/json: schema: - example: - RemoveConfiguration: - Configuration: - - Token: '{{ANALYTIC_CONFIG_TOKEN}}' - Type: Analytics - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' properties: - RemoveConfiguration: - properties: - Configuration: - items: - properties: - Token: - type: string - Type: - type: string - type: object - type: array - ProfileToken: - type: string - type: object + CreateRules: + $ref: '#/components/schemas/analytics_CreateRules' + required: + - CreateRules type: object + example: + CreateRules: + ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + Rule: + - Name: Object Counting + Type: tt:LineCounting + Parameters: + SimpleItem: + - Name: Armed + Value: 'true' + ElementItem: + - Name: Segments + Polyline: + Point: + - x: '0.16' + y: '0.5' + - x: '0.16' + y: '-0.5' + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: {} - description: Successful response - summary: RemoveConfiguration - tags: - - Analytics - Profile Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveMetadataConfiguration: - put: - 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. + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.RemoveMetadataConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.CreateRules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteRules: + put: + tags: + - Analytics - Rules + summary: DeleteRules + description: Remove one or more rules from a VideoAnalyticsConfiguration. requestBody: content: application/json: schema: - example: - RemoveMetadataConfiguration: - ProfileToken: '{{MEDIA_PROFILE}}' properties: - RemoveMetadataConfiguration: - properties: - ProfileToken: - type: string - type: object + DeleteRules: + $ref: '#/components/schemas/analytics_DeleteRules' + required: + - DeleteRules type: object + example: + DeleteRules: + ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + RuleName: + - Object Counting + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.DeleteRules + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MACAddress: + get: + tags: + - Custom + summary: Get MACAddress + description: This command returns the MAC address associated with a device. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + $ref: '#/components/schemas/StringEventResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 23:13:48 GMT - type: string - X-Correlation-Id: - schema: - example: f591166b-b0ae-4c3e-8d87-3fa2fb0f180c - type: string - summary: RemoveMetadataConfiguration - tags: - - Metadata Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemovePTZConfiguration: + event: + apiVersion: v2 + id: 92336908-8de3-458b-9f0c-3a0d5daaf721 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: MACAddress + origin: 1659657259559177500 + readings: + - id: 6d54121c-2d9b-4d2f-ac14-29246fb15e31 + origin: 1659657259559177500 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: MACAddress + profileName: onvif-camera + valueType: String + value: 10:27:F5:EA:88:F4 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 put: - description: Remove a PTZConfiguration on the device. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.RemovePTZConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - Custom + summary: Set MACAddress + description: This command sets the MAC address associated with a device. requestBody: content: application/json: schema: - example: - RemovePTZConfiguration: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' properties: - RemovePTZConfiguration: - properties: - ProfileToken: - type: string - type: object + MACAddress: + type: string + required: + - MACAddress type: object + example: + MACAddress: 10-27-f5-ea-88-f4 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/FriendlyName: + get: + tags: + - Custom + summary: Get FriendlyName + description: >- + This operation is used by an endpoint to get the FriendlyName from a + device. This is a name given to a device by a user to make the device + more identifiable. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: '200': + description: OK + headers: + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' content: application/json: + schema: + $ref: '#/components/schemas/StringEventResponse' example: apiVersion: v2 statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object + event: + apiVersion: v2 + id: 0505a28a-0fd9-41d4-8044-784cc089894b + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: FriendlyName + origin: 1659657288410588400 + readings: + - id: 2d0def92-9e38-46bd-a72f-b512be4d5345 + origin: 1659657288410588400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: FriendlyName + profileName: onvif-camera + valueType: String + value: TP-Link C200 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + put: + tags: + - Custom + summary: Set FriendlyName + description: >- + This operation is used by an endpoint to set the FriendlyName of a + device. This is a name given to a device by a user to make the device + more identifiable. + requestBody: + content: + application/json: + schema: + properties: + FriendlyName: + type: string + required: + - FriendlyName + type: object + example: + FriendlyName: + FriendlyName: My Camera + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CustomMetadata: + get: + tags: + - Custom + summary: Get CustomMetadata + description: >- + This command returns the user specified custom metadata associated with + a device. + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + responses: + '200': description: OK headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:25:56 GMT - type: string X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: schema: - example: 95a3251e-41fb-45d5-9633-dc597a9f185c - type: string - summary: RemovePTZConfiguration - tags: - - PTZ - Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemovePreset: + $ref: '#/components/schemas/ObjectEventResponse' + examples: + example-0: + summary: Get CustomMetadata + value: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 6905a513-3aff-454b-981d-ea8e0c79f195 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + profileName: onvif-camera + sourceName: CustomMetadata + origin: 1663976147356099300 + readings: + - id: c90f88b6-7e2f-4e37-8fa7-b173a4d6ffec + origin: 1663976147356099300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + resourceName: CustomMetadata + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Business: John's Grocery Store + Install Date: 01/01/1970 + Location: Front door + example-1: + summary: GetSpecificCustomMetadata-multipleFields Copy + value: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 0749ab9c-05b4-4515-a2b0-5d253aeb8be9 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + profileName: onvif-camera + sourceName: CustomMetadata + origin: 1663976177486172000 + readings: + - id: 295d2e23-ffae-4c7e-9440-6be14fc1c93e + origin: 1663976177486172000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + resourceName: CustomMetadata + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Business: John's Grocery Store + Location: Front door + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 put: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.RemovePreset - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - Custom + summary: Set CustomMetadata requestBody: content: application/json: schema: - example: - RemovePreset: - PresetToken: Preset1 - ProfileToken: '{{MEDIA_PROFILE}}' properties: - RemovePreset: - properties: - PresetToken: - type: string - ProfileToken: - type: string + CustomMetadata: type: object + required: + - CustomMetadata type: object + example: + CustomMetadata: + Location: Front door + Business: John's Grocery Store + Install Date: 01/01/1970 + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '200': - content: - application/json: {} - description: Successful response - summary: RemovePreset - tags: - - PTZ - Preset - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveScopes: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteCustomMetadata: put: - 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 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.RemoveScopes - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: - type: string + tags: + - Custom + summary: Delete CustomMetadata requestBody: content: application/json: schema: - example: - RemoveScopes: - ScopeItem: - - onvif://www.onvif.org/name/Geovision properties: - RemoveScopes: - properties: - ScopeItem: - items: - type: string - type: array - type: object + DeleteCustomMetadata: + type: array + items: + type: string + required: + - DeleteCustomMetadata type: object + example: + DeleteCustomMetadata: + - Location + - Color + parameters: + - name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 responses: - '500': - content: - application/json: - example: - apiVersion: v2 - message: 'request failed, status code: 500, err: {"apiVersion":"v2","message":"error - writing DeviceResourece RemoveScopes for Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - -\u003e failed to execute write command, \u003cnil\u003e -\u003e - invalid request for the function ''RemoveScopes'' of web service - ''Device''. Onvif error: fault reason: Trying to Remove scope which - does not exist, fault detail: , fault code: s:Sender ter:InvalidArgVal - ter:NoScope","statusCode":500}' - statusCode: 500 - schema: - properties: - apiVersion: - type: string - message: - type: string - statusCode: - type: number - type: object - description: Internal Server Error - headers: - Content-Length: - schema: - example: '528' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Sun, 25 Sep 2022 03:41:12 GMT - type: string - X-Correlation-Id: - schema: - example: 1585c4fb-963a-4dc2-afa1-057559aedacc - type: string - summary: Remove Scopes - tags: - - Auto Discovery - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Rules: - get: - description: List the currently assigned set of rules of a VideoAnalyticsConfiguration. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.GetRules - parameters: - - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 +components: + schemas: + analytics_Capabilities: + properties: + AnalyticsModuleOptionsSupported: + description: Indication that the device supports the GetAnalyticsModuleOptions + operation on the analytics interface + type: boolean + AnalyticsModuleSupport: + description: Indication that the device supports the scene analytics module + interface. + type: boolean + CellBasedSceneDescriptionSupported: + description: Indication that the device produces the cell based scene description + type: boolean + ImageSendingType: + description: Indication what kinds of method that the device support for + sending image, acceptable values are defined in tt:ImageSendingType. + type: string + RuleOptionsSupported: + description: Indication that the device supports the GetRuleOptions operation + on the rules interface + type: boolean + RuleSupport: + description: Indication that the device supports the rules interface and + the rules syntax. + type: boolean + SupportedMetadata: + description: Indication that the device supports the GetSupportedMetadata + operation. + type: boolean + type: object + analytics_ConfigOptions: + properties: + AnalyticsModule: + 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. + type: string + Name: + description: "The Name of the SimpleItemDescription/ElementItemDescription\n\ + \t\t\t\t\t\t\tthe ConfigOptions applies to." + type: string + RuleType: + description: The RuleType the ConfigOptions applies to if the Name attribute + is ambiguous. + type: string + Type: + 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." + type: string + maxOccurs: + description: Maximum number of occurrences. Defaults to one. + format: int32 + type: integer + minOccurs: + description: Minimal number of occurrences. Defaults to one. + format: int32 + type: integer + required: + - Name + type: object + analytics_CreateAnalyticsModules: + properties: + AnalyticsModule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + required: + - ConfigurationToken + - AnalyticsModule + type: object + analytics_CreateAnalyticsModulesResponse: + type: object + analytics_CreateRules: + properties: + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + Rule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + required: + - ConfigurationToken + - Rule + type: object + analytics_CreateRulesResponse: + type: object + analytics_DeleteAnalyticsModules: + properties: + AnalyticsModuleName: + description: Name of the AnalyticsModule to be deleted. + items: type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + ConfigurationToken: + description: Reference to an existing Video Analytics configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + - AnalyticsModuleName + type: object + analytics_DeleteAnalyticsModulesResponse: + type: object + analytics_DeleteRules: + properties: + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + RuleName: + description: References the specific rule to be deleted (e.g. "MyLineDetector"). + items: type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 16f84c82-ee09-41bb-a012-27b46cff27fe - origin: 1665460089922944000 - profileName: onvif-camera - readings: - - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 - id: 2f46e1f1-6f39-449a-bd68-6387db6a1008 - objectValue: - Rule: - - Name: MyMotionDetectorRule - Parameters: - SimpleItem: - - Name: MinCount - Value: '5' - - Name: AlarmOnDelay - Value: '1000' - - Name: AlarmOffDelay - Value: '1000' - - Name: ActiveCells - Value: zwA= - Type: tt:CellMotionDetector - origin: 1665460089922944000 - profileName: onvif-camera - resourceName: Rules - value: '' - valueType: Object - sourceName: Rules - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Rule: - items: - properties: - Name: - type: string - Parameters: - properties: - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - required: - - Name - - Value - type: object - type: array - type: object - Type: - type: string - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '763' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:48:09 GMT - type: string - X-Correlation-Id: - schema: - example: 1f4cb445-5625-41f0-abc3-a2a243f0b82b - type: string - summary: GetRules - tags: - - Analytics - Rules - put: - description: Modify one or more rules of a VideoAnalyticsConfiguration. The - rules are referenced by their names. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/analytics/wsdl/analytics.wsdl#op.ModifyRules - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + required: + - ConfigurationToken + - RuleName + type: object + analytics_DeleteRulesResponse: + type: object + analytics_GetAnalyticsModuleOptions: + properties: + ConfigurationToken: + description: Reference to an existing AnalyticsConfiguration. + maxLength: 64 + type: string + Type: + description: Reference to an SupportedAnalyticsModule Type returned from + GetSupportedAnalyticsModules. + type: string + required: + - ConfigurationToken + type: object + analytics_GetAnalyticsModuleOptionsResponse: + properties: + Options: + description: List of options for the specified analytics module. The response + Options shall not contain any RuleType attribute. + items: + $ref: '#/components/schemas/analytics_ConfigOptions' + type: array + type: object + analytics_GetAnalyticsModules: + properties: + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + analytics_GetAnalyticsModulesResponse: + properties: + AnalyticsModule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + type: object + analytics_GetRuleOptions: + properties: + ConfigurationToken: + description: Reference to an existing analytics configuration. + maxLength: 64 + type: string + RuleType: + description: Reference to an SupportedRule Type returned from GetSupportedRules. + type: string + required: + - ConfigurationToken + type: object + analytics_GetRuleOptionsResponse: + properties: + RuleOptions: + 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. + items: + $ref: '#/components/schemas/analytics_ConfigOptions' + type: array + type: object + analytics_GetRules: + properties: + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + analytics_GetRulesResponse: + properties: + Rule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + type: object + analytics_GetServiceCapabilities: + type: object + analytics_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/analytics_Capabilities' + - description: The capabilities for the analytics service is returned in + the Capabilities element. + required: + - Capabilities + type: object + analytics_GetSupportedAnalyticsModules: + properties: + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + analytics_GetSupportedAnalyticsModulesResponse: + properties: + SupportedAnalyticsModules: + $ref: '#/components/schemas/onvif_SupportedAnalyticsModules' + required: + - SupportedAnalyticsModules + type: object + analytics_GetSupportedMetadata: + properties: + Type: + description: Optional reference to an AnalyticsModule Type returned from + GetSupportedAnalyticsModules. + type: string + type: object + analytics_GetSupportedMetadataResponse: + properties: + AnalyticsModule: + items: + $ref: '#/components/schemas/analytics_MetadataInfo' + type: array + type: object + analytics_GetSupportedRules: + properties: + ConfigurationToken: + 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." + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + analytics_GetSupportedRulesResponse: + properties: + SupportedRules: + $ref: '#/components/schemas/onvif_SupportedRules' + required: + - SupportedRules + type: object + analytics_MetadataInfo: + properties: + SampleFrame: + allOf: + - $ref: '#/components/schemas/onvif_Frame' + - description: Sample frame content starting with the tt:Frame node. + Type: + description: Reference to an AnalyticsModule Type. + type: string + required: + - Type + - SampleFrame + type: object + analytics_ModifyAnalyticsModules: + properties: + AnalyticsModule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + required: + - ConfigurationToken + - AnalyticsModule + type: object + analytics_ModifyAnalyticsModulesResponse: + type: object + analytics_ModifyRules: + properties: + ConfigurationToken: + description: Reference to an existing VideoAnalyticsConfiguration. + maxLength: 64 + type: string + Rule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + required: + - ConfigurationToken + - Rule + type: object + analytics_ModifyRulesResponse: + type: object + bd_Bag: + properties: + Category: + description: Describe the Category of the Bag, acceptable values are defined + in bd:KnapsackCategory. + type: string + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Colour of the Bag, acceptable values are defined + in tt:ColorDescriptor. + type: object + bd_Behaviour: + properties: + Activity: + description: Describe the activity of the body, Acceptable values are defined + in bd:HumanActivity. + type: string + Smoking: + description: Acceptable values are defined in bd:Smoking. + type: string + UsingMobile: + description: Acceptable values are defined in bd:UsingMobile. + type: string + type: object + bd_Belonging: + properties: + Bag: + allOf: + - $ref: '#/components/schemas/bd_Bag' + - description: Describe the Bag of the body,acceptable values are defined + in bd:Bag + Box: + allOf: + - $ref: '#/components/schemas/bd_Box' + - description: Describe the Box luffed by the body,acceptable values are + defined in bd:Box. + Cart: + allOf: + - $ref: '#/components/schemas/bd_Cart' + - description: Describe the Cart pushed by the body,acceptable values are + defined in bd:Cart. + LiftSomething: + description: Describe if the body Lifts something. + type: boolean + Umbrella: + allOf: + - $ref: '#/components/schemas/bd_Umbrella' + - description: Describe the Umbrella carried by the body,acceptable values + are defined in bd:Umbrella. + Weapon: + description: Describe if the body carries the Weapon. + type: boolean + type: object + bd_BodyMetric: + properties: + BodyShape: + description: Describle the Shape of the body, acceptable values are defined + in bd:BodyShape. + type: string + Height: + description: Describe the Stature of the body, the unit is centimeter. + format: int32 + type: integer + type: object + bd_BodyShape: + enum: + - Fat + - Thin + - Other + type: string + bd_Bottoms: + properties: + Category: + description: Describe the Category of the Bottoms, acceptable values are + defined in bd:BottomsCategory. + type: string + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Bottoms, acceptable values are + defined in tt:ColorDescriptor. + Grain: + description: Describe the Grain of the Bottoms, acceptable values are defined + in bd:Grain. + type: string + Style: + description: Describe the Style of the Bottoms, acceptable values are defined + in bd:BottomsStyle. + type: string + type: object + bd_BottomsCategory: + enum: + - Trousers + - Shorts + - Skirt + - Other + type: string + bd_BottomsStyle: + enum: + - FornalPants + - Jeans + - Other + type: string + bd_Box: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Box, acceptable values are defined + in tt:ColorDescriptor. + Lug: + description: Describe if the body Lugs the Box. + type: boolean + type: object + bd_Cart: + properties: + Category: + description: Describe the Category of the Cart, acceptable values are defined + in bd:CartCategory. + type: string + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Cart, acceptable values are defined + in tt:ColorDescriptor. + type: object + bd_CartCategory: + enum: + - BabyCarriage + - TwoWheelVehicle + - Tricyle + - Other + type: string + bd_Clothing: + properties: + Bottoms: + allOf: + - $ref: '#/components/schemas/bd_Bottoms' + - description: Describe the Bottoms of the body,acceptable values are defined + in bd:Bottoms. + Gloves: + allOf: + - $ref: '#/components/schemas/bd_Gloves' + - description: Describe Gloves of the body,acceptable values are defined + in bd:Gloves. + Scarf: + allOf: + - $ref: '#/components/schemas/bd_Scarf' + - description: Describe the Scarf of the body,acceptable values are defined + in bd:Scarf. + Shoes: + allOf: + - $ref: '#/components/schemas/bd_Shoes' + - description: Describe the Shoes of the body,acceptable values are defined + in bd:Shoes. + Tops: + allOf: + - $ref: '#/components/schemas/bd_Tops' + - description: Describe the Tops of the body,acceptable values are defined + in bd:Tops. + type: object + bd_Gloves: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of Gloves, acceptable values are defined + in tt:ColorDescriptor. + Wear: + description: Describe if the body wears Gloves. + type: boolean + type: object + bd_Grain: + enum: + - Stria + - Plaid + - PureColour + - Decal + - Other + type: string + bd_HumanActivity: + enum: + - Walking + - Running + - Fallen + - Squatting + - Sitting + - Standing + - Driving + - Other + type: string + bd_HumanBody: + properties: + Behaviour: + allOf: + - $ref: '#/components/schemas/bd_Behaviour' + - description: Describe the Behaviour of the body. + Belonging: + allOf: + - $ref: '#/components/schemas/bd_Belonging' + - description: Describe the Belonging of the body. + BodyMetric: + allOf: + - $ref: '#/components/schemas/bd_BodyMetric' + - description: Describe the body metric of the body. + Clothing: + allOf: + - $ref: '#/components/schemas/bd_Clothing' + - description: Describe the Clothing of the body. + type: object + bd_KnapsackCategory: + enum: + - SingleShoulderBag + - Backpack + - Other + type: string + bd_Scarf: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Scarf, acceptable values are defined + in ColorDescriptor. + Wear: + description: Describe if the body wears the Scarf. + type: boolean + type: object + bd_Shoes: + properties: + Category: + description: Describe the Category of the Shoes, acceptable values are defined + in bd:ShoesCategory. + type: string + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Shoes, acceptable values are defined + in tt:ColorDescriptor. + type: object + bd_ShoesCategory: + enum: + - LeatherShoes + - Sneakers + - Sandal + - Slipper + - Other + type: string + bd_Smoking: + enum: + - NoSmoking + - Cigar + - ElectronicCigarettes + - Other + type: string + bd_Tops: + properties: + Category: + description: Describe the Category of the Tops, acceptable values are defined + in bd:TopsCategory. + type: string + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Tops, acceptable values are defined + in tt:ColorDescriptor. + Grain: + description: Describe the Grain of the Tops, acceptable values are defined + in bd:Grain. + type: string + Style: + description: Describe the Style of the Tops, acceptable values are defined + in bd:TopsStyle. + type: string + type: object + bd_TopsCategory: + enum: + - LongSleeve + - ShortSleeve + - Other + type: string + bd_TopsStyle: + enum: + - Tailor + - Jacket + - Sweater + - Overcoat + - Dress + - Other + type: string + bd_Umbrella: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the Bag, acceptable values are defined + in tt:ColorDescriptor. + Open: + description: Describe if the body Opens the Umbrella. + type: boolean + type: object + bd_UsingMobile: + enum: + - ByLeftHand + - ByRightHand + - Other + type: string + fc_Accessory: + properties: + Hat: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear hat. + Helmet: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear Helmet. + Hijab: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear hijab. + Kerchief: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear Kerchief. + LeftEyePatch: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if there is a patch on the left eye. + Mask: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear mask. + Opticals: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if the object wear opticals. + RightEyePatch: + allOf: + - $ref: '#/components/schemas/fc_AccessoryDescription' + - description: Describe if there is a patch on the right eye. + type: object + fc_AccessoryDescription: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the accessory. + Wear: + description: Describe if the object wear a accessory . + type: boolean + type: object + fc_AdditionalFeatures: + properties: + Freckles: + description: Describe freckles on the face, acceptable values are defined + in fc:FrecklesType. + type: string + Mole: + description: Is there mole on the face. + type: boolean + Scar: + description: Is there scar on the face. + type: boolean + Tattoo: + description: Is there Tattoo on the face. + type: boolean + type: object + fc_Chin: + enum: + - Double + - Pointed + - Round + type: string + fc_Complexion: + enum: + - White + - Black + - Asian + - Other + type: string + fc_Ear: + enum: + - Round + - Pointed + - Narrow + - BroadLobe + - Other + type: string + fc_Expression: + enum: + - Natural + - Smile + - RaisedEyebrows + - Squint + - Frown + - Other + type: string + fc_Eye: + properties: + Eyeball: + description: Describe the eyeball of the eye, acceptable values are defined + in fc:Eyeball. + type: string + Eyelid: + description: Describe the eyelid of the eye, acceptable values are defined + in fc:Eyelid. + type: string + Shape: + description: Describe the shape of the eye, acceptable values are defined + in fc:EyeBrowShape. + type: string + type: object + fc_EyeShape: + enum: + - Almond + - Slitty + - Round + - Other + type: string + fc_Eyeball: + enum: + - Black + - Blue + - Brown + - Gray + - Green + - Pink + - Other + type: string + fc_Eyebrow: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the Color of the eyebrow. + Space: + description: Describe the space of two eyebrows, acceptable values are defined + in fc:EyebrowSpace. + type: string + Width: + description: "Describe the shape of the eyebrow, Short usually means that\ + \ the width of eye brow is shorter than the length of eye.\n\n\t\t\t\t\ + Long usually means that the width of eye brow is equal to or longer than\ + \ the length of eye.acceptable values are defined in fc:EyebrowWidth." + type: string + type: object + fc_EyebrowSpace: + enum: + - Joint + - Separate + type: string + fc_EyebrowWidth: + enum: + - Long + - Short + type: string + fc_Eyelid: + enum: + - Single + - Double + - Other + type: string + fc_FacialHair: + properties: + Beard: + description: Describe if there are Beard on the face. + type: boolean + Mustache: + description: Describe if there is mustache on the face. + type: boolean + Sideburn: + description: Describe if there are sideburns on the face. + type: boolean + type: object + fc_FacialShape: + enum: + - Long + - Round + - Square + - Oval + - Other + type: string + fc_FrecklesType: + enum: + - AroundCheek + - Nose + - forehead + - Other + type: string + fc_Gender: + enum: + - Male + - Female + type: string + fc_Hair: + properties: + Bangs: + description: Describe the bangs of the Hair + type: boolean + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorDescriptor' + - description: Describe the color of the Hair. + Length: + 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. \r\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." + type: string + Style: + description: Describe the style of the Hair, acceptable values are defined + in fc:HairStyle. + type: string + type: object + fc_HairStyle: + enum: + - Straight + - Wave + - Curly + - CrewCut + - Bald + - Ponytail + - Pigtail + - Other + type: string + fc_HumanFace: + properties: + Accessory: + allOf: + - $ref: '#/components/schemas/fc_Accessory' + - description: Describe the Accessory of the face. + AdditionalFeatures: + allOf: + - $ref: '#/components/schemas/fc_AdditionalFeatures' + - description: Describe the other features, eg scar, mole etc of the face. + Age: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Describe the age of the face. + Chin: + description: Describe the Chin of the face, acceptable values are defined + in fc:Chin. + type: string + Complexion: + description: Describe the complexion of the face, acceptable values are + defined in fc:Complexion. + type: string + Ear: + allOf: + - $ref: '#/components/schemas/fc_Ear' + - description: Describe the Ear of the face. + Expression: + description: Describe the expression on the face, acceptable values are + defined in fc:Expression. + type: string + Eye: + allOf: + - $ref: '#/components/schemas/fc_Eye' + - description: Describe the eye of the face. + Eyebrow: + allOf: + - $ref: '#/components/schemas/fc_Eyebrow' + - description: Describe the eyebrow of the face. + FacialHair: + allOf: + - $ref: '#/components/schemas/fc_FacialHair' + - description: Describe the facial hair of the face. + FacialShape: + description: Describe the FacialShape, acceptable values are defined fc:FacialShape. + type: string + Gender: + description: Describe the gender of the face, acceptable values are defined + in fc:Gender. + type: string + Hair: + allOf: + - $ref: '#/components/schemas/fc_Hair' + - description: Describe the hair of the face. + Lip: + description: Describe the lip of the face, acceptable values are defined + in fc:Lip. + type: string + Nose: + allOf: + - $ref: '#/components/schemas/fc_Nose' + - description: Describe the nose of the face. + PoseAngle: + allOf: + - $ref: '#/components/schemas/fc_PoseAngle' + - description: Describe the pose angle of the face. + Temperature: + description: Describe the temperature of the face, in Kelvin. + type: number + type: object + fc_Length: + enum: + - Long + - Medium + - Short + type: string + fc_Lip: + enum: + - Full + - Medium + - Thin + type: string + fc_Nose: + properties: + Length: + description: "Describe the length of the nose, acceptable values are defined\ + \ in fc:NoseLength. \r\n\t\t\t\tLong usually means that the length of\ + \ the nose is longer than 1/3 of the length of the face.\r\n\t\t\t\tshort\ + \ usually means that the length of the nose is shorter than 1/3 of the\ + \ length of the face." + type: string + NoseBridge: + description: Describe the bridge of the nose, acceptable values are defined + in fc:NoseBridge. + type: string + NoseEnd: + description: Describe the end of the nose, acceptable values are defined + in fc:NoseEnd. + type: string + NoseWing: + description: Describe the wing of the nose, acceptable values are defined + in fc:NoseWing. + type: string + type: object + fc_NoseBridge: + enum: + - Straight + - Arch + type: string + fc_NoseEnd: + enum: + - Snub + - Turnedup + - Flat + - Hooked + - Other + type: string + fc_NoseLength: + enum: + - Short + - Long + type: string + fc_NoseWing: + enum: + - Narrow + - Broad + type: string + fc_PoseAngle: + properties: + PoseAngles: + allOf: + - $ref: '#/components/schemas/onvif_GeoOrientation' + - description: Describe the pose angle of the face. + Uncertainty: + allOf: + - $ref: '#/components/schemas/onvif_GeoOrientation' + - description: Describe the expected degree of uncertainty of the pose angle + yaw, pitch, and roll. + type: object + onvif_AACDecOptions: + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported bitrates in kbps + SampleRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported sample rates in kHz + required: + - Bitrate + - SampleRateRange + type: object + onvif_AFModes: + enum: + - OnceAfterMove + type: string + onvif_AbsoluteFocus: + properties: + Position: + description: Position parameter for the absolute focus control. + type: number + Speed: + description: Speed parameter for the absolute focus control. + type: number + required: + - Position + type: object + onvif_AbsoluteFocusOptions: + properties: + Position: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the position. + Speed: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the speed. + required: + - Position + type: object + onvif_ActionEngineEventPayload: + description: Action Engine Event Payload data structure contains the information + about the ONVIF command invocations. Since this event could be generated by + other or proprietary actions, the command invocation specific fields are defined + as optional and additional extension mechanism is provided for future or additional + action definitions. + properties: + Extension: + $ref: '#/components/schemas/onvif_ActionEngineEventPayloadExtension' + Fault: + allOf: + - $ref: '#/components/schemas/soapenv_Fault' + - description: Fault Message + RequestInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Request Message + ResponseInfo: + allOf: + - $ref: '#/components/schemas/soapenv_Envelope' + - description: Response Message + type: object + onvif_ActionEngineEventPayloadExtension: + type: object + onvif_ActiveConnection: + properties: + CurrentBitrate: + type: number + CurrentFps: + type: number + required: + - CurrentBitrate + - CurrentFps + type: object + onvif_AnalyticsCapabilities: + properties: + AnalyticsModuleSupport: + description: Indicates whether or not modules are supported. + type: boolean + RuleSupport: + description: Indicates whether or not rules are supported. + type: boolean + XAddr: + description: Analytics service URI. + type: string + required: + - XAddr + - RuleSupport + - AnalyticsModuleSupport + type: object + onvif_AnalyticsDeviceCapabilities: + properties: + Extension: + $ref: '#/components/schemas/onvif_AnalyticsDeviceExtension' + RuleSupport: + description: Obsolete property. + type: boolean + XAddr: + type: string + required: + - XAddr + type: object + onvif_AnalyticsDeviceEngineConfiguration: + properties: + EngineConfiguration: + items: + $ref: '#/components/schemas/onvif_EngineConfiguration' + type: array + Extension: + $ref: '#/components/schemas/onvif_AnalyticsDeviceEngineConfigurationExtension' + required: + - EngineConfiguration + type: object + onvif_AnalyticsDeviceEngineConfigurationExtension: + type: object + onvif_AnalyticsDeviceExtension: + type: object + onvif_AnalyticsEngine: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + AnalyticsEngineConfiguration: + $ref: '#/components/schemas/onvif_AnalyticsDeviceEngineConfiguration' + required: + - AnalyticsEngineConfiguration + type: object + onvif_AnalyticsEngineConfiguration: + properties: + AnalyticsModule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + Extension: + $ref: '#/components/schemas/onvif_AnalyticsEngineConfigurationExtension' + type: object + onvif_AnalyticsEngineConfigurationExtension: + type: object + onvif_AnalyticsEngineControl: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + EngineConfigToken: + description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) + in effect. + maxLength: 64 type: string - requestBody: - content: - application/json: - schema: - example: - Rules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' - Rule: - - Name: MyMotionDetectorRule - Parameters: - SimpleItem: - - Name: ClassFilter - Value: ' Bike Car Truck' - Type: tt:ObjectInField - properties: - Rules: - properties: - ConfigurationToken: - type: string - Rule: - items: - properties: - Name: - type: string - Parameters: - properties: - SimpleItem: - items: - properties: - Name: - type: string - Value: - type: string - type: object - type: array - type: object - Type: - type: string - type: object - type: array - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Tue, 11 Oct 2022 03:50:16 GMT - type: string - X-Correlation-Id: - schema: - example: ea1d0040-3a30-4fbb-a0ac-50a1b90f3e36 - type: string - summary: ModifyRules - tags: - - Analytics - Rules - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Scopes: - get: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetScopes - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + EngineToken: + description: Token of the analytics engine (AnalyticsEngine) being controlled. + maxLength: 64 type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 05f573f4-0836-45ad-b9ba-c393f9927586 - origin: 1659659228090509000 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: ea858652-cb16-432c-bf45-f9785cd00d85 - objectValue: - Scopes: - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/name/TP-IPC - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/hardware/MODEL - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/Profile/Streaming - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/location/ShenZhen - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/type/NetworkVideoTransmitter - origin: 1659659228090509000 - profileName: onvif-camera - resourceName: Scopes - value: '' - valueType: Object - sourceName: Scopes - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Scopes: - items: - properties: - ScopeDef: - type: string - ScopeItem: - type: string - required: - - ScopeDef - - ScopeItem - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '896' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:27:08 GMT - type: string - X-Correlation-Id: - schema: - example: 966fc4b2-a648-4bef-91fc-2aaf9f9310a7 - type: string - summary: Get Scopes - tags: - - Auto Discovery - put: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetScopes - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + InputToken: + description: Tokens of the input (AnalyticsEngineInput) configuration + applied. + items: + maxLength: 64 + type: string + type: array + Mode: + $ref: '#/components/schemas/onvif_ModeOfOperation' + Multicast: + $ref: '#/components/schemas/onvif_MulticastConfiguration' + ReceiverToken: + description: Tokens of the receiver providing media input data. The order + of ReceiverToken shall exactly match the order of InputToken. + items: + maxLength: 64 + type: string + type: array + Subscription: + $ref: '#/components/schemas/onvif_Config' + required: + - EngineToken + - EngineConfigToken + - InputToken + - ReceiverToken + - Subscription + - Mode + type: object + onvif_AnalyticsEngineInput: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + MetadataInput: + $ref: '#/components/schemas/onvif_MetadataInput' + SourceIdentification: + $ref: '#/components/schemas/onvif_SourceIdentification' + VideoInput: + $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + required: + - SourceIdentification + - VideoInput + - MetadataInput + type: object + onvif_AnalyticsEngineInputInfo: + properties: + Extension: + $ref: '#/components/schemas/onvif_AnalyticsEngineInputInfoExtension' + InputInfo: + $ref: '#/components/schemas/onvif_Config' + type: object + onvif_AnalyticsEngineInputInfoExtension: + type: object + onvif_AnalyticsState: + properties: + Error: + type: string + State: + type: string + required: + - State + type: object + onvif_AnalyticsStateInformation: + properties: + AnalyticsEngineControlToken: + description: Token of the control object whose status is requested. + maxLength: 64 + type: string + State: + $ref: '#/components/schemas/onvif_AnalyticsState' + required: + - AnalyticsEngineControlToken + - State + type: object + onvif_AnyHolder: + type: object + onvif_Appearance: + properties: + Class: + $ref: '#/components/schemas/onvif_ClassDescriptor' + Color: + $ref: '#/components/schemas/onvif_ColorDescriptor' + Extension: + $ref: '#/components/schemas/onvif_AppearanceExtension' + GeoLocation: + $ref: '#/components/schemas/onvif_GeoLocation' + HumanBody: + $ref: '#/components/schemas/bd_HumanBody' + HumanFace: + $ref: '#/components/schemas/fc_HumanFace' + Image: + format: binary + type: string + ImageRef: + type: string + LicensePlateInfo: + $ref: '#/components/schemas/onvif_LicensePlateInfo' + Shape: + $ref: '#/components/schemas/onvif_ShapeDescriptor' + Transformation: + $ref: '#/components/schemas/onvif_Transformation' + VehicleInfo: + items: + $ref: '#/components/schemas/onvif_VehicleInfo' + type: array + type: object + onvif_AppearanceExtension: + type: object + onvif_ArrayOfFileProgress: + properties: + Extension: + $ref: '#/components/schemas/onvif_ArrayOfFileProgressExtension' + FileProgress: + description: Exported file name and export progress information + items: + $ref: '#/components/schemas/onvif_FileProgress' + type: array + type: object + onvif_ArrayOfFileProgressExtension: + type: object + onvif_AttachmentData: + properties: + Include: + $ref: '#/components/schemas/xop_Include' + contentType: + minLength: 3 + type: string + required: + - Include + type: object + onvif_AudioAnalyticsStream: + properties: + AudioDescriptor: + items: + $ref: '#/components/schemas/onvif_AudioDescriptor' + type: array + Extension: + $ref: '#/components/schemas/onvif_AudioAnalyticsStreamExtension' + type: object + onvif_AudioAnalyticsStreamExtension: + type: object + onvif_AudioAttributes: + properties: + Bitrate: + description: The bitrate in kbps. + format: int32 + type: integer + Encoding: + description: Audio encoding of the track. Use values from tt:AudioEncoding + for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames + and + type: string + Samplerate: + description: The sample rate in kHz. + format: int32 + type: integer + required: + - Encoding + - Samplerate + type: object + onvif_AudioClassCandidate: + properties: + Likelihood: + description: A likelihood/probability that the corresponding audio event + belongs to this class. The sum of the likelihoods shall NOT exceed 1 + type: number + Type: + allOf: + - $ref: '#/components/schemas/onvif_AudioClassType' + - description: Indicates audio class label + required: + - Type + - Likelihood + type: object + onvif_AudioClassDescriptor: + properties: + ClassCandidate: + description: Array of audio class label and class probability + items: + $ref: '#/components/schemas/onvif_AudioClassCandidate' + type: array + Extension: + $ref: '#/components/schemas/onvif_AudioClassDescriptorExtension' + type: object + onvif_AudioClassDescriptorExtension: + type: object + onvif_AudioClassType: + description: "AudioClassType acceptable values are;\n\t\t gun_shot, scream,\ + \ glass_breaking, tire_screech" + enum: + - gun_shot + - scream + - glass_breaking + - tire_screech + type: string + onvif_AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - type: object + 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)." + onvif_AudioDecoderConfigurationOptions: + properties: + AACDecOptions: + allOf: + - $ref: '#/components/schemas/onvif_AACDecOptions' + - description: If the device is able to decode AAC encoded audio this section + describes the supported configurations + Extension: + $ref: '#/components/schemas/onvif_AudioDecoderConfigurationOptionsExtension' + G711DecOptions: + allOf: + - $ref: '#/components/schemas/onvif_G711DecOptions' + - description: If the device is able to decode G711 encoded audio this section + describes the supported configurations + G726DecOptions: + allOf: + - $ref: '#/components/schemas/onvif_G726DecOptions' + - description: If the device is able to decode G726 encoded audio this section + describes the supported configurations + type: object + onvif_AudioDecoderConfigurationOptionsExtension: + type: object + onvif_AudioDescriptor: + properties: + UtcTime: + format: date-time + type: string + required: + - UtcTime + type: object + onvif_AudioEncoder2Configuration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Bitrate: + description: The output bitrate in kbps. + format: int32 + type: integer + Encoding: + description: Audio Media Subtype for the audio format. For definitions + see tt:AudioEncodingMimeNames and type: string - requestBody: - content: - application/json: - schema: - example: - Scopes: - Scopes: - - http//:123 - properties: - Scopes: - properties: - Scopes: - items: - type: string - type: array - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Sun, 25 Sep 2022 03:41:08 GMT - type: string - X-Correlation-Id: - schema: - example: 0fa69e08-5b67-4b92-93c8-7cb642c2f43c - type: string - summary: Put Scopes - tags: - - Auto Discovery - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SendAuxiliaryCommand: - put: - 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.\n\nThe supported commands can be retrieved via the AuxiliaryCommands\ - \ capability.\n\nAlthough 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.\ntt:Wiper|On \u2013 Request to start the wiper.\ntt:Wiper|Off \u2013\ - \ Request to stop the wiper.\ntt:Washer|On \u2013 Request to start the washer.\n\ - tt:Washer|Off \u2013 Request to stop the washer.\ntt:WashingProcedure|On \u2013\ - \ Request to start the washing procedure.\ntt: WashingProcedure |Off \u2013\ - \ Request to stop the washing procedure.\ntt:IRLamp|On \u2013 Request to turn\ - \ ON an IR illuminator attached to the unit.\ntt:IRLamp|Off \u2013 Request\ - \ to turn OFF an IR illuminator attached to the unit.\ntt:IRLamp|Auto \u2013\ - \ Request to configure an IR illuminator attached to the unit so that it automatically\ - \ turns ON and OFF.\nA device that indicates auxiliary service capability\ - \ shall support this command." - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SendAuxiliaryCommand - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + SampleRate: + description: The output sample rate in kHz. + format: int32 + type: integer + required: + - Encoding + - Bitrate + - SampleRate + type: object + onvif_AudioEncoder2ConfigurationOptions: + properties: + BitrateList: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + Encoding: + description: Audio Media Subtype for the audio format. For definitions see + tt:AudioEncodingMimeNames and + type: string + SampleRateList: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + required: + - Encoding + - BitrateList + - SampleRateList + type: object + onvif_AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Bitrate: + description: The output bitrate in kbps. + format: int32 + type: integer + Encoding: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, + G.726 or AAC) + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + SampleRate: + description: The output sample rate in kHz. + format: int32 + type: integer + SessionTimeout: + description: The rtsp session timeout for the related audio stream + format: date-time type: string - requestBody: - content: - application/json: - schema: - example: - SendAuxiliaryCommand: - AuxiliaryData: '123' - ProfileToken: '{{MEDIA_PROFILE}}' - properties: - SendAuxiliaryCommand: - properties: - AuxiliaryData: - type: string - ProfileToken: - type: string - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 18:27:09 GMT - type: string - X-Correlation-Id: - schema: - example: 417c8635-cb74-47de-bbdc-4d96df27fcb5 - type: string - summary: SendAuxiliaryCommand - tags: - - PTZ - Auxiliary - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetHomePosition: - put: - description: "Operation to save current position as the home position. The SetHomePosition\ - \ command returns with a failure if the \u201Chome\u201D position is fixed\ - \ and cannot be overwritten. If the SetHomePosition is successful, it is possible\ - \ to recall the Home Position with the GotoHomePosition command." - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SetHomePosition - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + onvif_AudioEncoderConfigurationOption: + properties: + BitrateList: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported bitrates in kbps for the specified Encoding + Encoding: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoding' + - description: The enoding used for audio data (either G.711, G.726 or AAC) + SampleRateList: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported Sample Rates in kHz for the specified Encoding + required: + - Encoding + - BitrateList + - SampleRateList + type: object + onvif_AudioEncoderConfigurationOptions: + properties: + Options: + description: list of supported AudioEncoderConfigurations + items: + $ref: '#/components/schemas/onvif_AudioEncoderConfigurationOption' + type: array + type: object + onvif_AudioEncoding: + enum: + - G711 + - G726 + - AAC + type: string + onvif_AudioEncodingMimeNames: + description: Audio Media Subtypes as referenced by IANA (without the leading + "audio/" Audio Media Type and except for the audio types defined in the restriction). See + also + enum: + - PCMU + - G726 + - MP4A-LATM + - mpeg4-generic + type: string + onvif_AudioOutput: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - type: object + description: Representation of a physical audio outputs. + onvif_AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + OutputLevel: + description: Volume setting of the output. The applicable range is defined + via the option AudioOutputOptions.OutputLevelRange. + format: int32 + type: integer + OutputToken: + description: Token of the phsycial Audio output. + maxLength: 64 type: string - requestBody: - content: - application/json: - schema: - example: - SetHomePosition: - ProfileToken: '{{MEDIA_PROFILE}}' - properties: - SetHomePosition: - properties: - ProfileToken: - type: string - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:28:04 GMT - type: string - X-Correlation-Id: - schema: - example: fc56acaa-b0e3-4bea-8781-1ebdf5aabc7c - type: string - summary: SetHomePosition - tags: - - PTZ - Home Position - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetPreset: - put: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.SetPreset - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + SendPrimacy: + 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." type: string - requestBody: - content: - application/json: - schema: - example: - SetPreset: - PresetName: Preset1 - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' - properties: - SetPreset: - properties: - PresetName: - type: string - ProfileToken: - type: string - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 18:27:55 GMT - type: string - X-Correlation-Id: - schema: - example: 92a2b03e-65ed-4551-bd2d-64bc97f6c83c - type: string - summary: SetPreset - tags: - - PTZ - Preset - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetSystemFactoryDefault: - put: - description: This operation reloads the parameters on the device to their factory - default values. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemFactoryDefault - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + required: + - OutputToken + - OutputLevel + type: object + onvif_AudioOutputConfigurationOptions: + properties: + OutputLevelRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Minimum and maximum level range supported for this Output. + OutputTokensAvailable: + description: Tokens of the physical Audio outputs (typically one). + items: + maxLength: 64 type: string - requestBody: - content: - application/json: - schema: - example: - SetSystemFactoryDefault: - FactoryDefault: Soft - properties: - SetSystemFactoryDefault: - properties: - FactoryDefault: - type: string - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:27:07 GMT - type: string - X-Correlation-Id: - schema: - example: fb9339bb-b588-49f8-82b1-d0da167897c0 - type: string - summary: SetSystemFactoryDefault - tags: - - System Function - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Snapshot: - get: - description: 'This request returns a snapshot of the video stream at the time - the command is given. - - - It is returned in a binary format.' - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + SendPrimacyOptions: + description: An + items: type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - id: 5fdf593f-2a92-4a71-b08c-791d7a27fdff - origin: 1665415500727830500 - profileName: onvif-camera - readings: - - binaryValue: /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACAAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDzGwiBtoGx/wAs1/kK0BGPSotPH+g23/XFP5CreKxOyOwxVqTYuOlAWn7eKQFd1VQDtH3hUgtoz1QUsq/u2PoM1PikBCLWL+4KelkhOQSAOp3dKoX+sQWalVO+X0HasB9bumOfMP0oDmR2T6c/klt/4d/5VRvNOkhxvQrkcblH4/rmsaz8TT25bzP3qMCNp7Z9K3IvGcU0C211F5kROTnG4dOh7dKYXTMPysXeMV0MKgDpVC4+xTXiy2QkMXPDNuI4rRgGcUBYsqgFSgUiLUoFMmwzbU8a0wLzVmMAimMlij713+h2a2lhEpX52G5vxrj9Nthc3kUJGQx5HtXoUaYFBUELIgYZ2ivLviHKJ47tAoxDAyj8ia9TkkWGF5HOFUc15H4oJm03UZW5LQyH9DTiKo9DmdPQ/YbbH/PFP5CrgWoNNP8AxLbX/rin8hVwVIR2GBacFp4UU8LSAryL8hqrqF4LTTTICN54XNaEi/Ka5LXpi8kcfZF6e5oAxXcscmoy1KetMaqSMGLuGacGqIU8A02gNK0vWhTAJByDXX6bMLiFXXvXBxiur8NSMZBGx+X0rKRvTd3Y6VBUyjirM1uoCOg4bP5j/IqMJirTHKNhgFSxjmgJTo1IamSdL4Xh3X5fH3Vrs8Yrl/Csf7yZ/Yf1rqyKGaIyddlMemOF43naa8419c6HqJx/y7Sf+gmvQPExItIVHQuc/lXB6+MeH9SP/TtJ/wCgmtYGFU5jTVH9mWn/AFxT+Qq2FqjppP8AZ1qP+mKfyFaS9KxNI7ABTgKUCngDFICMjiuG1cEXsoPrXdtiuP8AEUW25V/7wNBMjnj1ptPbrTcc1Zix8MZedR2zzVuWEKpUDBBp1lDj5z+FWbiA7t46GspT1OmnT0uVbOHfLg9K9G0Lw8xtYLuAr5chYZZuflxk1wtpFtkz2r03w5K7aBdRXczrHbyRNGuBwH3A4+vH6UblU9GdHe2sP2Nx5iBtxK57np/9euaxTjfSSjBOBTQaqBdRp7CgU9Rg01aeOtUYnV+FjzN9BXUiuS8Ln/SWX1WuvUc0MtGJ4nQ/Z7Y44yf6VwfiEY8P6l/17Sf+gmvR/ESb9MiOORJ/MH/CvP8AxGn/ABT2pHt9lk/9BNbwOeocPp0MzWFqwdR+5T+Qq4ILr+8lJpqj+zbP/rhH/wCg1eVaxNY7FURXX95Kf9nu/wC+lWwKkAqWhmU7XKnBWsvWIxJYuzD5lwRXTyRFkIUZasPVrO5Ns6LBISeOmR+lAmjidhJp6QMx6VrLpk0Ry8R/KmPHtbGMVnKdg5CONdiYFWuGhwagqzEm5BWL1N4qxNZoN4wK9C1R/M0jSQEVWNth2A5faxVc/QAVwtpGVbPpXpviH+zrTR9Ks1niFxDHlgvcNz/P+daxYmjnIweKsqKbGqkDBzU6rWyMhB0p69aAlSpHVNEm1oD7L+L3OK7pBXnunnyriJ/Rga9CRuhpFplTWofM05sdVIavPfEq48Nap/16S/8AoBr064QTwPGf4gRXm/iZMeGtVyOlpLn/AL5NaQdkY1Fc4fTR/wASyz/64R/+gitFU4qrpUQ/sqyZ8qot48+v3RVpbiVFkiixhxg5QE/gSMj8KzNI7DguFLZGB1yRU9ncWRLLc7xgfK688+mPSs1oHbr+tK6i3i3NwPWpGaUVxam4wqMAOjMe/wBKW8vbSGM+dIq56AnrXPPeSSf8e2UTvIR/IUiwRiOS6nbeQPvSck0mxsklubedW8mVW9s1nOFOeBVS65BuYE8tg33R3FSRP5ihgeDUNDI3t1ZvkGCe1WLa3YcEVNboplBIq/GirIDjjvUuJdN62Io4SozViOEzq4X74rUisEnjPkgucZwAc04RQ2MrJEfMZ12yHHAPfFZ6nZaJjQve2hyrnGehGQa7BrcMsUsQIiliWQE+pHI/A5H4VkSxqyHI6dvSum0TbqPh2W3zmeyJdB3MZ64+h5/GtoHNWguhnhcdadkZ4pWpoHNanMWYeor0G1ffBG2eqivPYuldxob79PXnOKBo0+1cL42h8rQ9ZHrZyn/xw13ijNcj4/hx4c1WT1sZh+SGriRI820qEyaZp/p9mj/9BFX/ALKELEjHyk1Z0qK3g8M6bPMQo+yQkk+6CqNzJc3zYhR0i6Db94/X0qTSOxBcXKR/u41MkvoOg+pqolpNeEGYb8fgo/DvWpDpSR7TIM8Z254/+vV4g8jtxxQBhLZbPv8AJxj2rO1k+UkcC/Vh/KukkT94KwdcXzbmCJRl8HP41IGBGXkcKo9eKfYj9y6n7ytW9Y6X9nUtImZT+lZWwWepTQkYWTFS0ImgilyCBVxGYfeHNWEgCqAKUw07DLNrfvAwaGRo3HQqcVNJ4j1JeWuBKAc/vYlfH0yKzfLxUU/EJpWK5mbNv4kt7ydY9StIgrHDS267Hx/ujg/lWnaXn/CO67b3sJM9jJkpIoIEsZ4I+o9PUVwg4OeldZ4d1GC7h/si+ZVhIzDKesT+v0PQ/wD1qaQc76nS3doslst/asj28nQK2Sh9D+uKoVZ0OO7sdSksJ4d0E64kiZlyfQqSeTyDx1pLu0ksrh4ZR8ynGexHqKohjI+ldd4ZkzbyR+hBrkYq6Xw04W4ZP7woBHVKOK5vx9Hu8Fas392zm/8AQDXTAVheN03+BtcA6ixmP/jhoTJkeZeHLO717TtOjJKWsFtEq8dwgGa6+TSI7WFYoo8d/c1ifDS8M1ra2RXIS3VgfbA6/mK7u5T94D6AD880zWOxxU0Oxm44BqnIPmf6VuXsWC59WNY7rjf+FANFJxjrWNEq3XiBuMiPp9f8mtq6bylZj0GKo+H7cOs923LSNwfYf/XzQKxcljwM4rkNfQpepMBkcV2tyMRmuU1yJpIjjtzQFjT2DaCPTNMJpdOzLpcUjctt5PrSN1pNA0Rmqs/3TVo1Vn+6akCi9EZ/eDmnPUaffBpCO80u7l1fTWtnAluI1zbydHXH8Oe4PTnuRWvaX8eu2yQ3Mu27hG1JG4Dj0Y/ng/nWH4UMQdAW2kNuVj0Hrn/Pb61P4gtRo2us8OPKb54+OxP9Dx+FaDZfMTRMVdSpBxg1q6LKIr6LJwCcU2yceIbMTmBI5EGxpI3ySccbl9Kr2hMcqHuDQQeg1i+M/wDkR9e/7B8//otq2QQyhhyCMg1jeMv+RH1//sHT/wDotqhEyPK/BVzNptnZ6pAhkighjS6XuFIHP0+6fqK9ZiCXUMkqOGVgpUjuMZz+teWeE3XTH0l35tru0ijnB6cxjr7cg13VnIfDepCwlY/2bdHNu78+W3dCfx4qzaOwavCqwu4HaudnGE3Y9K7PVYF+zyrjI25FchIM24GOQcH8KCjn9dfZa3PbGz9RV7TrT7JYRRbcYHP1qjrdu1zfQQJ/y3Khh64P+Ga2ieKDMqXY+Suc1FC6sAOororr7hrHukySfagaZR0K7zpzI3WJsEexq64RvmQ9e1ZGiyiLUrq2b+Mfyz/jWq8TQZK8x9vagZC/ANUZjk1cnOY2+lZrNkVBJHIeaYpwaefmBpi9aQjc0q+e2ZSDxmuo1S5i1rTkjRv9Ig+aMqOq/wAQ/kR9CPSuDSUoKtW+rzWjAxvg1SYzsfD815YKZIbqAQvjzY2BLcfh/UVsEICrxNlHG9T/AD/XIrz2PV5RNuAVAeyjArqfD9691DJGzjMeHUH0PDY/Hb+tO4HpumS+bpsDbs8YNUPGX/Ij6/8A9g6f/wBFtS+HHLWTgn7r8UnjL/kR9f8A+wdP/wCi2oM5H//Z - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - id: d04a9dad-feb9-4099-a524-8a4b4cf2cc37 - mediaType: image/jpeg - origin: 1665415500727830500 - profileName: onvif-camera - resourceName: Snapshot - value: '' - valueType: Binary - sourceName: Snapshot - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - binaryValue: - type: string - deviceName: - type: string - id: - type: string - mediaType: - type: string - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Mon, 10 Oct 2022 15:25:00 GMT - type: string - Transfer-Encoding: - schema: - example: chunked - type: string - X-Correlation-Id: - schema: - example: e1116b67-69cd-4ed8-9b70-f543c9cf4a17 - type: string - summary: Snapshot - tags: - - Video Streaming - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Stop: - put: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl#op.Stop - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + required: + - OutputTokensAvailable + - OutputLevelRange + type: object + onvif_AudioSource: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Channels: + description: 'number of available audio channels. (1: mono, 2: stereo)' + format: int32 + type: integer + required: + - Channels + type: object + description: Representation of a physical audio input. + onvif_AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + SourceToken: + description: Token of the Audio Source the configuration applies to + maxLength: 64 type: string - requestBody: - content: - application/json: - schema: - example: - Stop: - PanTilt: true - ProfileToken: '{{MEDIA_PROFILE}}' - properties: - Stop: - properties: - PanTilt: - type: boolean - ProfileToken: - type: string - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 18:27:51 GMT - type: string - X-Correlation-Id: - schema: - example: 72df6d5f-6c13-4e26-9e66-a0578604035d - type: string - summary: Stop - tags: - - PTZ - Actuation - /api/v2/device/name/{EDGEX_DEVICE_NAME}/StreamUri: - get: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetStreamUri - parameters: - - example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' - in: query - name: jsonObject - schema: + required: + - SourceToken + type: object + onvif_AudioSourceConfigurationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_AudioSourceOptionsExtension' + InputTokensAvailable: + description: Tokens of the audio source the configuration can be used for. + items: + maxLength: 64 type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + required: + - InputTokensAvailable + type: object + onvif_AudioSourceOptionsExtension: + type: object + onvif_AutoFocusMode: + enum: + - AUTO + - MANUAL + type: string + onvif_BacklightCompensation: + properties: + Level: + description: Optional level parameter (unit unspecified). + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + required: + - Mode + - Level + type: object + onvif_BacklightCompensation20: + description: Type describing whether BLC mode is enabled or disabled (on/off). + properties: + Level: + description: Optional level parameter (unit unspecified). + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_BacklightCompensationMode' + - description: Backlight compensation mode (on/off). + required: + - Mode + type: object + onvif_BacklightCompensationMode: + description: Enumeration describing the available backlight compenstation modes. + enum: + - false + - true + type: string + onvif_BacklightCompensationOptions: + properties: + Level: + $ref: '#/components/schemas/onvif_FloatRange' + Mode: + items: + $ref: '#/components/schemas/onvif_WideDynamicMode' + type: array + required: + - Mode + - Level + type: object + onvif_BacklightCompensationOptions20: + properties: + Level: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Level range of BacklightCompensation. + Mode: + description: "'ON' or 'OFF'" + items: + $ref: '#/components/schemas/onvif_BacklightCompensationMode' + type: array + required: + - Mode + type: object + onvif_BackupFile: + properties: + Data: + $ref: '#/components/schemas/onvif_AttachmentData' + Name: + type: string + required: + - Name + - Data + type: object + onvif_Behaviour: + properties: + Extension: + $ref: '#/components/schemas/onvif_BehaviourExtension' + Idle: + $ref: '#/components/schemas/onvif_Idle' + Removed: + $ref: '#/components/schemas/onvif_Removed' + Speed: + type: number + type: object + onvif_BehaviourExtension: + type: object + onvif_BinaryData: + properties: + Data: + description: base64 encoded binary data. + format: binary + type: string + contentType: + minLength: 3 + type: string + required: + - Data + type: object + onvif_Capabilities: + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/onvif_AnalyticsCapabilities' + - description: Analytics capabilities + Device: + allOf: + - $ref: '#/components/schemas/onvif_DeviceCapabilities' + - description: Device capabilities + Events: + allOf: + - $ref: '#/components/schemas/onvif_EventCapabilities' + - description: Event capabilities + Extension: + $ref: '#/components/schemas/onvif_CapabilitiesExtension' + Imaging: + allOf: + - $ref: '#/components/schemas/onvif_ImagingCapabilities' + - description: Imaging capabilities + Media: + allOf: + - $ref: '#/components/schemas/onvif_MediaCapabilities' + - description: Media capabilities + PTZ: + allOf: + - $ref: '#/components/schemas/onvif_PTZCapabilities' + - description: PTZ capabilities + type: object + onvif_CapabilitiesExtension: + properties: + AnalyticsDevice: + $ref: '#/components/schemas/onvif_AnalyticsDeviceCapabilities' + DeviceIO: + $ref: '#/components/schemas/onvif_DeviceIOCapabilities' + Display: + $ref: '#/components/schemas/onvif_DisplayCapabilities' + Extensions: + $ref: '#/components/schemas/onvif_CapabilitiesExtension2' + Receiver: + $ref: '#/components/schemas/onvif_ReceiverCapabilities' + Recording: + $ref: '#/components/schemas/onvif_RecordingCapabilities' + Replay: + $ref: '#/components/schemas/onvif_ReplayCapabilities' + Search: + $ref: '#/components/schemas/onvif_SearchCapabilities' + type: object + onvif_CapabilitiesExtension2: + type: object + onvif_CapabilityCategory: + enum: + - All + - Analytics + - Device + - Events + - Imaging + - Media + - PTZ + type: string + onvif_CellLayout: + properties: + Columns: + description: Number of columns of the cell grid (x dimension) + format: int32 + type: integer + Rows: + description: Number of rows of the cell grid (y dimension) + format: int32 + type: integer + Transformation: + allOf: + - $ref: '#/components/schemas/onvif_Transformation' + - description: Mapping of the cell grid to the Video frame. The cell grid + is starting from the upper left corner and x dimension is going from + left to right and the y dimension from up to down. + required: + - Columns + - Rows + - Transformation + type: object + onvif_Certificate: + properties: + Certificate: + allOf: + - $ref: '#/components/schemas/onvif_BinaryData' + - description: base64 encoded DER representation of certificate. + CertificateID: + description: Certificate id. + type: string + required: + - CertificateID + - Certificate + type: object + onvif_CertificateGenerationParameters: + properties: + CertificateID: + type: string + Extension: + $ref: '#/components/schemas/onvif_CertificateGenerationParametersExtension' + Subject: + type: string + ValidNotAfter: + type: string + ValidNotBefore: + type: string + type: object + onvif_CertificateGenerationParametersExtension: + type: object + onvif_CertificateInformation: + properties: + CertificateID: + type: string + ExtendedKeyUsage: + $ref: '#/components/schemas/onvif_CertificateUsage' + Extension: + $ref: '#/components/schemas/onvif_CertificateInformationExtension' + IssuerDN: + type: string + KeyLength: + format: int32 + type: integer + KeyUsage: + $ref: '#/components/schemas/onvif_CertificateUsage' + SerialNum: + type: string + SignatureAlgorithm: + description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding + DateTimeRange is from "From" to "Until" + type: string + SubjectDN: + type: string + Validity: + $ref: '#/components/schemas/onvif_DateTimeRange' + Version: + type: string + required: + - CertificateID + type: object + onvif_CertificateInformationExtension: + type: object + onvif_CertificateStatus: + properties: + CertificateID: + description: Certificate id. + type: string + Status: + description: Indicates whether or not a certificate is used in a HTTPS configuration. + type: boolean + required: + - CertificateID + - Status + type: object + onvif_CertificateUsage: + properties: + Critical: + type: boolean + required: + - Critical + type: object + onvif_CertificateWithPrivateKey: + properties: + Certificate: + $ref: '#/components/schemas/onvif_BinaryData' + CertificateID: + type: string + PrivateKey: + $ref: '#/components/schemas/onvif_BinaryData' + required: + - Certificate + - PrivateKey + type: object + onvif_ClassCandidate: + properties: + Likelihood: + type: number + Type: + $ref: '#/components/schemas/onvif_ClassType' + required: + - Type + - Likelihood + type: object + onvif_ClassDescriptor: + properties: + ClassCandidate: + items: + $ref: '#/components/schemas/onvif_ClassCandidate' + type: array + Extension: + $ref: '#/components/schemas/onvif_ClassDescriptorExtension' + Type: + description: ONVIF recommends to use this 'Type' element instead of 'ClassCandidate' + and 'Extension' above for new design. Acceptable values are defined in + tt:ObjectType. + items: + $ref: '#/components/schemas/onvif_StringLikelihood' + type: array + type: object + onvif_ClassDescriptorExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_ClassDescriptorExtension2' + OtherTypes: + items: + $ref: '#/components/schemas/onvif_OtherType' + type: array + required: + - OtherTypes + type: object + onvif_ClassDescriptorExtension2: + type: object + onvif_ClassType: + enum: + - Animal + - Face + - Human + - Vehical + - Other + type: string + onvif_CodingCapabilities: + description: This type contains the Audio and Video coding capabilities of a + display service. + properties: + AudioDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfigurationOptions' + - description: If the device supports audio decoding this section describes + the supported codecs and their settings. + AudioEncodingCapabilities: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfigurationOptions' + - description: If the device supports audio encoding this section describes + the supported codecs and their configuration. + VideoDecodingCapabilities: + allOf: + - $ref: '#/components/schemas/onvif_VideoDecoderConfigurationOptions' + - description: This section describes the supported video codesc and their + configuration. + required: + - VideoDecodingCapabilities + type: object + onvif_Color: + properties: + Colorspace: + description: 'Acceptable values:' + type: string + X: + type: number + Y: + type: number + Z: + type: number + required: + - X + - Y + - Z + type: object + onvif_ColorCluster: + properties: + Color: + $ref: '#/components/schemas/onvif_Color' + Covariance: + $ref: '#/components/schemas/onvif_ColorCovariance' + Weight: + type: number + required: + - Color + type: object + onvif_ColorCovariance: + properties: + Colorspace: + description: Acceptable values are the same as in tt:Color. + type: string + XX: + type: number + XY: + type: number + XZ: + type: number + YY: + type: number + YZ: + type: number + ZZ: + type: number + required: + - XX + - YY + - ZZ + type: object + onvif_ColorDescriptor: + properties: + ColorCluster: + items: + $ref: '#/components/schemas/onvif_ColorCluster' + type: array + Extension: {} + type: object + onvif_ColorOptions: + description: Describe the colors supported. Either list each color or define + the range of color values. + properties: + ColorList: + description: List the supported color. + items: + $ref: '#/components/schemas/onvif_Color' + type: array + ColorspaceRange: + description: Define the range of color supported. + items: + $ref: '#/components/schemas/onvif_ColorspaceRange' + type: array + type: object + onvif_ColorOptionsChoice0: + properties: + ColorList: + description: List the supported color. + items: + $ref: '#/components/schemas/onvif_Color' + type: array + type: object + onvif_ColorOptionsChoice1: + properties: + ColorspaceRange: + description: Define the range of color supported. + items: + $ref: '#/components/schemas/onvif_ColorspaceRange' + type: array + type: object + onvif_ColorspaceRange: + properties: + Colorspace: + description: Acceptable values are the same as in tt:Color. + type: string + X: + $ref: '#/components/schemas/onvif_FloatRange' + Y: + $ref: '#/components/schemas/onvif_FloatRange' + Z: + $ref: '#/components/schemas/onvif_FloatRange' + required: + - X + - Y + - Z + - Colorspace + type: object + onvif_Config: + properties: + Name: + description: Name of the configuration. + type: string + Parameters: + allOf: + - $ref: '#/components/schemas/onvif_ItemList' + - description: List of configuration parameters as defined in the corresponding + description. + Type: + 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. + type: string + required: + - Name + - Type + - Parameters + type: object + onvif_ConfigDescription: + properties: + Extension: + $ref: '#/components/schemas/onvif_ConfigDescriptionExtension' + Messages: + 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." + items: + $ref: '#/components/schemas/onvif_Messages' + type: array + Name: + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies + the type of rule, not a type definition in a schema. + type: string + Parameters: + allOf: + - $ref: '#/components/schemas/onvif_ItemListDescription' + - 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." + fixed: + description: The fixed attribute signals that it is not allowed to add or + remove this type of configuration. + type: boolean + maxInstances: + description: The maxInstances attribute signals the maximum number of instances + per configuration. + format: int32 + type: integer + required: + - Name + - Parameters + type: object + onvif_ConfigDescriptionExtension: + type: object + onvif_ConfigurationEntity: + description: Base type defining the common properties of a configuration. + properties: + Name: + description: User readable name. Length up to 64 characters. + maxLength: 64 + type: string + UseCount: + description: Number of internal references currently using this configuration. + format: int32 + type: integer + token: + description: Token that uniquely references this configuration. Length up + to 64 characters. + maxLength: 64 + type: string + required: + - token + - Name + - UseCount + type: object + onvif_ContinuousFocus: + properties: + Speed: + description: Speed parameter for the Continuous focus control. + type: number + required: + - Speed + type: object + onvif_ContinuousFocusOptions: + properties: + Speed: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the speed. + required: + - Speed + type: object + onvif_DNSInformation: + properties: + DNSFromDHCP: + description: List of DNS addresses received from DHCP. + items: + $ref: '#/components/schemas/onvif_IPAddress' + type: array + DNSManual: + description: List of manually entered DNS addresses. + items: + $ref: '#/components/schemas/onvif_IPAddress' + type: array + Extension: + $ref: '#/components/schemas/onvif_DNSInformationExtension' + FromDHCP: + description: Indicates whether or not DNS information is retrieved from + DHCP. + type: boolean + SearchDomain: + description: Search domain. + items: type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 0ef64d9b-ba26-49a9-9a9f-5ec6f7b47190 - origin: 1659656323588827000 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 255085ba-4399-489d-aa34-cab5e1379281 - objectValue: - MediaUri: - InvalidAfterConnect: false - InvalidAfterReboot: false - Timeout: PT0H0M2S - Uri: rtsp://10.0.0.188:554/stream1 - origin: 1659656323588827000 - profileName: onvif-camera - resourceName: StreamUri - value: '' - valueType: Object - sourceName: StreamUri - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - MediaUri: - properties: - InvalidAfterConnect: - type: boolean - InvalidAfterReboot: - type: boolean - Timeout: - type: string - Uri: - type: string - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '641' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Thu, 04 Aug 2022 23:38:43 GMT - type: string - X-Correlation-Id: - schema: - example: ed49c080-d872-4c97-bf07-f0cf95795fb9 - type: string - summary: StreamUri - tags: - - Video Streaming - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemDateAndTime: - get: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetSystemDateAndTime - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + required: + - FromDHCP + type: object + onvif_DNSInformationExtension: + type: object + onvif_Date: + properties: + Day: + description: Range is 1 to 31. + format: int32 + type: integer + Month: + description: Range is 1 to 12. + format: int32 + type: integer + Year: + format: int32 + type: integer + required: + - Year + - Month + - Day + type: object + onvif_DateTime: + properties: + Date: + $ref: '#/components/schemas/onvif_Date' + Time: + $ref: '#/components/schemas/onvif_Time' + required: + - Time + - Date + type: object + onvif_DateTimeRange: + properties: + From: + format: date-time + type: string + Until: + format: date-time + type: string + required: + - From + - Until + type: object + onvif_Defogging: + properties: + Extension: + $ref: '#/components/schemas/onvif_DefoggingExtension' + Level: + description: Optional level parameter specified with unitless normalized + value from 0.0 to +1.0. + type: number + Mode: + description: Parameter to enable/disable or automatic Defogging feature. + Its options shall be chosen from tt:DefoggingMode Type. + type: string + required: + - Mode + type: object + onvif_DefoggingExtension: + type: object + onvif_DefoggingMode: + enum: + - false + - true + - AUTO + type: string + onvif_DefoggingOptions: + properties: + Level: + description: Indicates whether or not support Level parameter for Defogging. + type: boolean + Mode: + description: Supported options for Defogging mode. Its options shall be + chosen from tt:DefoggingMode Type. + items: type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: da6f552e-e4b3-4d75-a2ce-989745b8ef7b - origin: 1659672865881317600 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: aa61a541-beb5-4be0-bb7a-625ce60a980e - objectValue: - SystemDateAndTime: - DateTimeType: NTP - DaylightSavings: true - Extension: '' - LocalDateTime: - Date: - Month: '8' - Year: '2022' - Time: - Hour: '21' - Minute: '14' - Second: '25' - TimeZone: - TZ: 'GMT+08:00DST+07:00,M3.2.0/02:00:00,M11.1.0/02:00:00 - - ' - UTCDateTime: - Date: - Month: '8' - Year: '2022' - Time: - Hour: '4' - Minute: '14' - Second: '25' - origin: 1659672865881317600 - profileName: onvif-camera - resourceName: SystemDateAndTime - value: '' - valueType: Object - sourceName: SystemDateAndTime - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - SystemDateAndTime: - properties: - DateTimeType: - type: string - DaylightSavings: - type: boolean - Extension: - type: string - LocalDateTime: - properties: - Date: - properties: - Month: - type: string - Year: - type: string - type: object - Time: - properties: - Hour: - type: string - Minute: - type: string - Second: - type: string - type: object - type: object - TimeZone: - properties: - TZ: - type: string - type: object - UTCDateTime: - properties: - Date: - properties: - Month: - type: string - Year: - type: string - type: object - Time: - properties: - Hour: - type: string - Minute: - type: string - Second: - type: string - type: object - type: object - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '886' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 04:14:25 GMT - type: string - X-Correlation-Id: - schema: - example: 81f90086-d959-4f35-9bf6-9b814d7a10c4 - type: string - summary: SystemDateAndTime - tags: - - System Function - put: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemDateAndTime - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + required: + - Mode + - Level + type: object + onvif_DeviceCapabilities: + properties: + Extension: + $ref: '#/components/schemas/onvif_DeviceCapabilitiesExtension' + IO: + allOf: + - $ref: '#/components/schemas/onvif_IOCapabilities' + - description: I/O capabilities. + Network: + allOf: + - $ref: '#/components/schemas/onvif_NetworkCapabilities' + - description: Network capabilities. + Security: + allOf: + - $ref: '#/components/schemas/onvif_SecurityCapabilities' + - description: Security capabilities. + System: + allOf: + - $ref: '#/components/schemas/onvif_SystemCapabilities' + - description: System capabilities. + XAddr: + description: Device service URI. + type: string + required: + - XAddr + type: object + onvif_DeviceCapabilitiesExtension: + type: object + onvif_DeviceEntity: + description: Base class for physical entities like inputs and outputs. + properties: + token: + description: Unique identifier referencing the physical entity. + maxLength: 64 + type: string + required: + - token + type: object + onvif_DeviceIOCapabilities: + properties: + AudioOutputs: + format: int32 + type: integer + AudioSources: + format: int32 + type: integer + RelayOutputs: + format: int32 + type: integer + VideoOutputs: + format: int32 + type: integer + VideoSources: + format: int32 + type: integer + XAddr: + type: string + required: + - XAddr + - VideoSources + - VideoOutputs + - AudioSources + - AudioOutputs + - RelayOutputs + type: object + onvif_DigitalIdleState: + enum: + - closed + - open + type: string + onvif_DigitalInput: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + IdleState: + allOf: + - $ref: '#/components/schemas/onvif_DigitalIdleState' + - description: Indicate the Digital IdleState status. + type: object + onvif_Direction: + enum: + - Left + - Right + - Any + type: string + onvif_DiscoveryMode: + enum: + - Discoverable + - NonDiscoverable + type: string + onvif_DisplayCapabilities: + properties: + FixedLayout: + description: Indication that the SetLayout command supports only predefined + layouts. + type: boolean + XAddr: + type: string + required: + - XAddr + - FixedLayout + type: object + onvif_Dot11AuthAndMangementSuite: + enum: + - None + - Dot1X + - PSK + - Extended + type: string + onvif_Dot11AvailableNetworks: + properties: + AuthAndMangementSuite: + description: See IEEE802.11 7.3.2.25.2 for details. + items: + $ref: '#/components/schemas/onvif_Dot11AuthAndMangementSuite' + type: array + BSSID: + type: string + Extension: + $ref: '#/components/schemas/onvif_Dot11AvailableNetworksExtension' + GroupCipher: + items: + $ref: '#/components/schemas/onvif_Dot11Cipher' + type: array + PairCipher: + items: + $ref: '#/components/schemas/onvif_Dot11Cipher' + type: array + SSID: + format: binary + type: string + SignalStrength: + $ref: '#/components/schemas/onvif_Dot11SignalStrength' + required: + - SSID + type: object + onvif_Dot11AvailableNetworksExtension: + type: object + onvif_Dot11Capabilities: + properties: + AdHocStationMode: + type: boolean + MultipleConfiguration: + type: boolean + ScanAvailableNetworks: + type: boolean + TKIP: + type: boolean + WEP: + type: boolean + required: + - TKIP + - ScanAvailableNetworks + - MultipleConfiguration + - AdHocStationMode + - WEP + type: object + onvif_Dot11Cipher: + enum: + - CCMP + - TKIP + - Any + - Extended + type: string + onvif_Dot11Configuration: + properties: + Alias: + maxLength: 64 + type: string + Mode: + $ref: '#/components/schemas/onvif_Dot11StationMode' + Priority: + format: int32 + maximum: 31 + minimum: 0 + type: integer + SSID: + format: binary + type: string + Security: + $ref: '#/components/schemas/onvif_Dot11SecurityConfiguration' + required: + - SSID + - Mode + - Alias + - Priority + - Security + type: object + onvif_Dot11PSKSet: + properties: + Extension: + $ref: '#/components/schemas/onvif_Dot11PSKSetExtension' + Key: + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of + 256 bits, or 64 octets when represented in hex + format: binary + type: string + Passphrase: + 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." + pattern: '[ -~]{8,63}' + type: string + type: object + onvif_Dot11PSKSetExtension: + type: object + onvif_Dot11SecurityConfiguration: + properties: + Algorithm: + $ref: '#/components/schemas/onvif_Dot11Cipher' + Dot1X: + maxLength: 64 + type: string + Extension: + $ref: '#/components/schemas/onvif_Dot11SecurityConfigurationExtension' + Mode: + $ref: '#/components/schemas/onvif_Dot11SecurityMode' + PSK: + $ref: '#/components/schemas/onvif_Dot11PSKSet' + required: + - Mode + type: object + onvif_Dot11SecurityConfigurationExtension: + type: object + onvif_Dot11SecurityMode: + enum: + - None + - WEP + - PSK + - Dot1X + - Extended + type: string + onvif_Dot11SignalStrength: + enum: + - None + - Very Bad + - Bad + - Good + - Very Good + - Extended + type: string + onvif_Dot11StationMode: + enum: + - Ad-hoc + - Infrastructure + - Extended + type: string + onvif_Dot11Status: + properties: + ActiveConfigAlias: + maxLength: 64 + type: string + BSSID: + type: string + GroupCipher: + $ref: '#/components/schemas/onvif_Dot11Cipher' + PairCipher: + $ref: '#/components/schemas/onvif_Dot11Cipher' + SSID: + format: binary + type: string + SignalStrength: + $ref: '#/components/schemas/onvif_Dot11SignalStrength' + required: + - SSID + - ActiveConfigAlias + type: object + onvif_Dot1XConfiguration: + properties: + AnonymousID: + type: string + CACertificateID: + items: type: string - requestBody: - content: - application/json: - schema: - example: - SystemDateAndTime: - DateTimeType: Manual - DaylightSavings: false - UTCDateTime: - Date: - Day: 11 - Month: 12 - Year: 2021 - Time: - Hour: 5 - Minute: 48 - Second: 20 - properties: - SystemDateAndTime: - properties: - DateTimeType: - type: string - DaylightSavings: - type: boolean - UTCDateTime: - properties: - Date: - properties: - Day: - type: number - Month: - type: number - Year: - type: number - type: object - Time: - properties: - Hour: - type: number - Minute: - type: number - Second: - type: number - type: object - type: object - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 23 Sep 2022 16:27:07 GMT - type: string - X-Correlation-Id: - schema: - example: fb9339bb-b588-49f8-82b1-d0da167897c0 - type: string - summary: SetSystemDateAndTime - tags: - - System Function - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemReboot: - put: - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SystemReboot - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + Dot1XConfigurationToken: + maxLength: 64 + type: string + EAPMethod: + description: EAP Method type as defined in + format: int32 + type: integer + EAPMethodConfiguration: + $ref: '#/components/schemas/onvif_EAPMethodConfiguration' + Extension: + $ref: '#/components/schemas/onvif_Dot1XConfigurationExtension' + Identity: + type: string + required: + - Dot1XConfigurationToken + - Identity + - EAPMethod + type: object + onvif_Dot1XConfigurationExtension: + type: object + onvif_Dot3Configuration: + type: object + onvif_Duplex: + enum: + - Full + - Half + type: string + onvif_DurationRange: + description: Range of duration greater equal Min duration and less equal Max + duration. + properties: + Max: + format: date-time + type: string + Min: + format: date-time + type: string + required: + - Min + - Max + type: object + onvif_DynamicDNSInformation: + properties: + Extension: + $ref: '#/components/schemas/onvif_DynamicDNSInformationExtension' + Name: + description: DNS name. + type: string + TTL: + description: Time to live. + format: date-time + type: string + Type: + allOf: + - $ref: '#/components/schemas/onvif_DynamicDNSType' + - description: Dynamic DNS type. + required: + - Type + type: object + onvif_DynamicDNSInformationExtension: + type: object + onvif_DynamicDNSType: + enum: + - NoUpdate + - ClientUpdates + - ServerUpdates + type: string + onvif_EAPMethodConfiguration: + properties: + Extension: + $ref: '#/components/schemas/onvif_EapMethodExtension' + Password: + description: Password for those EAP Methods that require a password. The + password shall never be returned on a get method. + type: string + TLSConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_TLSConfiguration' + - description: Confgiuration information for TLS Method. + type: object + onvif_EFlip: + properties: + Mode: + allOf: + - $ref: '#/components/schemas/onvif_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + required: + - Mode + type: object + onvif_EFlipMode: + enum: + - false + - true + - Extended + type: string + onvif_EFlipOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_EFlipOptionsExtension' + Mode: + description: Options of EFlip mode parameter. + items: + $ref: '#/components/schemas/onvif_EFlipMode' + type: array + type: object + onvif_EFlipOptionsExtension: + type: object + onvif_EapMethodExtension: + type: object + onvif_ElementItem: + description: Complex value structure. + properties: + Name: + description: Item name. + type: string + required: + - Name + type: object + onvif_ElementItemDescription: + description: Description of a complex type. The Type must reference a defined + type. + properties: + Name: + description: Item name. Must be unique within a list. + type: string + Type: + description: The type of the item. The Type must reference a defined type. + type: string + required: + - Name + - Type + type: object + onvif_Enabled: + enum: + - ENABLED + - DISABLED + type: string + onvif_EngineConfiguration: + properties: + AnalyticsEngineInputInfo: + $ref: '#/components/schemas/onvif_AnalyticsEngineInputInfo' + VideoAnalyticsConfiguration: + $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + required: + - VideoAnalyticsConfiguration + - AnalyticsEngineInputInfo + type: object + onvif_Entity: + enum: + - Device + - VideoSource + - AudioSource + type: string + onvif_EventCapabilities: + properties: + WSPausableSubscriptionManagerInterfaceSupport: + description: Indicates whether or not WS Pausable Subscription Manager Interface + is supported. + type: boolean + WSPullPointSupport: + description: Indicates whether or not WS Pull Point is supported. + type: boolean + WSSubscriptionPolicySupport: + description: Indicates whether or not WS Subscription policy is supported. + type: boolean + XAddr: + description: Event service URI. + type: string + required: + - XAddr + - WSSubscriptionPolicySupport + - WSPullPointSupport + - WSPausableSubscriptionManagerInterfaceSupport + type: object + onvif_EventFilter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - type: object + onvif_EventStream: + properties: + Extension: + items: + $ref: '#/components/schemas/onvif_EventStreamExtension' + type: array + NotificationMessage: + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + type: object + onvif_EventStreamChoice0: + properties: + NotificationMessage: + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + type: object + onvif_EventStreamChoice1: + properties: + Extension: + items: + $ref: '#/components/schemas/onvif_EventStreamExtension' + type: array + type: object + onvif_EventStreamChoice2: + type: object + onvif_EventStreamExtension: + type: object + onvif_EventSubscription: + description: Subcription handling in the same way as base notification subscription. + properties: + Filter: + $ref: '#/components/schemas/wsnt_FilterType' + SubscriptionPolicy: + $ref: '#/components/schemas/onvif_SubscriptionPolicy' + type: object + onvif_Exposure: + properties: + ExposureTime: + description: The fixed exposure time used by the image sensor (μs). + type: number + Gain: + description: The fixed gain used by the image sensor (dB). + type: number + Iris: + description: The fixed attenuation of input light affected by the iris (dB). + 0dB maps to a fully opened iris. + type: number + MaxExposureTime: + description: Maximum value of exposure time range allowed to be used by + the algorithm. + type: number + MaxGain: + description: Maximum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + MaxIris: + description: Maximum value of the iris range allowed to be used by the algorithm. + type: number + MinExposureTime: + description: Minimum value of exposure time range allowed to be used by + the algorithm. + type: number + MinGain: + description: Minimum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + MinIris: + description: Minimum value of the iris range allowed to be used by the algorithm. + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_ExposureMode' + - description: Exposure Mode + Priority: + allOf: + - $ref: '#/components/schemas/onvif_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + Window: + allOf: + - $ref: '#/components/schemas/onvif_Rectangle' + - description: Rectangular exposure mask. + required: + - Mode + - Priority + - Window + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + onvif_Exposure20: + description: Type describing the exposure settings. + properties: + ExposureTime: + description: The fixed exposure time used by the image sensor (μs). + type: number + Gain: + description: The fixed gain used by the image sensor (dB). + type: number + Iris: + 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. + type: number + MaxExposureTime: + description: Maximum value of exposure time range allowed to be used by + the algorithm. + type: number + MaxGain: + description: Maximum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + MaxIris: + 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. + type: number + MinExposureTime: + description: Minimum value of exposure time range allowed to be used by + the algorithm. + type: number + MinGain: + description: Minimum value of the sensor gain range that is allowed to be + used by the algorithm. + type: number + MinIris: + 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. + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_ExposureMode' + - description: Exposure Mode + Priority: + allOf: + - $ref: '#/components/schemas/onvif_ExposurePriority' + - description: The exposure priority mode (low noise/framerate). + Window: + allOf: + - $ref: '#/components/schemas/onvif_Rectangle' + - description: Rectangular exposure mask. + required: + - Mode + type: object + onvif_ExposureMode: + enum: + - AUTO + - MANUAL + type: string + onvif_ExposureOptions: + properties: + ExposureTime: + $ref: '#/components/schemas/onvif_FloatRange' + Gain: + $ref: '#/components/schemas/onvif_FloatRange' + Iris: + $ref: '#/components/schemas/onvif_FloatRange' + MaxExposureTime: + $ref: '#/components/schemas/onvif_FloatRange' + MaxGain: + $ref: '#/components/schemas/onvif_FloatRange' + MaxIris: + $ref: '#/components/schemas/onvif_FloatRange' + MinExposureTime: + $ref: '#/components/schemas/onvif_FloatRange' + MinGain: + $ref: '#/components/schemas/onvif_FloatRange' + MinIris: + $ref: '#/components/schemas/onvif_FloatRange' + Mode: + items: + $ref: '#/components/schemas/onvif_ExposureMode' + type: array + Priority: + items: + $ref: '#/components/schemas/onvif_ExposurePriority' + type: array + required: + - Mode + - Priority + - MinExposureTime + - MaxExposureTime + - MinGain + - MaxGain + - MinIris + - MaxIris + - ExposureTime + - Gain + - Iris + type: object + onvif_ExposureOptions20: + properties: + ExposureTime: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the ExposureTime. + Gain: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Gain. + Iris: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Iris. + MaxExposureTime: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Maximum ExposureTime. + MaxGain: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Maximum Gain. + MaxIris: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Maximum Iris. + MinExposureTime: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Minimum ExposureTime. + MinGain: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Minimum Gain. + MinIris: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Minimum Iris. + Mode: + description: Exposure Mode + items: + $ref: '#/components/schemas/onvif_ExposureMode' + type: array + Priority: + description: The exposure priority mode (low noise/framerate). + items: + $ref: '#/components/schemas/onvif_ExposurePriority' + type: array + required: + - Mode + type: object + onvif_ExposurePriority: + enum: + - LowNoise + - FrameRate + type: string + onvif_FactoryDefaultType: + description: Enumeration describing the available factory default modes. + enum: + - Hard + - Soft + type: string + onvif_FileProgress: + properties: + FileName: + description: Exported file name + type: string + Progress: + description: Normalized percentage completion for uploading the exported + file + type: number + required: + - FileName + - Progress + type: object + onvif_FindEventResult: + properties: + Event: + allOf: + - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + - description: The description of the event. + RecordingToken: + description: The recording where this event was found. Empty string if no + recording is associated with this event. + maxLength: 64 + type: string + StartStateEvent: + 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. + type: boolean + Time: + description: The time when the event occured. + format: date-time + type: string + TrackToken: + description: A reference to the track where this event was found. Empty + string if no track is associated with this event. + maxLength: 64 + type: string + required: + - RecordingToken + - TrackToken + - Time + - Event + - StartStateEvent + type: object + onvif_FindEventResultList: + properties: + Result: + description: A FindEventResult structure for each found event matching the + search. + items: + $ref: '#/components/schemas/onvif_FindEventResult' + type: array + SearchState: + allOf: + - $ref: '#/components/schemas/onvif_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + required: + - SearchState + type: object + onvif_FindMetadataResult: + properties: + RecordingToken: + description: A reference to the recording containing the metadata. + maxLength: 64 + type: string + Time: + description: The point in time when the matching metadata occurs in the + metadata track. + format: date-time + type: string + TrackToken: + description: A reference to the metadata track containing the matching metadata. + maxLength: 64 + type: string + required: + - RecordingToken + - TrackToken + - Time + type: object + onvif_FindMetadataResultList: + properties: + Result: + description: A FindMetadataResult structure for each found set of Metadata + matching the search. + items: + $ref: '#/components/schemas/onvif_FindMetadataResult' + type: array + SearchState: + allOf: + - $ref: '#/components/schemas/onvif_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + required: + - SearchState + type: object + onvif_FindPTZPositionResult: + properties: + Position: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: The PTZ position. + RecordingToken: + description: A reference to the recording containing the PTZ position. + maxLength: 64 + type: string + Time: + description: The time when the PTZ position was valid. + format: date-time + type: string + TrackToken: + description: A reference to the metadata track containing the PTZ position. + maxLength: 64 + type: string + required: + - RecordingToken + - TrackToken + - Time + - Position + type: object + onvif_FindPTZPositionResultList: + properties: + Result: + description: A FindPTZPositionResult structure for each found PTZ position + matching the search. + items: + $ref: '#/components/schemas/onvif_FindPTZPositionResult' + type: array + SearchState: + allOf: + - $ref: '#/components/schemas/onvif_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + required: + - SearchState + type: object + onvif_FindRecordingResultList: + properties: + RecordingInformation: + description: A RecordingInformation structure for each found recording matching + the search. + items: + $ref: '#/components/schemas/onvif_RecordingInformation' + type: array + SearchState: + allOf: + - $ref: '#/components/schemas/onvif_SearchState' + - description: The state of the search when the result is returned. Indicates + if there can be more results, or if the search is completed. + required: + - SearchState + type: object + onvif_FloatItems: + properties: + Items: + items: + type: number + type: array + type: object + onvif_FloatRange: + description: Range of values greater equal Min value and less equal Max value. + properties: + Max: + type: number + Min: + type: number + required: + - Min + - Max + type: object + onvif_FocusConfiguration: + properties: + AutoFocusMode: + $ref: '#/components/schemas/onvif_AutoFocusMode' + DefaultSpeed: + type: number + FarLimit: + description: "Parameter to set autofocus far limit (unit: meter).\nIf set\ + \ to 0.0, infinity will be used." + type: number + NearLimit: + description: 'Parameter to set autofocus near limit (unit: meter).' + type: number + required: + - AutoFocusMode + - DefaultSpeed + - NearLimit + - FarLimit + type: object + onvif_FocusConfiguration20: + properties: + AFMode: + description: Zero or more modes as defined in enumeration tt:AFModes. + type: string + AutoFocusMode: + allOf: + - $ref: '#/components/schemas/onvif_AutoFocusMode' + - description: Mode of auto focus. + DefaultSpeed: + type: number + Extension: + $ref: '#/components/schemas/onvif_FocusConfiguration20Extension' + FarLimit: + description: 'Parameter to set autofocus far limit (unit: meter).' + type: number + NearLimit: + description: 'Parameter to set autofocus near limit (unit: meter).' + type: number + required: + - AutoFocusMode + type: object + onvif_FocusConfiguration20Extension: + type: object + onvif_FocusMove: + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/onvif_AbsoluteFocus' + - description: Parameters for the absolute focus control. + Continuous: + allOf: + - $ref: '#/components/schemas/onvif_ContinuousFocus' + - description: Parameter for the continuous focus control. + Relative: + allOf: + - $ref: '#/components/schemas/onvif_RelativeFocus' + - description: Parameters for the relative focus control. + type: object + onvif_FocusOptions: + properties: + AutoFocusModes: + items: + $ref: '#/components/schemas/onvif_AutoFocusMode' + type: array + DefaultSpeed: + $ref: '#/components/schemas/onvif_FloatRange' + FarLimit: + $ref: '#/components/schemas/onvif_FloatRange' + NearLimit: + $ref: '#/components/schemas/onvif_FloatRange' + required: + - DefaultSpeed + - NearLimit + - FarLimit + type: object + onvif_FocusOptions20: + properties: + AutoFocusModes: + description: Supported modes for auto focus. + items: + $ref: '#/components/schemas/onvif_AutoFocusMode' + type: array + DefaultSpeed: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of DefaultSpeed. + Extension: + $ref: '#/components/schemas/onvif_FocusOptions20Extension' + FarLimit: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of FarLimit. + NearLimit: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of NearLimit. + type: object + onvif_FocusOptions20Extension: + properties: + AFModes: + description: Supported options for auto focus. Options shall be chosen from + tt:AFModes. + items: type: string - requestBody: - content: - application/json: - schema: - example: - SystemReboot: {} - properties: - SystemReboot: - properties: {} - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 21:55:59 GMT - type: string - X-Correlation-Id: - schema: - example: 0b194034-4975-4f5b-8141-63ec88666987 - type: string - summary: SystemReboot - tags: - - System Function - /api/v2/device/name/{EDGEX_DEVICE_NAME}/UnsubscribeCameraEvent: - put: - 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.' - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + type: object + onvif_FocusStatus: + properties: + Error: + description: Error status of focus. + type: string + MoveStatus: + allOf: + - $ref: '#/components/schemas/onvif_MoveStatus' + - description: Status of focus MoveStatus. + Position: + description: Status of focus position. + type: number + required: + - Position + - MoveStatus + - Error + type: object + onvif_FocusStatus20: + properties: + Error: + description: Error status of focus. + type: string + Extension: + $ref: '#/components/schemas/onvif_FocusStatus20Extension' + MoveStatus: + allOf: + - $ref: '#/components/schemas/onvif_MoveStatus' + - description: Status of focus MoveStatus. + Position: + description: Status of focus position. + type: number + required: + - Position + - MoveStatus + type: object + onvif_FocusStatus20Extension: + type: object + onvif_Frame: + properties: + Colorspace: + description: Default color space of Color definitions in frame. Valid values + are "RGB" and "YCbCr". Defaults to "YCbCr". + type: string + Extension: + $ref: '#/components/schemas/onvif_FrameExtension' + Object: + items: + $ref: '#/components/schemas/onvif_Object' + type: array + ObjectTree: + $ref: '#/components/schemas/onvif_ObjectTree' + PTZStatus: + $ref: '#/components/schemas/onvif_PTZStatus' + SceneImage: + format: binary + type: string + SceneImageRef: + type: string + Source: + description: Optional name of the analytics module that generated this frame. + type: string + Transformation: + $ref: '#/components/schemas/onvif_Transformation' + UtcTime: + format: date-time + type: string + required: + - UtcTime + type: object + onvif_FrameExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_FrameExtension2' + MotionInCells: + $ref: '#/components/schemas/onvif_MotionInCells' + type: object + onvif_FrameExtension2: + type: object + onvif_G711DecOptions: + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported bitrates in kbps + SampleRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported sample rates in kHz + required: + - Bitrate + - SampleRateRange + type: object + onvif_G726DecOptions: + properties: + Bitrate: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported bitrates in kbps + SampleRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported sample rates in kHz + required: + - Bitrate + - SampleRateRange + type: object + onvif_GenericEapPwdConfigurationExtension: + type: object + onvif_GeoLocation: + properties: + elevation: + description: Hight in meters above sea level. + type: number + lat: + description: North south location as angle. + type: number + lon: + description: East west location as angle. + type: number + type: object + onvif_GeoOrientation: + properties: + pitch: + description: Rotation around the y axis. + type: number + roll: + description: Rotation around the x axis. + type: number + yaw: + description: Rotation around the z axis. + type: number + type: object + onvif_GetRecordingJobsResponseItem: + properties: + JobConfiguration: + $ref: '#/components/schemas/onvif_RecordingJobConfiguration' + JobToken: + maxLength: 64 + type: string + required: + - JobToken + - JobConfiguration + type: object + onvif_GetRecordingsResponseItem: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_RecordingConfiguration' + - description: Configuration of the recording. + RecordingToken: + description: Token of the recording. + maxLength: 64 + type: string + Tracks: + allOf: + - $ref: '#/components/schemas/onvif_GetTracksResponseList' + - description: List of tracks. + required: + - RecordingToken + - Configuration + - Tracks + type: object + onvif_GetTracksResponseItem: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_TrackConfiguration' + - description: Configuration of the track. + TrackToken: + description: Token of the track. + maxLength: 64 + type: string + required: + - TrackToken + - Configuration + type: object + onvif_GetTracksResponseList: + properties: + Track: + description: Configuration of a track. + items: + $ref: '#/components/schemas/onvif_GetTracksResponseItem' + type: array + type: object + onvif_H264Configuration: + properties: + GovLength: + 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. + format: int32 + type: integer + H264Profile: + allOf: + - $ref: '#/components/schemas/onvif_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high + required: + - GovLength + - H264Profile + type: object + onvif_H264DecOptions: + properties: + ResolutionsAvailable: + description: List of supported H.264 Video Resolutions + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported H.264 framerate range in fps + SupportedH264Profiles: + description: List of supported H264 Profiles (either baseline, main, extended + or high) + items: + $ref: '#/components/schemas/onvif_H264Profile' + type: array + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported H.264 bitrate range in kbps + required: + - ResolutionsAvailable + - SupportedH264Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + onvif_H264Options: + properties: + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + FrameRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported frame rate in fps (frames per second). + GovLengthRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported group of Video frames length. This value typically + corresponds to the I-Frame distance. + H264ProfilesSupported: + description: List of supported H.264 profiles. + items: + $ref: '#/components/schemas/onvif_H264Profile' + type: array + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported + type: object + onvif_H264Options2: + allOf: + - $ref: '#/components/schemas/onvif_H264Options' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. + required: + - BitrateRange + type: object + onvif_H264Profile: + enum: + - Baseline + - Main + - Extended + - High + type: string + onvif_HostnameInformation: + properties: + Extension: + $ref: '#/components/schemas/onvif_HostnameInformationExtension' + FromDHCP: + description: Indicates whether the hostname is obtained from DHCP or not. + type: boolean + Name: + description: Indicates the hostname. + type: string + required: + - FromDHCP + type: object + onvif_HostnameInformationExtension: + type: object + onvif_IOCapabilities: + properties: + Extension: + $ref: '#/components/schemas/onvif_IOCapabilitiesExtension' + InputConnectors: + description: Number of input connectors. + format: int32 + type: integer + RelayOutputs: + description: Number of relay outputs. + format: int32 + type: integer + type: object + onvif_IOCapabilitiesExtension: + properties: + Auxiliary: + type: boolean + AuxiliaryCommands: + items: + maxLength: 128 + type: string + type: array + Extension: + $ref: '#/components/schemas/onvif_IOCapabilitiesExtension2' + required: + - Extension + type: object + onvif_IOCapabilitiesExtension2: + type: object + onvif_IPAddress: + properties: + IPv4Address: + description: IPv4 address. + type: string + IPv6Address: + description: IPv6 address + type: string + Type: + allOf: + - $ref: '#/components/schemas/onvif_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. + required: + - Type + type: object + onvif_IPAddressFilter: + properties: + Extension: + $ref: '#/components/schemas/onvif_IPAddressFilterExtension' + IPv4Address: + items: + $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + type: array + IPv6Address: + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + Type: + $ref: '#/components/schemas/onvif_IPAddressFilterType' + required: + - Type + type: object + onvif_IPAddressFilterExtension: + type: object + onvif_IPAddressFilterType: + enum: + - Allow + - Deny + type: string + onvif_IPType: + enum: + - IPv4 + - IPv6 + type: string + onvif_IPv4Configuration: + properties: + DHCP: + description: Indicates whether or not DHCP is used. + type: boolean + FromDHCP: + allOf: + - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + LinkLocal: + allOf: + - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + - description: Link local address. + Manual: + description: List of manually added IPv4 addresses. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + type: array + required: + - DHCP + type: object + onvif_IPv4NetworkInterface: + properties: + Config: + allOf: + - $ref: '#/components/schemas/onvif_IPv4Configuration' + - description: IPv4 configuration. + Enabled: + description: Indicates whether or not IPv4 is enabled. + type: boolean + required: + - Enabled + - Config + type: object + onvif_IPv4NetworkInterfaceSetConfiguration: + properties: + DHCP: + description: Indicates whether or not DHCP is used. + type: boolean + Enabled: + description: Indicates whether or not IPv4 is enabled. + type: boolean + Manual: + description: List of manually added IPv4 addresses. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + type: array + type: object + onvif_IPv6Configuration: + properties: + AcceptRouterAdvert: + description: Indicates whether router advertisment is used. + type: boolean + DHCP: + allOf: + - $ref: '#/components/schemas/onvif_IPv6DHCPConfiguration' + - description: DHCP configuration. + Extension: + $ref: '#/components/schemas/onvif_IPv6ConfigurationExtension' + FromDHCP: + description: List of IPv6 addresses configured by using DHCP. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + FromRA: + description: List of IPv6 addresses configured by using router advertisment. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + LinkLocal: + description: List of link local IPv6 addresses. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + Manual: + description: List of manually entered IPv6 addresses. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + required: + - DHCP + type: object + onvif_IPv6ConfigurationExtension: + type: object + onvif_IPv6DHCPConfiguration: + enum: + - Auto + - Stateful + - Stateless + - false + type: string + onvif_IPv6NetworkInterface: + properties: + Config: + allOf: + - $ref: '#/components/schemas/onvif_IPv6Configuration' + - description: IPv6 configuration. + Enabled: + description: Indicates whether or not IPv6 is enabled. + type: boolean + required: + - Enabled + type: object + onvif_IPv6NetworkInterfaceSetConfiguration: + properties: + AcceptRouterAdvert: + description: Indicates whether router advertisment is used. + type: boolean + DHCP: + allOf: + - $ref: '#/components/schemas/onvif_IPv6DHCPConfiguration' + - description: DHCP configuration. + Enabled: + description: Indicates whether or not IPv6 is enabled. + type: boolean + Manual: + description: List of manually added IPv6 addresses. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + type: object + onvif_Idle: + type: object + onvif_ImageSendingType: + enum: + - Embedded + - LocalStorage + - RemoteStorage + type: string + onvif_ImageStabilization: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImageStabilizationExtension' + Level: + description: Optional level parameter (unit unspecified) + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_ImageStabilizationMode' + - description: Parameter to enable/disable Image Stabilization feature. + required: + - Mode + type: object + onvif_ImageStabilizationExtension: + type: object + onvif_ImageStabilizationMode: + enum: + - false + - true + - AUTO + - Extended + type: string + onvif_ImageStabilizationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImageStabilizationOptionsExtension' + Level: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of the Image Stabilization. + Mode: + description: Supported options of Image Stabilization mode parameter. + items: + $ref: '#/components/schemas/onvif_ImageStabilizationMode' + type: array + required: + - Mode + type: object + onvif_ImageStabilizationOptionsExtension: + type: object + onvif_ImagingCapabilities: + properties: + XAddr: + description: Imaging service URI. + type: string + required: + - XAddr + type: object + onvif_ImagingOptions: + properties: + BacklightCompensation: + $ref: '#/components/schemas/onvif_BacklightCompensationOptions' + Brightness: + $ref: '#/components/schemas/onvif_FloatRange' + ColorSaturation: + $ref: '#/components/schemas/onvif_FloatRange' + Contrast: + $ref: '#/components/schemas/onvif_FloatRange' + Exposure: + $ref: '#/components/schemas/onvif_ExposureOptions' + Focus: + $ref: '#/components/schemas/onvif_FocusOptions' + IrCutFilterModes: + items: + $ref: '#/components/schemas/onvif_IrCutFilterMode' + type: array + Sharpness: + $ref: '#/components/schemas/onvif_FloatRange' + WhiteBalance: + $ref: '#/components/schemas/onvif_WhiteBalanceOptions' + WideDynamicRange: + $ref: '#/components/schemas/onvif_WideDynamicRangeOptions' + required: + - BacklightCompensation + - Brightness + - ColorSaturation + - Contrast + - Exposure + - Focus + - IrCutFilterModes + - Sharpness + - WideDynamicRange + - WhiteBalance + type: object + onvif_ImagingOptions20: + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/onvif_BacklightCompensationOptions20' + - description: Valid range of Backlight Compensation. + Brightness: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of Brightness. + ColorSaturation: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of Color Saturation. + Contrast: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of Contrast. + Exposure: + allOf: + - $ref: '#/components/schemas/onvif_ExposureOptions20' + - description: Valid range of Exposure. + Extension: + $ref: '#/components/schemas/onvif_ImagingOptions20Extension' + Focus: + allOf: + - $ref: '#/components/schemas/onvif_FocusOptions20' + - description: Valid range of Focus. + IrCutFilterModes: + description: Valid range of IrCutFilterModes. + items: + $ref: '#/components/schemas/onvif_IrCutFilterMode' + type: array + Sharpness: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid range of Sharpness. + WhiteBalance: + allOf: + - $ref: '#/components/schemas/onvif_WhiteBalanceOptions20' + - description: Valid range of WhiteBalance. + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/onvif_WideDynamicRangeOptions20' + - description: Valid range of WideDynamicRange. + type: object + onvif_ImagingOptions20Extension: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImagingOptions20Extension2' + ImageStabilization: + allOf: + - $ref: '#/components/schemas/onvif_ImageStabilizationOptions' + - description: Options of parameters for Image Stabilization feature. + type: object + onvif_ImagingOptions20Extension2: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImagingOptions20Extension3' + IrCutFilterAutoAdjustment: + allOf: + - $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustmentOptions' + - description: Options of parameters for adjustment of Ir cut filter auto + mode. + type: object + onvif_ImagingOptions20Extension3: + properties: + DefoggingOptions: + allOf: + - $ref: '#/components/schemas/onvif_DefoggingOptions' + - description: Options of parameters for Defogging feature. + Extension: + $ref: '#/components/schemas/onvif_ImagingOptions20Extension4' + NoiseReductionOptions: + allOf: + - $ref: '#/components/schemas/onvif_NoiseReductionOptions' + - description: Options of parameter for Noise Reduction feature. + ToneCompensationOptions: + allOf: + - $ref: '#/components/schemas/onvif_ToneCompensationOptions' + - description: Options of parameters for Tone Compensation feature. + type: object + onvif_ImagingOptions20Extension4: + type: object + onvif_ImagingSettings: + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/onvif_BacklightCompensation' + - description: Enabled/disabled BLC mode (on/off). + Brightness: + description: Image brightness (unit unspecified). + type: number + ColorSaturation: + description: Color saturation of the image (unit unspecified). + type: number + Contrast: + description: Contrast of the image (unit unspecified). + type: number + Exposure: + allOf: + - $ref: '#/components/schemas/onvif_Exposure' + - description: Exposure mode of the device. + Extension: + $ref: '#/components/schemas/onvif_ImagingSettingsExtension' + Focus: + allOf: + - $ref: '#/components/schemas/onvif_FocusConfiguration' + - description: Focus configuration. + IrCutFilter: + allOf: + - $ref: '#/components/schemas/onvif_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + Sharpness: + description: Sharpness of the Video image. + type: number + WhiteBalance: + allOf: + - $ref: '#/components/schemas/onvif_WhiteBalance' + - description: White balance settings. + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/onvif_WideDynamicRange' + - description: WDR settings. + type: object + onvif_ImagingSettings20: + description: Type describing the ImagingSettings of a VideoSource. The supported + options and ranges can be obtained via the GetOptions command. + properties: + BacklightCompensation: + allOf: + - $ref: '#/components/schemas/onvif_BacklightCompensation20' + - description: Enabled/disabled BLC mode (on/off). + Brightness: + description: Image brightness (unit unspecified). + type: number + ColorSaturation: + description: Color saturation of the image (unit unspecified). + type: number + Contrast: + description: Contrast of the image (unit unspecified). + type: number + Exposure: + allOf: + - $ref: '#/components/schemas/onvif_Exposure20' + - description: Exposure mode of the device. + Extension: + $ref: '#/components/schemas/onvif_ImagingSettingsExtension20' + Focus: + allOf: + - $ref: '#/components/schemas/onvif_FocusConfiguration20' + - description: Focus configuration. + IrCutFilter: + allOf: + - $ref: '#/components/schemas/onvif_IrCutFilterMode' + - description: Infrared Cutoff Filter settings. + Sharpness: + description: Sharpness of the Video image. + type: number + WhiteBalance: + allOf: + - $ref: '#/components/schemas/onvif_WhiteBalance20' + - description: White balance settings. + WideDynamicRange: + allOf: + - $ref: '#/components/schemas/onvif_WideDynamicRange20' + - description: WDR settings. + type: object + onvif_ImagingSettingsExtension: + type: object + onvif_ImagingSettingsExtension20: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImagingSettingsExtension202' + ImageStabilization: + allOf: + - $ref: '#/components/schemas/onvif_ImageStabilization' + - description: Optional element to configure Image Stabilization feature. + type: object + onvif_ImagingSettingsExtension202: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImagingSettingsExtension203' + IrCutFilterAutoAdjustment: + description: An optional parameter applied to only auto mode to adjust timing + of toggling Ir cut filter. + items: + $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustment' + type: array + type: object + onvif_ImagingSettingsExtension203: + properties: + Defogging: + allOf: + - $ref: '#/components/schemas/onvif_Defogging' + - description: Optional element to configure Image Defogging. + Extension: + $ref: '#/components/schemas/onvif_ImagingSettingsExtension204' + NoiseReduction: + allOf: + - $ref: '#/components/schemas/onvif_NoiseReduction' + - description: Optional element to configure Image Noise Reduction. + ToneCompensation: + allOf: + - $ref: '#/components/schemas/onvif_ToneCompensation' + - description: Optional element to configure Image Contrast Compensation. + type: object + onvif_ImagingSettingsExtension204: + type: object + onvif_ImagingStatus: + properties: + FocusStatus: + $ref: '#/components/schemas/onvif_FocusStatus' + required: + - FocusStatus + type: object + onvif_ImagingStatus20: + properties: + Extension: + $ref: '#/components/schemas/onvif_ImagingStatus20Extension' + FocusStatus20: + allOf: + - $ref: '#/components/schemas/onvif_FocusStatus20' + - description: Status of focus. + type: object + onvif_ImagingStatus20Extension: + type: object + onvif_IntItems: + description: List of values. + properties: + Items: + items: + format: int32 + type: integer + type: array + type: object + onvif_IntRange: + description: Range of values greater equal Min value and less equal Max value. + properties: + Max: + format: int32 + type: integer + Min: + format: int32 + type: integer + required: + - Min + - Max + type: object + onvif_IntRectangle: + description: Rectangle defined by lower left corner position and size. Units + are pixel. + properties: + height: + format: int32 + type: integer + width: + format: int32 + type: integer + x: + format: int32 + type: integer + y: + format: int32 + type: integer + required: + - x + - y + - width + - height + type: object + onvif_IntRectangleRange: + description: Range of a rectangle. The rectangle itself is defined by lower + left corner position and size. Units are pixel. + properties: + HeightRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of height. + WidthRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of width. + XRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of X-axis. + YRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of Y-axis. + required: + - XRange + - YRange + - WidthRange + - HeightRange + type: object + onvif_IrCutFilterAutoAdjustment: + properties: + BoundaryOffset: + 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). + type: number + BoundaryType: + description: Specifies which boundaries to automatically toggle Ir cut filter + following parameters are applied to. Its options shall be chosen from + tt:IrCutFilterAutoBoundaryType. + type: string + Extension: + $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustmentExtension' + ResponseTime: + description: Delay time of toggling Ir cut filter to on/off after crossing + of the boundary exposure levels. + format: date-time + type: string + required: + - BoundaryType + type: object + onvif_IrCutFilterAutoAdjustmentExtension: + type: object + onvif_IrCutFilterAutoAdjustmentOptions: + properties: + BoundaryOffset: + description: Indicates whether or not boundary offset for toggling Ir cut + filter is supported. + type: boolean + BoundaryType: + description: Supported options of boundary types for adjustment of Ir cut + filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. + items: + type: string + type: array + Extension: + $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustmentOptionsExtension' + ResponseTimeRange: + allOf: + - $ref: '#/components/schemas/onvif_DurationRange' + - description: Supported range of delay time for toggling Ir cut filter. + required: + - BoundaryType + type: object + onvif_IrCutFilterAutoAdjustmentOptionsExtension: + type: object + onvif_IrCutFilterAutoBoundaryType: + enum: + - Common + - ToOn + - ToOff + - Extended + type: string + onvif_IrCutFilterMode: + enum: + - true + - false + - AUTO + type: string + onvif_ItemList: + properties: + ElementItem: + description: Complex value structure. + items: + $ref: '#/components/schemas/onvif_ElementItem' + type: array + Extension: + $ref: '#/components/schemas/onvif_ItemListExtension' + SimpleItem: + description: Value name pair as defined by the corresponding description. + items: + $ref: '#/components/schemas/onvif_SimpleItem' + type: array + type: object + onvif_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." + properties: + ElementItemDescription: + description: Description of a complex type. The Type must reference a defined + type. + items: + $ref: '#/components/schemas/onvif_ElementItemDescription' + type: array + Extension: + $ref: '#/components/schemas/onvif_ItemListDescriptionExtension' + SimpleItemDescription: + description: Description of a simple item. The type must be of cathegory + simpleType (xs:string, xs:integer, xs:float, ...). + items: + $ref: '#/components/schemas/onvif_SimpleItemDescription' + type: array + type: object + onvif_ItemListDescriptionExtension: + type: object + onvif_ItemListExtension: + type: object + onvif_JpegDecOptions: + properties: + ResolutionsAvailable: + description: List of supported Jpeg Video Resolutions + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported Jpeg framerate range in fps + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported Jpeg bitrate range in kbps + required: + - ResolutionsAvailable + - SupportedInputBitrate + - SupportedFrameRate + type: object + onvif_JpegOptions: + properties: + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + FrameRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported frame rate in fps (frames per second). + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array + required: + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange + type: object + onvif_JpegOptions2: + allOf: + - $ref: '#/components/schemas/onvif_JpegOptions' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. + required: + - BitrateRange + type: object + onvif_Layout: + description: A layout describes a set of Video windows that are displayed simultaniously + on a display. + properties: + Extension: + $ref: '#/components/schemas/onvif_LayoutExtension' + PaneLayout: + description: List of panes assembling the display layout. + items: + $ref: '#/components/schemas/onvif_PaneLayout' + type: array + required: + - PaneLayout + type: object + onvif_LayoutExtension: + type: object + onvif_LayoutOptions: + description: The options supported for a display layout. + properties: + Extension: + $ref: '#/components/schemas/onvif_LayoutOptionsExtension' + PaneLayoutOptions: + description: Lists the possible Pane Layouts of the Video Output + items: + $ref: '#/components/schemas/onvif_PaneLayoutOptions' + type: array + required: + - PaneLayoutOptions + type: object + onvif_LayoutOptionsExtension: + type: object + onvif_LensDescription: + properties: + FocalLength: + description: Optional focal length of the optical system. + type: number + Offset: + allOf: + - $ref: '#/components/schemas/onvif_LensOffset' + - description: Offset of the lens center to the imager center in normalized + coordinates. + Projection: + description: "Radial description of the projection characteristics. The\ + \ resulting curve is defined by the B-Spline interpolation \n\t\t\t\t\t\ + over 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)." + items: + $ref: '#/components/schemas/onvif_LensProjection' + type: array + XFactor: + description: Compensation of the x coordinate needed for the ONVIF normalized + coordinate system. + type: number + required: + - Offset + - Projection + - XFactor + type: object + onvif_LensOffset: + properties: + x: + description: Optional horizontal offset of the lens center in normalized + coordinates. + type: number + y: + description: Optional vertical offset of the lens center in normalized coordinates. + type: number + type: object + onvif_LensProjection: + properties: + Angle: + description: Angle of incidence. + type: number + Radius: + description: Mapping radius as a consequence of the emergent angle. + type: number + Transmittance: + description: Optional ray absorption at the given angle due to vignetting. + A value of one means no absorption. + type: number + required: + - Angle + - Radius + type: object + onvif_LicensePlateInfo: + properties: + CountryCode: + allOf: + - $ref: '#/components/schemas/onvif_StringLikelihood' + - description: Describe the country of the license plate, in order to avoid + the same license plate number. + IssuingEntity: + allOf: + - $ref: '#/components/schemas/onvif_StringLikelihood' + - description: State province or authority that issue the license plate. + PlateNumber: + allOf: + - $ref: '#/components/schemas/onvif_StringLikelihood' + - description: A string of vehicle license plate number. + PlateType: + allOf: + - $ref: '#/components/schemas/onvif_StringLikelihood' + - description: A description of the vehicle license plate, e.g., "Normal", + "Police", "Diplomat" + required: + - PlateNumber + type: object + onvif_LocalLocation: + properties: + x: + description: East west location as angle. + type: number + y: + description: North south location as angle. + type: number + z: + description: Offset in meters from the sea level. + type: number + type: object + onvif_LocalOrientation: + properties: + pan: + description: Rotation around the y axis. + type: number + roll: + description: Rotation around the x axis. + type: number + tilt: + description: Rotation around the z axis. + type: number + type: object + onvif_LocationEntity: + properties: + AutoGeo: + description: If set the geo location is obtained internally. + type: boolean + Entity: + description: Entity type the entry refers to, use a value from the tt:Entity + enumeration. + type: string + Fixed: + description: If this value is true the entity cannot be deleted. + type: boolean + GeoLocation: + allOf: + - $ref: '#/components/schemas/onvif_GeoLocation' + - description: Location on earth. + GeoOrientation: + allOf: + - $ref: '#/components/schemas/onvif_GeoOrientation' + - description: Orientation relative to earth. + GeoSource: + description: Optional reference to the XAddr of another devices DeviceManagement + service. + type: string + LocalLocation: + allOf: + - $ref: '#/components/schemas/onvif_LocalLocation' + - description: Indoor location offset. + LocalOrientation: + allOf: + - $ref: '#/components/schemas/onvif_LocalOrientation' + - description: Indoor orientation offset. + Token: + description: Optional entity token. + maxLength: 64 + type: string + type: object + onvif_MaximumNumberOfOSDs: + properties: + Date: + format: int32 + type: integer + DateAndTime: + format: int32 + type: integer + Image: + format: int32 + type: integer + PlainText: + format: int32 + type: integer + Time: + format: int32 + type: integer + Total: + format: int32 + type: integer + required: + - Total + type: object + onvif_MediaAttributes: + description: A set of media attributes valid for a recording at a point in time + or for a time interval. + properties: + From: + description: The attributes are valid from this point in time in the recording. + format: date-time + type: string + RecordingToken: + description: A reference to the recording that has these attributes. + maxLength: 64 + type: string + TrackAttributes: + description: A set of attributes for each track. + items: + $ref: '#/components/schemas/onvif_TrackAttributes' + type: array + Until: + 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. + format: date-time + type: string + required: + - RecordingToken + - From + - Until + type: object + onvif_MediaCapabilities: + properties: + Extension: + $ref: '#/components/schemas/onvif_MediaCapabilitiesExtension' + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/onvif_RealTimeStreamingCapabilities' + - description: Streaming capabilities. + XAddr: + description: Media service URI. + type: string + required: + - XAddr + - StreamingCapabilities + type: object + onvif_MediaCapabilitiesExtension: + properties: + ProfileCapabilities: + $ref: '#/components/schemas/onvif_ProfileCapabilities' + required: + - ProfileCapabilities + type: object + onvif_MediaUri: + properties: + InvalidAfterConnect: + description: Indicates if the Uri is only valid until the connection is + established. The value shall be set to "false". + type: boolean + InvalidAfterReboot: + description: Indicates if the Uri is invalid after a reboot of the device. + The value shall be set to "false". + type: boolean + Timeout: + 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 + format: date-time + type: string + Uri: + description: Stable Uri to be used for requesting the media stream + type: string + required: + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout + type: object + onvif_Merge: + properties: + from: + items: + $ref: '#/components/schemas/onvif_ObjectId' + type: array + to: + $ref: '#/components/schemas/onvif_ObjectId' + required: + - from + - to + type: object + onvif_Message: + properties: + Data: + $ref: '#/components/schemas/onvif_ItemList' + Extension: + $ref: '#/components/schemas/onvif_MessageExtension' + Key: + $ref: '#/components/schemas/onvif_ItemList' + PropertyOperation: + $ref: '#/components/schemas/onvif_PropertyOperation' + Source: + allOf: + - $ref: '#/components/schemas/onvif_ItemList' + - description: Token value pairs that triggered this message. Typically + only one item is present. + UtcTime: + format: date-time + type: string + required: + - UtcTime + type: object + onvif_MessageDescription: + properties: + Data: + allOf: + - $ref: '#/components/schemas/onvif_ItemListDescription' + - description: Describes the payload of the message. + Extension: + $ref: '#/components/schemas/onvif_MessageDescriptionExtension' + IsProperty: + 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. + type: boolean + Key: + allOf: + - $ref: '#/components/schemas/onvif_ItemListDescription' + - description: Describes optional message payload parameters that may be + used as key. E.g. object IDs of tracked objects are conveyed as key. + Source: + allOf: + - $ref: '#/components/schemas/onvif_ItemListDescription' + - 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." + type: object + onvif_MessageDescriptionExtension: + type: object + onvif_MessageExtension: + type: object + onvif_Messages: + allOf: + - $ref: '#/components/schemas/onvif_MessageDescription' + - properties: + ParentTopic: + description: The topic of the message. For historical reason the element + is named ParentTopic, but the full topic is expected. + type: string + required: + - ParentTopic + type: object + 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." + onvif_MetadataAttributes: + properties: + CanContainAnalytics: + description: Indicates that there can be analytics data in the metadata + track in the specified time interval. + type: boolean + CanContainNotifications: + description: Indicates that there can be notifications in the metadata track + in the specified time interval. + type: boolean + CanContainPTZ: + description: Indicates that there can be PTZ data in the metadata track + in the specified time interval. + type: boolean + PtzSpaces: + 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. + type: string + required: + - CanContainPTZ + - CanContainAnalytics + - CanContainNotifications + type: object + onvif_MetadataCompressionType: + enum: + - None + - GZIP + - EXI + type: string + onvif_MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Analytics: + description: Defines whether the streamed metadata will include metadata + from the analytics engines (video, cell motion, audio etc.) + type: boolean + AnalyticsEngineConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AnalyticsEngineConfiguration' + - 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." + CompressionType: + description: Optional parameter to configure compression type of Metadata + payload. Use values from enumeration MetadataCompressionType. + type: string + Events: + allOf: + - $ref: '#/components/schemas/onvif_EventSubscription' + - 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\t\ + none or some of the events produced by the device:" + Extension: + $ref: '#/components/schemas/onvif_MetadataConfigurationExtension' + GeoLocation: + description: Optional parameter to configure if the metadata stream shall + contain the Geo Location coordinates of each target. + type: boolean + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + PTZStatus: + allOf: + - $ref: '#/components/schemas/onvif_PTZFilter' + - description: optional element to configure which PTZ related data is + to include in the metadata stream + SessionTimeout: + description: The rtsp session timeout for the related audio stream (when + using Media2 Service, this value is deprecated and ignored) + format: date-time + type: string + ShapePolygon: + description: Optional parameter to configure if the generated metadata + stream should contain shape information as polygon. + type: boolean + required: + - Multicast + - SessionTimeout + type: object + onvif_MetadataConfigurationExtension: + type: object + onvif_MetadataConfigurationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_MetadataConfigurationOptionsExtension' + GeoLocation: + description: True if the device is able to stream the Geo Located positions + of each target. + type: boolean + MaxContentFilterSize: + description: A device signalling support for content filtering shall support + expressions with the provided expression size. + format: int32 + type: integer + PTZStatusFilterOptions: + $ref: '#/components/schemas/onvif_PTZStatusFilterOptions' + required: + - PTZStatusFilterOptions + type: object + onvif_MetadataConfigurationOptionsExtension: + properties: + CompressionType: + description: List of supported metadata compression type. Its options shall + be chosen from tt:MetadataCompressionType. + items: + type: string + type: array + Extension: + $ref: '#/components/schemas/onvif_MetadataConfigurationOptionsExtension2' + type: object + onvif_MetadataConfigurationOptionsExtension2: + type: object + onvif_MetadataFilter: + properties: + MetadataStreamFilter: + type: string + required: + - MetadataStreamFilter + type: object + onvif_MetadataInput: + properties: + Extension: + $ref: '#/components/schemas/onvif_MetadataInputExtension' + MetadataConfig: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + type: object + onvif_MetadataInputExtension: + type: object + onvif_MetadataStream: + properties: + Event: + items: + oneOf: + - $ref: '#/components/schemas/onvif_EventStreamChoice0' + - $ref: '#/components/schemas/onvif_EventStreamChoice1' + - $ref: '#/components/schemas/onvif_EventStreamChoice2' + type: array + Extension: + items: + $ref: '#/components/schemas/onvif_MetadataStreamExtension' + type: array + PTZ: + items: + oneOf: + - $ref: '#/components/schemas/onvif_PTZStreamChoice0' + - $ref: '#/components/schemas/onvif_PTZStreamChoice1' + - $ref: '#/components/schemas/onvif_PTZStreamChoice2' + type: array + VideoAnalytics: + items: + oneOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamChoice0' + - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamChoice1' + - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamChoice2' + type: array + type: object + onvif_MetadataStreamExtension: + properties: + AudioAnalyticsStream: + $ref: '#/components/schemas/onvif_AudioAnalyticsStream' + Extension: + $ref: '#/components/schemas/onvif_MetadataStreamExtension2' + type: object + onvif_MetadataStreamExtension2: + type: object + onvif_ModeOfOperation: + enum: + - Idle + - Active + - Unknown + type: string + onvif_MotionExpression: + properties: + Expression: + description: Motion Expression data structure contains motion expression + which is based on Scene Descriptor schema with XPATH syntax. The Type + argument could allow introduction of different dialects + type: string + Type: + type: string + required: + - Expression + type: object + onvif_MotionExpressionConfiguration: + properties: + MotionExpression: + allOf: + - $ref: '#/components/schemas/onvif_MotionExpression' + - description: Contains Rule MotionExpression configuration + required: + - MotionExpression + type: object + onvif_MotionInCells: + properties: + Cells: + description: A “1” denotes a cell where motion is detected and a “0” 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 Packbit coding in ISO + 12369 (TIFF, Revision 6.0). + format: binary + type: string + Columns: + description: Number of columns of the cell grid (x dimension) + format: int32 + type: integer + Rows: + description: Number of rows of the cell grid (y dimension) + format: int32 + type: integer + required: + - Columns + - Rows + - Cells + type: object + onvif_MoveAndTrackMethod: + enum: + - PresetToken + - GeoLocation + - PTZVector + - ObjectID + type: string + onvif_MoveOptions: + properties: + Absolute: + $ref: '#/components/schemas/onvif_AbsoluteFocusOptions' + Continuous: + $ref: '#/components/schemas/onvif_ContinuousFocusOptions' + Relative: + $ref: '#/components/schemas/onvif_RelativeFocusOptions' + type: object + onvif_MoveOptions20: + properties: + Absolute: + allOf: + - $ref: '#/components/schemas/onvif_AbsoluteFocusOptions' + - description: Valid ranges for the absolute control. + Continuous: + allOf: + - $ref: '#/components/schemas/onvif_ContinuousFocusOptions' + - description: Valid ranges for the continuous control. + Relative: + allOf: + - $ref: '#/components/schemas/onvif_RelativeFocusOptions20' + - description: Valid ranges for the relative control. + type: object + onvif_MoveStatus: + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + onvif_Mpeg4Configuration: + properties: + GovLength: + 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. + format: int32 + type: integer + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced + simple profile (ASP) + required: + - GovLength + - Mpeg4Profile + type: object + onvif_Mpeg4DecOptions: + properties: + ResolutionsAvailable: + description: List of supported Mpeg4 Video Resolutions + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array + SupportedFrameRate: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported Mpeg4 framerate range in fps + SupportedInputBitrate: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported Mpeg4 bitrate range in kbps + SupportedMpeg4Profiles: + description: List of supported Mpeg4 Profiles (either SP or ASP) + items: + $ref: '#/components/schemas/onvif_Mpeg4Profile' + type: array + required: + - ResolutionsAvailable + - SupportedMpeg4Profiles + - SupportedInputBitrate + - SupportedFrameRate + type: object + onvif_Mpeg4Options: + properties: + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + FrameRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported frame rate in fps (frames per second). + GovLengthRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported group of Video frames length. This value typically + corresponds to the I-Frame distance. + Mpeg4ProfilesSupported: + description: List of supported MPEG-4 profiles. + items: + $ref: '#/components/schemas/onvif_Mpeg4Profile' + type: array + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported + type: object + onvif_Mpeg4Options2: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Options' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. + required: + - BitrateRange + type: object + onvif_Mpeg4Profile: + enum: + - SP + - ASP + type: string + onvif_MulticastConfiguration: + properties: + Address: + allOf: + - $ref: '#/components/schemas/onvif_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast + streaming is enaled) + AutoStart: + description: Read only property signalling that streaming is persistant. + Use the methods StartMulticastStreaming and StopMulticastStreaming to + switch its state. + type: boolean + Port: + description: The RTP mutlicast 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. + format: int32 + type: integer + TTL: + 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. + format: int32 + type: integer + required: + - Address + - Port + - TTL + - AutoStart + type: object + onvif_NTPInformation: + properties: + Extension: + $ref: '#/components/schemas/onvif_NTPInformationExtension' + FromDHCP: + description: Indicates if NTP information is to be retrieved by using DHCP. + type: boolean + NTPFromDHCP: + description: List of NTP addresses retrieved by using DHCP. + items: + $ref: '#/components/schemas/onvif_NetworkHost' + type: array + NTPManual: + description: List of manually entered NTP addresses. + items: + $ref: '#/components/schemas/onvif_NetworkHost' + type: array + required: + - FromDHCP + type: object + onvif_NTPInformationExtension: + type: object + onvif_NetworkCapabilities: + properties: + DynDNS: + description: Indicates whether or not is supported. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkCapabilitiesExtension' + IPFilter: + description: Indicates whether or not IP filtering is supported. + type: boolean + IPVersion6: + description: Indicates whether or not IPv6 is supported. + type: boolean + ZeroConfiguration: + description: Indicates whether or not zeroconf is supported. + type: boolean + type: object + onvif_NetworkCapabilitiesExtension: + properties: + Dot11Configuration: + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkCapabilitiesExtension2' + type: object + onvif_NetworkCapabilitiesExtension2: + type: object + onvif_NetworkGateway: + properties: + IPv4Address: + description: IPv4 address string. + items: + type: string + type: array + IPv6Address: + description: IPv6 address string. + items: + type: string + type: array + type: object + onvif_NetworkHost: + properties: + DNSname: + description: DNS name. + type: string + Extension: + $ref: '#/components/schemas/onvif_NetworkHostExtension' + IPv4Address: + description: IPv4 address. + type: string + IPv6Address: + description: IPv6 address. + type: string + Type: + allOf: + - $ref: '#/components/schemas/onvif_NetworkHostType' + - description: 'Network host type: IPv4, IPv6 or DNS.' + required: + - Type + type: object + onvif_NetworkHostExtension: + type: object + onvif_NetworkHostType: + enum: + - IPv4 + - IPv6 + - DNS + type: string + onvif_NetworkInterface: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Enabled: + description: Indicates whether or not an interface is enabled. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceExtension' + IPv4: + allOf: + - $ref: '#/components/schemas/onvif_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + IPv6: + allOf: + - $ref: '#/components/schemas/onvif_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + Info: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceInfo' + - description: Network interface information + Link: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceLink' + - description: Link configuration. + required: + - Enabled + type: object + onvif_NetworkInterfaceConnectionSetting: + properties: + AutoNegotiation: + description: Auto negotiation on/off. + type: boolean + Duplex: + allOf: + - $ref: '#/components/schemas/onvif_Duplex' + - description: Duplex type, Half or Full. + Speed: + description: Speed. + format: int32 + type: integer + required: + - AutoNegotiation + - Speed + - Duplex + type: object + onvif_NetworkInterfaceExtension: + properties: + Dot11: + items: + $ref: '#/components/schemas/onvif_Dot11Configuration' + type: array + Dot3: + description: Extension point prepared for future 802.3 configuration. + items: + $ref: '#/components/schemas/onvif_Dot3Configuration' + type: array + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceExtension2' + InterfaceType: + format: int32 + type: integer + required: + - InterfaceType + type: object + onvif_NetworkInterfaceExtension2: + type: object + onvif_NetworkInterfaceInfo: + properties: + HwAddress: + description: Network interface MAC address. + type: string + MTU: + description: Maximum transmission unit. + format: int32 + type: integer + Name: + description: Network interface name, for example eth0. + type: string + required: + - HwAddress + type: object + onvif_NetworkInterfaceLink: + properties: + AdminSettings: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + InterfaceType: + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + type: integer + OperSettings: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' + - description: Current active link settings. + required: + - AdminSettings + - OperSettings + - InterfaceType + type: object + onvif_NetworkInterfaceSetConfiguration: + properties: + Enabled: + description: Indicates whether or not an interface is enabled. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfigurationExtension' + IPv4: + allOf: + - $ref: '#/components/schemas/onvif_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + IPv6: + allOf: + - $ref: '#/components/schemas/onvif_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + Link: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' + - description: Link configuration. + MTU: + description: Maximum transmission unit. + format: int32 + type: integer + type: object + onvif_NetworkInterfaceSetConfigurationExtension: + properties: + Dot11: + items: + $ref: '#/components/schemas/onvif_Dot11Configuration' + type: array + Dot3: + items: + $ref: '#/components/schemas/onvif_Dot3Configuration' + type: array + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfigurationExtension2' + type: object + onvif_NetworkInterfaceSetConfigurationExtension2: + type: object + onvif_NetworkProtocol: + properties: + Enabled: + description: Indicates if the protocol is enabled or not. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkProtocolExtension' + Name: + allOf: + - $ref: '#/components/schemas/onvif_NetworkProtocolType' + - description: Network protocol type string. + Port: + description: The port that is used by the protocol. + items: + format: int32 + type: integer + type: array + required: + - Name + - Enabled + - Port + type: object + onvif_NetworkProtocolExtension: + type: object + onvif_NetworkProtocolType: + enum: + - HTTP + - HTTPS + - RTSP + type: string + onvif_NetworkZeroConfiguration: + properties: + Addresses: + description: The zero-configuration IPv4 address(es) + items: + type: string + type: array + Enabled: + description: Indicates whether the zero-configuration is enabled or not. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkZeroConfigurationExtension' + InterfaceToken: + description: Unique identifier of network interface. + maxLength: 64 + type: string + required: + - InterfaceToken + - Enabled + type: object + onvif_NetworkZeroConfigurationExtension: + properties: + Additional: + description: Optional array holding the configuration for the second and + possibly further interfaces. + items: + $ref: '#/components/schemas/onvif_NetworkZeroConfiguration' + type: array + Extension: + $ref: '#/components/schemas/onvif_NetworkZeroConfigurationExtension2' + type: object + onvif_NetworkZeroConfigurationExtension2: + type: object + onvif_NoiseReduction: + properties: + Level: + description: Level parameter specified with unitless normalized value from + 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. + type: number + required: + - Level + type: object + onvif_NoiseReductionOptions: + properties: + Level: + description: Indicates whether or not support Level parameter for NoiseReduction. + type: boolean + required: + - Level + type: object + onvif_OSDColor: + description: 'The value range of "Transparent" could be defined by vendors only + should follow this rule: the minimum value means non-transparent and the maximum + value maens fully transparent.' + properties: + Color: + $ref: '#/components/schemas/onvif_Color' + Transparent: + format: int32 + type: integer + required: + - Color + type: object + onvif_OSDColorOptions: + description: Describe the option of the color and its transparency. + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorOptions' + - description: Optional list of supported colors. + Extension: + $ref: '#/components/schemas/onvif_OSDColorOptionsExtension' + Transparent: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of the transparent level. Larger means more tranparent. + type: object + onvif_OSDColorOptionsExtension: + type: object + onvif_OSDConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Extension: + $ref: '#/components/schemas/onvif_OSDConfigurationExtension' + Image: + allOf: + - $ref: '#/components/schemas/onvif_OSDImgConfiguration' + - description: Image configuration of OSD. It shall be present when the + value of Type field is Image + Position: + allOf: + - $ref: '#/components/schemas/onvif_OSDPosConfiguration' + - description: Position configuration of OSD. + TextString: + allOf: + - $ref: '#/components/schemas/onvif_OSDTextConfiguration' + - description: Text configuration of OSD. It shall be present when the + value of Type field is Text. + Type: + allOf: + - $ref: '#/components/schemas/onvif_OSDType' + - description: Type of OSD. + VideoSourceConfigurationToken: + allOf: + - $ref: '#/components/schemas/onvif_OSDReference' + - description: Reference to the video source configuration. + required: + - VideoSourceConfigurationToken + - Type + - Position + type: object + onvif_OSDConfigurationExtension: + type: object + onvif_OSDConfigurationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_OSDConfigurationOptionsExtension' + ImageOption: + allOf: + - $ref: '#/components/schemas/onvif_OSDImgOptions' + - description: Option of the OSD image configuration. This element shall + be returned if the device is signaling the support for Image. + MaximumNumberOfOSDs: + allOf: + - $ref: '#/components/schemas/onvif_MaximumNumberOfOSDs' + - 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. + PositionOption: + description: 'List available OSD position type. Following are the pre-defined:' + items: + type: string + type: array + TextOption: + allOf: + - $ref: '#/components/schemas/onvif_OSDTextOptions' + - description: Option of the OSD text configuration. This element shall + be returned if the device is signaling the support for Text. + Type: + 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. + items: + $ref: '#/components/schemas/onvif_OSDType' + type: array + required: + - MaximumNumberOfOSDs + - Type + - PositionOption + type: object + onvif_OSDConfigurationOptionsExtension: + type: object + onvif_OSDImgConfiguration: + properties: + Extension: + $ref: '#/components/schemas/onvif_OSDImgConfigurationExtension' + ImgPath: + description: The URI of the image which to be displayed. + type: string + required: + - ImgPath + type: object + onvif_OSDImgConfigurationExtension: + type: object + onvif_OSDImgOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_OSDImgOptionsExtension' + FormatsSupported: + description: List of supported image MIME types, such as "image/png". + type: string + ImagePath: + description: List of available image URIs. + items: + type: string + type: array + MaxHeight: + description: The maximum height (in pixels) of the image that can be uploaded. + format: int32 + type: integer + MaxSize: + description: The maximum size (in bytes) of the image that can be uploaded. + format: int32 + type: integer + MaxWidth: + description: The maximum width (in pixels) of the image that can be uploaded. + format: int32 + type: integer + required: + - ImagePath + type: object + onvif_OSDImgOptionsExtension: + type: object + onvif_OSDPosConfiguration: + properties: + Extension: + $ref: '#/components/schemas/onvif_OSDPosConfigurationExtension' + Pos: + $ref: '#/components/schemas/onvif_Vector' + Type: + description: 'For OSD position type, following are the pre-defined:' + type: string + required: + - Type + type: object + onvif_OSDPosConfigurationExtension: + type: object + onvif_OSDReference: + type: object + onvif_OSDTextConfiguration: + properties: + BackgroundColor: + allOf: + - $ref: '#/components/schemas/onvif_OSDColor' + - description: Background color of the text. + DateFormat: + 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:' + type: string + Extension: + $ref: '#/components/schemas/onvif_OSDTextConfigurationExtension' + FontColor: + allOf: + - $ref: '#/components/schemas/onvif_OSDColor' + - description: Font color of the text. + FontSize: + description: Font size of the text in pt. + format: int32 + type: integer + IsPersistentText: + 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. + type: boolean + PlainText: + description: The content of text to be displayed. + type: string + TimeFormat: + 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:' + type: string + Type: + description: 'The following OSD Text Type are defined:' + type: string + required: + - Type + type: object + onvif_OSDTextConfigurationExtension: + type: object + onvif_OSDTextOptions: + properties: + BackgroundColor: + allOf: + - $ref: '#/components/schemas/onvif_OSDColorOptions' + - description: List of supported background color. + DateFormat: + description: List of supported date format. + items: + type: string + type: array + Extension: + $ref: '#/components/schemas/onvif_OSDTextOptionsExtension' + FontColor: + allOf: + - $ref: '#/components/schemas/onvif_OSDColorOptions' + - description: List of supported font color. + FontSizeRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of the font size value. + TimeFormat: + description: List of supported time format. + items: + type: string + type: array + Type: + 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. + items: + type: string + type: array + required: + - Type + type: object + onvif_OSDTextOptionsExtension: + type: object + onvif_OSDType: + enum: + - Text + - Image + - Extended + type: string + onvif_Object: + allOf: + - $ref: '#/components/schemas/onvif_ObjectId' + - properties: + Appearance: + $ref: '#/components/schemas/onvif_Appearance' + Behaviour: + $ref: '#/components/schemas/onvif_Behaviour' + Extension: + $ref: '#/components/schemas/onvif_ObjectExtension' + Parent: + description: 'Object ID of the parent object. eg: License plate object + has Vehicle object as parent.' + format: int32 + type: integer + type: object + onvif_ObjectExtension: + type: object + onvif_ObjectId: + properties: + ObjectId: + format: int32 + type: integer + type: object + onvif_ObjectTree: + properties: + Delete: + items: + $ref: '#/components/schemas/onvif_ObjectId' + type: array + Extension: + $ref: '#/components/schemas/onvif_ObjectTreeExtension' + Merge: + items: + $ref: '#/components/schemas/onvif_Merge' + type: array + Rename: + items: + $ref: '#/components/schemas/onvif_Rename' + type: array + Split: + items: + $ref: '#/components/schemas/onvif_Split' + type: array + type: object + onvif_ObjectTreeExtension: + type: object + onvif_ObjectType: + enum: + - Animal + - HumanFace + - Human + - Bicycle + - Vehicle + - LicensePlate + - Bike + type: string + onvif_OnvifVersion: + properties: + Major: + description: Major version number. + format: int32 + type: integer + Minor: + 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." + format: int32 + type: integer + required: + - Major + - Minor + type: object + onvif_OtherType: + properties: + Likelihood: + description: A likelihood/probability that the corresponding object belongs + to this class. The sum of the likelihoods shall NOT exceed 1 + type: number + Type: + description: Object Class Type + type: string + required: + - Type + - Likelihood + type: object + onvif_PTControlDirection: + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/onvif_EFlip' + - description: Optional element to configure related parameters for E-Flip. + Extension: + $ref: '#/components/schemas/onvif_PTControlDirectionExtension' + Reverse: + allOf: + - $ref: '#/components/schemas/onvif_Reverse' + - description: Optional element to configure related parameters for reversing + of PT Control Direction. + type: object + onvif_PTControlDirectionExtension: + type: object + onvif_PTControlDirectionOptions: + properties: + EFlip: + allOf: + - $ref: '#/components/schemas/onvif_EFlipOptions' + - description: Supported options for EFlip feature. + Extension: + $ref: '#/components/schemas/onvif_PTControlDirectionOptionsExtension' + Reverse: + allOf: + - $ref: '#/components/schemas/onvif_ReverseOptions' + - description: Supported options for Reverse feature. + type: object + onvif_PTControlDirectionOptionsExtension: + type: object + onvif_PTZCapabilities: + properties: + XAddr: + description: PTZ service URI. + type: string + required: + - XAddr + type: object + onvif_PTZConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + DefaultAbsolutePantTiltPositionSpace: + description: If the PTZ Node supports absolute Pan/Tilt movements, it + shall specify one Absolute Pan/Tilt Position Space as default. + type: string + DefaultAbsoluteZoomPositionSpace: + description: If the PTZ Node supports absolute zoom movements, it shall + specify one Absolute Zoom Position Space as default. + type: string + DefaultContinuousPanTiltVelocitySpace: + description: If the PTZ Node supports continuous Pan/Tilt movements, it + shall specify one Continuous Pan/Tilt Velocity Space as default. + type: string + DefaultContinuousZoomVelocitySpace: + description: If the PTZ Node supports continuous zoom movements, it shall + specify one Continuous Zoom Velocity Space as default. + type: string + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, + it shall specify corresponding default Pan/Tilt and Zoom speeds. + DefaultPTZTimeout: + description: If the PTZ Node supports continuous movements, it shall specify + a default timeout, after which the movement stops. + format: date-time + type: string + DefaultRelativePanTiltTranslationSpace: + description: If the PTZ Node supports relative Pan/Tilt movements, it + shall specify one RelativePan/Tilt Translation Space as default. + type: string + DefaultRelativeZoomTranslationSpace: + description: If the PTZ Node supports relative zoom movements, it shall + specify one Relative Zoom Translation Space as default. + type: string + Extension: + $ref: '#/components/schemas/onvif_PTZConfigurationExtension' + MoveRamp: + description: The optional acceleration ramp used by the device when moving. + format: int32 + type: integer + NodeToken: + description: A mandatory reference to the PTZ Node that the PTZ Configuration + belongs to. + maxLength: 64 + type: string + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/onvif_PanTiltLimits' + - 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. + PresetRamp: + description: The optional acceleration ramp used by the device when recalling + presets. + format: int32 + type: integer + PresetTourRamp: + description: The optional acceleration ramp used by the device when executing + PresetTours. + format: int32 + type: integer + ZoomLimits: + allOf: + - $ref: '#/components/schemas/onvif_ZoomLimits' + - 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. + required: + - NodeToken + type: object + onvif_PTZConfigurationExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZConfigurationExtension2' + PTControlDirection: + allOf: + - $ref: '#/components/schemas/onvif_PTControlDirection' + - description: Optional element to configure PT Control Direction related + features. + type: object + onvif_PTZConfigurationExtension2: + type: object + onvif_PTZConfigurationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZConfigurationOptions2' + PTControlDirection: + allOf: + - $ref: '#/components/schemas/onvif_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + PTZRamps: + 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." + format: int32 + type: integer + PTZTimeout: + allOf: + - $ref: '#/components/schemas/onvif_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the + PTZ Node. + Spaces: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpaces' + - description: A list of supported coordinate systems including their range + limitations. + required: + - Spaces + - PTZTimeout + type: object + onvif_PTZConfigurationOptions2: + type: object + onvif_PTZFilter: + properties: + Position: + description: True if the metadata stream shall contain the PTZ position + type: boolean + Status: + description: True if the metadata stream shall contain the PTZ status (IDLE, + MOVING or UNKNOWN) + type: boolean + required: + - Status + - Position + type: object + onvif_PTZMoveStatus: + properties: + PanTilt: + $ref: '#/components/schemas/onvif_MoveStatus' + Zoom: + $ref: '#/components/schemas/onvif_MoveStatus' + type: object + onvif_PTZNode: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + AuxiliaryCommands: + description: A list of supported Auxiliary commands. If the list is not + empty, the Auxiliary Operations MUST be available for this PTZ Node. + items: + maxLength: 128 + type: string + type: array + Extension: + $ref: '#/components/schemas/onvif_PTZNodeExtension' + FixedHomePosition: + description: Indication whether the HomePosition of a Node is fixed or + it can be changed via the SetHomePosition command. + type: boolean + GeoMove: + description: Indication whether the Node supports the geo-referenced move + command. + type: boolean + HomeSupported: + 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. + type: boolean + MaximumNumberOfPresets: + description: All preset operations MUST be available for this PTZ Node + if one preset is supported. + format: int32 + type: integer + Name: + description: A unique identifier that is used to reference PTZ Nodes. + maxLength: 64 + type: string + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. + For each Coordinate System, the PTZ Node MUST specify its allowed + range. + required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + onvif_PTZNodeExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZNodeExtension2' + SupportedPresetTour: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. + type: object + onvif_PTZNodeExtension2: + type: object + onvif_PTZPositionFilter: + properties: + EnterOrExit: + description: If true, search for when entering the specified PTZ volume. + type: boolean + MaxPosition: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: The upper boundary of the PTZ volume to look for. + MinPosition: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: The lower boundary of the PTZ volume to look for. + required: + - MinPosition + - MaxPosition + - EnterOrExit + type: object + onvif_PTZPreset: + properties: + Name: + description: A list of preset position name. + maxLength: 64 + type: string + PTZPosition: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: A list of preset position. + token: + maxLength: 64 + type: string + type: object + onvif_PTZPresetTourDirection: + enum: + - Forward + - Backward + - Extended + type: string + onvif_PTZPresetTourExtension: + type: object + onvif_PTZPresetTourOperation: + enum: + - Start + - Stop + - Pause + - Extended + type: string + onvif_PTZPresetTourOptions: + properties: + AutoStart: + description: Indicates whether or not the AutoStart is supported. + type: boolean + StartingCondition: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourStartingConditionOptions' + - description: Supported options for Preset Tour Starting Condition. + TourSpot: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourSpotOptions' + - description: Supported options for Preset Tour Spot. + required: + - AutoStart + - StartingCondition + - TourSpot + type: object + onvif_PTZPresetTourPresetDetail: + properties: + Home: + 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. + type: boolean + PTZPosition: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: Option to specify the preset position with vector of PTZ + node directly. + PresetToken: + description: Option to specify the preset position with Preset Token defined + in advance. + maxLength: 64 + type: string + TypeExtension: + $ref: '#/components/schemas/onvif_PTZPresetTourTypeExtension' + type: object + onvif_PTZPresetTourPresetDetailOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourPresetDetailOptionsExtension' + Home: + description: An option to indicate Home postion for tour spots. + type: boolean + PanTiltPositionSpace: + allOf: + - $ref: '#/components/schemas/onvif_Space2DDescription' + - description: Supported range of Pan and Tilt for tour spots. + PresetToken: + description: A list of available Preset Tokens for tour spots. + items: + maxLength: 64 + type: string + type: array + ZoomPositionSpace: + allOf: + - $ref: '#/components/schemas/onvif_Space1DDescription' + - description: Supported range of Zoom for a tour spot. + type: object + onvif_PTZPresetTourPresetDetailOptionsExtension: + type: object + onvif_PTZPresetTourSpot: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourSpotExtension' + PresetDetail: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourPresetDetail' + - description: Detail definition of preset position of the tour spot. + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: Optional parameter to specify Pan/Tilt and Zoom speed on + moving toward this tour spot. + StayTime: + description: Optional parameter to specify time duration of staying on this + tour sport. + format: date-time + type: string + required: + - PresetDetail + type: object + onvif_PTZPresetTourSpotExtension: + type: object + onvif_PTZPresetTourSpotOptions: + properties: + PresetDetail: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourPresetDetailOptions' + - description: Supported options for detail definition of preset position + of the tour spot. + StayTime: + allOf: + - $ref: '#/components/schemas/onvif_DurationRange' + - description: Supported range of stay time for a tour spot. + required: + - PresetDetail + - StayTime + type: object + onvif_PTZPresetTourStartingCondition: + properties: + Direction: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourDirection' + - description: Optional parameter to choose which direction the preset tour + goes. Forward shall be chosen in case it is omitted. + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourStartingConditionExtension' + RandomPresetOrder: + 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. + type: boolean + RecurringDuration: + description: Optional parameter to specify how long time duration the preset + tour is recurred. + format: date-time + type: string + RecurringTime: + description: Optional parameter to specify how many times the preset tour + is recurred. + format: int32 + type: integer + type: object + onvif_PTZPresetTourStartingConditionExtension: + type: object + onvif_PTZPresetTourStartingConditionOptions: + properties: + Direction: + description: Supported options for Direction of Preset Tour. + items: + $ref: '#/components/schemas/onvif_PTZPresetTourDirection' + type: array + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourStartingConditionOptionsExtension' + RecurringDuration: + allOf: + - $ref: '#/components/schemas/onvif_DurationRange' + - description: Supported range of Recurring Duration. + RecurringTime: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of Recurring Time. + type: object + onvif_PTZPresetTourStartingConditionOptionsExtension: + type: object + onvif_PTZPresetTourState: + enum: + - Idle + - Touring + - Paused + - Extended + type: string + onvif_PTZPresetTourStatus: + properties: + CurrentTourSpot: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourSpot' + - description: Indicates a tour spot currently staying. + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourStatusExtension' + State: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourState' + - description: Indicates state of this preset tour by Idle/Touring/Paused. + required: + - State + type: object + onvif_PTZPresetTourStatusExtension: + type: object + onvif_PTZPresetTourSupported: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourSupportedExtension' + MaximumNumberOfPresetTours: + 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. + format: int32 + type: integer + PTZPresetTourOperation: + description: Indicates which preset tour operations are available for this + PTZ Node. + items: + $ref: '#/components/schemas/onvif_PTZPresetTourOperation' + type: array + required: + - MaximumNumberOfPresetTours + type: object + onvif_PTZPresetTourSupportedExtension: + type: object + onvif_PTZPresetTourTypeExtension: + type: object + onvif_PTZSpaces: + properties: + AbsolutePanTiltPositionSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space2DDescription' + type: array + AbsoluteZoomPositionSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + ContinuousPanTiltVelocitySpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space2DDescription' + type: array + ContinuousZoomVelocitySpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + Extension: + $ref: '#/components/schemas/onvif_PTZSpacesExtension' + PanTiltSpeedSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + RelativePanTiltTranslationSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space2DDescription' + type: array + RelativeZoomTranslationSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + ZoomSpeedSpace: + 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\t\ + In contrast to the velocity spaces, speed spaces do not contain any directional\ + \ information." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + type: object + onvif_PTZSpacesExtension: + type: object + onvif_PTZSpeed: + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/onvif_Vector2D' + - 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. + Zoom: + allOf: + - $ref: '#/components/schemas/onvif_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) + Zoom movement should not be affected. + type: object + onvif_PTZStatus: + properties: + Error: + description: States a current PTZ error. + type: string + MoveStatus: + allOf: + - $ref: '#/components/schemas/onvif_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, + idle or in an unknown state. + Position: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - 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. + UtcTime: + description: Specifies the UTC time when this status was generated. + format: date-time + type: string + required: + - UtcTime + type: object + onvif_PTZStatusFilterOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_PTZStatusFilterOptionsExtension' + PanTiltPositionSupported: + description: True if the device is able to stream the pan or tilt position. + type: boolean + PanTiltStatusSupported: + description: True if the device is able to stream pan or tilt status information. + type: boolean + ZoomPositionSupported: + description: True if the device is able to stream zoom position information. + type: boolean + ZoomStatusSupported: + description: True if the device is able to stream zoom status inforamtion. + type: boolean + required: + - PanTiltStatusSupported + - ZoomStatusSupported + type: object + onvif_PTZStatusFilterOptionsExtension: + type: object + onvif_PTZStream: + properties: + Extension: + items: + $ref: '#/components/schemas/onvif_PTZStreamExtension' + type: array + PTZStatus: + items: + $ref: '#/components/schemas/onvif_PTZStatus' + type: array + type: object + onvif_PTZStreamChoice0: + properties: + PTZStatus: + items: + $ref: '#/components/schemas/onvif_PTZStatus' + type: array + type: object + onvif_PTZStreamChoice1: + properties: + Extension: + items: + $ref: '#/components/schemas/onvif_PTZStreamExtension' + type: array + type: object + onvif_PTZStreamChoice2: + type: object + onvif_PTZStreamExtension: + type: object + onvif_PTZVector: + properties: + PanTilt: + allOf: + - $ref: '#/components/schemas/onvif_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan + and the y component to tilt. + Zoom: + allOf: + - $ref: '#/components/schemas/onvif_Vector1D' + - description: A zoom position. + type: object + onvif_PanTiltLimits: + properties: + Range: + allOf: + - $ref: '#/components/schemas/onvif_Space2DDescription' + - description: A range of pan tilt limits. + required: + - Range + type: object + onvif_PaneConfiguration: + description: Configuration of the streaming and coding settings of a Video window. + properties: + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + - description: "The configuration of the audio encoder including codec,\ + \ bitrate\nand sample rate." + AudioOutputToken: + 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." + maxLength: 64 + type: string + AudioSourceToken: + 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." + maxLength: 64 + type: string + PaneName: + description: Optional name of the pane configuration. + type: string + ReceiverToken: + 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." + maxLength: 64 + type: string + Token: + description: A unique identifier in the display device. + maxLength: 64 + type: string + required: + - Token + type: object + onvif_PaneLayout: + description: A pane layout describes one Video window of a display. It links + a pane configuration to a region of the screen. + properties: + Area: + allOf: + - $ref: '#/components/schemas/onvif_Rectangle' + - description: Describes the location and size of the area on the monitor. + The area coordinate values are espressed in normalized units [-1.0, + 1.0]. + Pane: + description: Reference to the configuration of the streaming and coding + parameters. + maxLength: 64 + type: string + required: + - Pane + - Area + type: object + onvif_PaneLayoutOptions: + description: Description of a pane layout describing a complete display layout. + properties: + Area: + description: List of areas assembling a layout. Coordinate values are in + the range [-1.0, 1.0]. + items: + $ref: '#/components/schemas/onvif_Rectangle' + type: array + Extension: + $ref: '#/components/schemas/onvif_PaneOptionExtension' + required: + - Area + type: object + onvif_PaneOptionExtension: + type: object + onvif_PlateType: + enum: + - Normal + - Police + - Diplomat + - Temporary + type: string + onvif_Polygon: + properties: + Point: + items: + $ref: '#/components/schemas/onvif_Vector' + type: array + required: + - Point + type: object + onvif_PolygonOptions: + properties: + RectangleOnly: + description: "True if the device supports defining a region only using Rectangle.\n\ + The rectangle points are still passed using a Polygon element if the device\ + \ does not support polygon regions. In this case, the points provided\ + \ in the Polygon element shall represent a rectangle." + type: boolean + VertexLimits: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: "Provides the minimum and maximum number of points that can\ + \ be defined in the Polygon.\nIf RectangleOnly is not set to true, this\ + \ parameter is required." + type: object + onvif_Polyline: + properties: + Point: + items: + $ref: '#/components/schemas/onvif_Vector' + type: array + required: + - Point + type: object + onvif_PolylineArray: + properties: + Extension: + $ref: '#/components/schemas/onvif_PolylineArrayExtension' + Segment: + description: Contains array of Polyline + items: + $ref: '#/components/schemas/onvif_Polyline' + type: array + required: + - Segment + type: object + onvif_PolylineArrayConfiguration: + properties: + PolylineArray: + allOf: + - $ref: '#/components/schemas/onvif_PolylineArray' + - description: Contains PolylineArray configuration data + required: + - PolylineArray + type: object + onvif_PolylineArrayExtension: + type: object + onvif_PrefixedIPv4Address: + properties: + Address: + description: IPv4 address + type: string + PrefixLength: + description: Prefix/submask length + format: int32 + type: integer + required: + - Address + - PrefixLength + type: object + onvif_PrefixedIPv6Address: + properties: + Address: + description: IPv6 address + type: string + PrefixLength: + description: Prefix/submask length + format: int32 + type: integer + required: + - Address + - PrefixLength + type: object + onvif_PresetTour: + properties: + AutoStart: + description: Auto Start flag of the preset tour. True allows the preset + tour to be activated always. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourExtension' + Name: + description: Readable name of the preset tour. + maxLength: 64 + type: string + StartingCondition: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourStartingCondition' + - description: Parameters to specify the detail behavior of the preset tour. + Status: + allOf: + - $ref: '#/components/schemas/onvif_PTZPresetTourStatus' + - description: Read only parameters to indicate the status of the preset + tour. + TourSpot: + description: A list of detail of touring spots including preset positions. + items: + $ref: '#/components/schemas/onvif_PTZPresetTourSpot' + type: array + token: + description: Unique identifier of this preset tour. + maxLength: 64 + type: string + required: + - Status + - AutoStart + - StartingCondition + type: object + onvif_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." + properties: + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + Extension: + allOf: + - $ref: '#/components/schemas/onvif_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + Name: + description: User readable name of the profile. + maxLength: 64 + type: string + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and + rule engine. + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + fixed: + description: A value of true signals that the profile cannot be deleted. + Default is false. + type: boolean + token: + description: Unique identifier of the profile. + maxLength: 64 + type: string + required: + - token + - Name + type: object + onvif_ProfileCapabilities: + properties: + MaximumNumberOfProfiles: + description: Maximum number of profiles. + format: int32 + type: integer + required: + - MaximumNumberOfProfiles + type: object + onvif_ProfileExtension: + properties: + AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + Extension: + $ref: '#/components/schemas/onvif_ProfileExtension2' + type: object + onvif_ProfileExtension2: + type: object + onvif_ProfileStatus: + properties: + ActiveConnections: + items: + $ref: '#/components/schemas/onvif_ActiveConnection' + type: array + Extension: + $ref: '#/components/schemas/onvif_ProfileStatusExtension' + type: object + onvif_ProfileStatusExtension: + type: object + onvif_PropertyOperation: + enum: + - Initialized + - Deleted + - Changed + type: string + onvif_RealTimeStreamingCapabilities: + properties: + Extension: + $ref: '#/components/schemas/onvif_RealTimeStreamingCapabilitiesExtension' + RTPMulticast: + description: Indicates whether or not RTP multicast is supported. + type: boolean + RTP_RTSP_TCP: + description: Indicates whether or not RTP/RTSP/TCP is supported. + type: boolean + RTP_TCP: + description: Indicates whether or not RTP over TCP is supported. + type: boolean + type: object + onvif_RealTimeStreamingCapabilitiesExtension: + type: object + onvif_Receiver: + description: Description of a receiver, including its token and configuration. + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_ReceiverConfiguration' + - description: Describes the configuration of the receiver. + Token: + description: Unique identifier of the receiver. + maxLength: 64 + type: string + required: + - Token + - Configuration + type: object + onvif_ReceiverCapabilities: + properties: + MaximumRTSPURILength: + description: The maximum allowed length for RTSP URIs. + format: int32 + type: integer + RTP_Multicast: + description: Indicates whether the device can receive RTP multicast streams. + type: boolean + RTP_RTSP_TCP: + description: Indicates whether the device can receive RTP/RTSP/TCP streams. + type: boolean + RTP_TCP: + description: Indicates whether the device can receive RTP/TCP streams + type: boolean + SupportedReceivers: + description: The maximum number of receivers supported by the device. + format: int32 + type: integer + XAddr: + description: The address of the receiver service. + type: string + required: + - XAddr + - RTP_Multicast + - RTP_TCP + - RTP_RTSP_TCP + - SupportedReceivers + - MaximumRTSPURILength + type: object + onvif_ReceiverConfiguration: + description: Describes the configuration of a receiver. + properties: + MediaUri: + description: Details of the URI to which the receiver should connect. + type: string + Mode: + allOf: + - $ref: '#/components/schemas/onvif_ReceiverMode' + - description: 'The following connection modes are defined:' + StreamSetup: + allOf: + - $ref: '#/components/schemas/onvif_StreamSetup' + - description: Stream connection parameters. + required: + - Mode + - MediaUri + - StreamSetup + type: object + onvif_ReceiverMode: + description: Specifies a receiver connection mode. + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + onvif_ReceiverState: + description: Specifies the current connection state of the receiver. + enum: + - NotConnected + - Connecting + - Connected + - Unknown + type: string + onvif_ReceiverStateInformation: + description: Contains information about a receiver's current state. + properties: + AutoCreated: + description: Indicates whether or not the receiver was created automatically. + type: boolean + State: + allOf: + - $ref: '#/components/schemas/onvif_ReceiverState' + - description: 'The connection state of the receiver may have one of the + following states:' + required: + - State + - AutoCreated + type: object + onvif_RecordingCapabilities: + properties: + DynamicRecordings: + type: boolean + DynamicTracks: + type: boolean + MaxStringLength: + format: int32 + type: integer + MediaProfileSource: + type: boolean + ReceiverSource: + type: boolean + XAddr: + type: string + required: + - XAddr + - ReceiverSource + - MediaProfileSource + - DynamicRecordings + - DynamicTracks + - MaxStringLength + type: object + onvif_RecordingConfiguration: + properties: + Content: + description: Informative description of the source. + type: string + MaximumRetentionTime: + description: "Sspecifies 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." + format: date-time + type: string + Source: + allOf: + - $ref: '#/components/schemas/onvif_RecordingSourceInformation' + - description: Information about the source of the recording. + required: + - Source + - Content + - MaximumRetentionTime + type: object + onvif_RecordingInformation: + properties: + Content: + type: string + EarliestRecording: + format: date-time + type: string + LatestRecording: + format: date-time + type: string + RecordingStatus: + $ref: '#/components/schemas/onvif_RecordingStatus' + RecordingToken: + maxLength: 64 + type: string + Source: + allOf: + - $ref: '#/components/schemas/onvif_RecordingSourceInformation' + - 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." + Track: + description: Basic information about the track. Note that a track may represent + a single contiguous time span or consist of multiple slices. + items: + $ref: '#/components/schemas/onvif_TrackInformation' + type: array + required: + - RecordingToken + - Source + - Content + - RecordingStatus + type: object + onvif_RecordingJobConfiguration: + properties: + Extension: + $ref: '#/components/schemas/onvif_RecordingJobConfigurationExtension' + Mode: + 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." + type: string + Priority: + 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." + format: int32 + type: integer + RecordingToken: + description: Identifies the recording to which this job shall store the + received data. + maxLength: 64 + type: string + Source: + description: Source of the recording. + items: + $ref: '#/components/schemas/onvif_RecordingJobSource' + type: array + required: + - RecordingToken + - Mode + - Priority + type: object + onvif_RecordingJobConfigurationExtension: + type: object + onvif_RecordingJobSource: + properties: + AutoCreateReceiver: + 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." + type: boolean + Extension: + $ref: '#/components/schemas/onvif_RecordingJobSourceExtension' + SourceToken: + allOf: + - $ref: '#/components/schemas/onvif_SourceReference' + - 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, instructing the\n\t\t\t\tdevice\ + \ to obtain data from a profile that exists on the local device." + Tracks: + description: List of tracks associated with the recording. + items: + $ref: '#/components/schemas/onvif_RecordingJobTrack' + type: array + type: object + onvif_RecordingJobSourceExtension: + type: object + onvif_RecordingJobStateInformation: + properties: + Extension: + $ref: '#/components/schemas/onvif_RecordingJobStateInformationExtension' + RecordingToken: + description: Identification of the recording that the recording job records + to. + maxLength: 64 + type: string + Sources: + description: Identifies the data source of the recording job. + items: + $ref: '#/components/schemas/onvif_RecordingJobStateSource' + type: array + State: + description: Holds the aggregated state over the whole RecordingJobInformation + structure. + type: string + required: + - RecordingToken + - State + type: object + onvif_RecordingJobStateInformationExtension: + type: object + onvif_RecordingJobStateSource: + properties: + SourceToken: + allOf: + - $ref: '#/components/schemas/onvif_SourceReference' + - description: Identifies the data source of the recording job. + State: + description: Holds the aggregated state over all substructures of RecordingJobStateSource. + type: string + Tracks: + allOf: + - $ref: '#/components/schemas/onvif_RecordingJobStateTracks' + - description: List of track items. + required: + - SourceToken + - State + - Tracks + type: object + onvif_RecordingJobStateTrack: + properties: + Destination: + description: Indicates the destination track. + maxLength: 64 + type: string + Error: + description: "Optionally holds an implementation defined string value that\ + \ describes the error.\n\t\t\t\tThe string should be in the English language." + type: string + SourceTag: + description: Identifies the track of the data source that provides the data. + type: string + State: + 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." + type: string + required: + - SourceTag + - Destination + - State + type: object + onvif_RecordingJobStateTracks: + properties: + Track: + items: + $ref: '#/components/schemas/onvif_RecordingJobStateTrack' + type: array + type: object + onvif_RecordingJobTrack: + properties: + Destination: + description: "The destination is the tracktoken of the track to which the\ + \ device shall store the\n\t\t\t\treceived data." + maxLength: 64 + type: string + SourceTag: + 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." + type: string + required: + - SourceTag + - Destination + type: object + onvif_RecordingSourceInformation: + description: A set of informative desciptions of a data source. The Search searvice + allows a client to filter on recordings based on information in this structure. + properties: + Address: + description: URI provided by the service supplying data to be recorded. + A device shall support at least 128 characters. + type: string + Description: + description: Informative description of the source. + type: string + Location: + description: Informative description of the physical location of the source, + e.g. the coordinates on a map. + type: string + Name: + description: Informative user readable name of the source, e.g. "Camera23". + A device shall support at least 20 characters. + maxLength: 64 + type: string + SourceId: + 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." + type: string + required: + - SourceId + - Name + - Location + - Description + - Address + type: object + onvif_RecordingStatus: + enum: + - Initiated + - Recording + - Stopped + - Removing + - Removed + - Unknown + type: string + onvif_RecordingSummary: + properties: + DataFrom: + description: The earliest point in time where there is recorded data on + the device. + format: date-time + type: string + DataUntil: + description: The most recent point in time where there is recorded data + on the device. + format: date-time + type: string + NumberRecordings: + description: The device contains this many recordings. + format: int32 + type: integer + required: + - DataFrom + - DataUntil + - NumberRecordings + type: object + onvif_Rectangle: + properties: + bottom: + type: number + left: + type: number + right: + type: number + top: + type: number + type: object + onvif_RelativeFocus: + properties: + Distance: + description: Distance parameter for the relative focus control. + type: number + Speed: + description: Speed parameter for the relative focus control. + type: number + required: + - Distance + type: object + onvif_RelativeFocusOptions: + properties: + Distance: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the distance. + Speed: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the speed. + required: + - Distance + - Speed + type: object + onvif_RelativeFocusOptions20: + properties: + Distance: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the distance. + Speed: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Valid ranges of the speed. + required: + - Distance + type: object + onvif_RelayIdleState: + enum: + - closed + - open + type: string + onvif_RelayLogicalState: + enum: + - active + - inactive + type: string + onvif_RelayMode: + enum: + - Monostable + - Bistable + type: string + onvif_RelayOutput: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Properties: + $ref: '#/components/schemas/onvif_RelayOutputSettings' + required: + - Properties + type: object + onvif_RelayOutputSettings: + properties: + DelayTime: + 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. + format: date-time + type: string + IdleState: + allOf: + - $ref: '#/components/schemas/onvif_RelayIdleState' + - description: "'open' or 'closed'" + Mode: + allOf: + - $ref: '#/components/schemas/onvif_RelayMode' + - description: "'Bistable' or 'Monostable'" + required: + - Mode + - DelayTime + - IdleState + type: object + onvif_RemoteUser: + properties: + Password: + type: string + UseDerivedPassword: + type: boolean + Username: + type: string + required: + - Username + - UseDerivedPassword + type: object + onvif_Removed: + type: object + onvif_Rename: + properties: + from: + $ref: '#/components/schemas/onvif_ObjectId' + to: + $ref: '#/components/schemas/onvif_ObjectId' + required: + - from + - to + type: object + onvif_ReplayCapabilities: + properties: + XAddr: + description: The address of the replay service. + type: string + required: + - XAddr + type: object + onvif_ReplayConfiguration: + description: Configuration parameters for the replay service. + properties: + SessionTimeout: + description: The RTSP session timeout. + format: date-time + type: string + required: + - SessionTimeout + type: object + onvif_Reverse: + properties: + Mode: + allOf: + - $ref: '#/components/schemas/onvif_ReverseMode' + - description: Parameter to enable/disable Reverse feature. + required: + - Mode + type: object + onvif_ReverseMode: + enum: + - false + - true + - AUTO + - Extended + type: string + onvif_ReverseOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_ReverseOptionsExtension' + Mode: + description: Options of Reverse mode parameter. + items: + $ref: '#/components/schemas/onvif_ReverseMode' + type: array + type: object + onvif_ReverseOptionsExtension: + type: object + onvif_Rotate: + properties: + Degree: + 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. + format: int32 + type: integer + Extension: + $ref: '#/components/schemas/onvif_RotateExtension' + Mode: + allOf: + - $ref: '#/components/schemas/onvif_RotateMode' + - description: Parameter to enable/disable Rotation feature. + required: + - Mode + type: object + onvif_RotateExtension: + type: object + onvif_RotateMode: + enum: + - false + - true + - AUTO + type: string + onvif_RotateOptions: + properties: + DegreeList: + allOf: + - $ref: '#/components/schemas/onvif_IntItems' + - description: List of supported degree value for rotation. + Extension: + $ref: '#/components/schemas/onvif_RotateOptionsExtension' + Mode: + description: Supported options of Rotate mode parameter. + items: + $ref: '#/components/schemas/onvif_RotateMode' + type: array + Reboot: + description: "After setting the rotation, if a device starts to reboot this\ + \ value is true.\n\t\t\t\tIf a device can handle rotation setting without\ + \ rebooting this value is false." + type: boolean + required: + - Mode + type: object + onvif_RotateOptionsExtension: + type: object + onvif_RuleEngineConfiguration: + properties: + Extension: + $ref: '#/components/schemas/onvif_RuleEngineConfigurationExtension' + Rule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + type: object + onvif_RuleEngineConfigurationExtension: + type: object + onvif_SceneOrientation: + properties: + Mode: + allOf: + - $ref: '#/components/schemas/onvif_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene + orientation. + Orientation: + 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." + type: string + required: + - Mode + type: object + onvif_SceneOrientationMode: + enum: + - MANUAL + - AUTO + type: string + onvif_SceneOrientationOption: + description: Defines the acceptable values for the Orientation element of the + SceneOrientation type + enum: + - Below + - Horizon + - Above + type: string + onvif_Scope: + properties: + ScopeDef: + allOf: + - $ref: '#/components/schemas/onvif_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + ScopeItem: + description: Scope item URI. + type: string + required: + - ScopeDef + - ScopeItem + type: object + onvif_ScopeDefinition: + enum: + - Fixed + - Configurable + type: string + onvif_SearchCapabilities: + properties: + MetadataSearch: + type: boolean + XAddr: + type: string + required: + - XAddr + - MetadataSearch + type: object + onvif_SearchScope: + description: A structure for defining a limited scope when searching in recorded + data. + properties: + Extension: + allOf: + - $ref: '#/components/schemas/onvif_SearchScopeExtension' + - description: Extension point + IncludedRecordings: + 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. + items: + maxLength: 64 + type: string + type: array + IncludedSources: + 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. + items: + $ref: '#/components/schemas/onvif_SourceReference' + type: array + RecordingInformationFilter: + 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. + type: string + type: object + onvif_SearchScopeExtension: + type: object + onvif_SearchState: + enum: + - Queued + - Searching + - Completed + - Unknown + type: string + onvif_SecurityCapabilities: + properties: + AccessPolicyConfig: + description: Indicates whether or not access policy configuration is supported. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_SecurityCapabilitiesExtension' + KerberosToken: + description: Indicates whether or not WS-Security Kerberos token is supported. + type: boolean + OnboardKeyGeneration: + description: Indicates whether or not onboard key generation is supported. + type: boolean + RELToken: + description: Indicates whether or not WS-Security REL token is supported. + type: boolean + SAMLToken: + description: Indicates whether or not WS-Security SAML token is supported. + type: boolean + TLS1.1: + description: Indicates whether or not TLS 1.1 is supported. + type: boolean + TLS1.2: + description: Indicates whether or not TLS 1.2 is supported. + type: boolean + X.509Token: + description: Indicates whether or not WS-Security X.509 token is supported. + type: boolean + required: + - TLS1.1 + - TLS1.2 + - OnboardKeyGeneration + - AccessPolicyConfig + - X.509Token + - SAMLToken + - KerberosToken + - RELToken + type: object + onvif_SecurityCapabilitiesExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_SecurityCapabilitiesExtension2' + TLS1.0: + type: boolean + required: + - TLS1.0 + type: object + onvif_SecurityCapabilitiesExtension2: + properties: + Dot1X: + type: boolean + RemoteUserHandling: + type: boolean + SupportedEAPMethod: + description: EAP Methods supported by the device. The int values refer to + the + items: + format: int32 + type: integer + type: array + required: + - Dot1X + - RemoteUserHandling + type: object + onvif_SetDateTimeType: + enum: + - Manual + - NTP + type: string + onvif_ShapeDescriptor: + properties: + BoundingBox: + $ref: '#/components/schemas/onvif_Rectangle' + CenterOfGravity: + $ref: '#/components/schemas/onvif_Vector' + Extension: + $ref: '#/components/schemas/onvif_ShapeDescriptorExtension' + Polygon: + items: + $ref: '#/components/schemas/onvif_Polygon' + type: array + required: + - BoundingBox + - CenterOfGravity + type: object + onvif_ShapeDescriptorExtension: + type: object + onvif_SimpleItem: + description: Value name pair as defined by the corresponding description. + properties: + Name: + description: Item name. + type: string + Value: + description: Item value. The type is defined in the corresponding description. + type: string + required: + - Name + - Value + type: object + onvif_SimpleItemDescription: + description: Description of a simple item. The type must be of cathegory simpleType + (xs:string, xs:integer, xs:float, ...). + properties: + Name: + description: Item name. Must be unique within a list. + type: string + Type: + type: string + required: + - Name + - Type + type: object + onvif_SourceIdentification: + properties: + Extension: + $ref: '#/components/schemas/onvif_SourceIdentificationExtension' + Name: + type: string + Token: + items: + maxLength: 64 + type: string + type: array + required: + - Name + - Token + type: object + onvif_SourceIdentificationExtension: + type: object + onvif_SourceReference: + properties: + Token: + maxLength: 64 + type: string + Type: + default: http://www.onvif.org/ver10/schema/Receiver + type: string + required: + - Token + type: object + onvif_Space1DDescription: + properties: + URI: + description: A URI of coordinate systems. + type: string + XRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: A range of x-axis. + required: + - URI + - XRange + type: object + onvif_Space2DDescription: + properties: + URI: + description: A URI of coordinate systems. + type: string + XRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: A range of x-axis. + YRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: A range of y-axis. + required: + - URI + - XRange + - YRange + type: object + onvif_Split: + properties: + from: + $ref: '#/components/schemas/onvif_ObjectId' + to: + items: + $ref: '#/components/schemas/onvif_ObjectId' + type: array + required: + - from + - to + type: object + onvif_StorageReferencePath: + properties: + Extension: + $ref: '#/components/schemas/onvif_StorageReferencePathExtension' + RelativePath: + description: gives the relative directory path on the storage + type: string + StorageToken: + description: identifier of an existing Storage Configuration. + maxLength: 64 + type: string + required: + - StorageToken + type: object + onvif_StorageReferencePathExtension: + type: object + onvif_StreamSetup: + properties: + Stream: + allOf: + - $ref: '#/components/schemas/onvif_StreamType' + - description: Defines if a multicast or unicast stream is requested + Transport: + $ref: '#/components/schemas/onvif_Transport' + required: + - Stream + - Transport + type: object + onvif_StreamType: + enum: + - RTP-Unicast + - RTP-Multicast + type: string + onvif_StringItems: + properties: + Item: + items: + type: string + type: array + required: + - Item + type: object + onvif_StringLikelihood: + properties: + Likelihood: + type: number + type: object + onvif_SubscriptionPolicy: + type: object + onvif_SupportInformation: + properties: + Binary: + allOf: + - $ref: '#/components/schemas/onvif_AttachmentData' + - description: The support information as attachment data. + String: + description: The support information as character data. + type: string + type: object + onvif_SupportedAnalyticsModules: + properties: + AnalyticsModuleContentSchemaLocation: + 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." + items: + type: string + type: array + AnalyticsModuleDescription: + items: + $ref: '#/components/schemas/onvif_ConfigDescription' + type: array + Extension: + $ref: '#/components/schemas/onvif_SupportedAnalyticsModulesExtension' + Limit: + description: Maximum number of concurrent instances. + format: int32 + type: integer + type: object + onvif_SupportedAnalyticsModulesExtension: + type: object + onvif_SupportedRules: + properties: + Extension: + $ref: '#/components/schemas/onvif_SupportedRulesExtension' + Limit: + description: Maximum number of concurrent instances. + format: int32 + type: integer + RuleContentSchemaLocation: + description: Lists the location of all schemas that are referenced in the + rules. + items: + type: string + type: array + RuleDescription: + description: List of rules supported by the Video Analytics configuration.. + items: + $ref: '#/components/schemas/onvif_ConfigDescription' + type: array + type: object + onvif_SupportedRulesExtension: + type: object + onvif_SystemCapabilities: + properties: + DiscoveryBye: + description: Indicates whether or not WS-Discovery Bye is supported. + type: boolean + DiscoveryResolve: + description: Indicates whether or not WS Discovery resolve requests are + supported. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_SystemCapabilitiesExtension' + FirmwareUpgrade: + description: Indicates whether or not firmware upgrade is supported. + type: boolean + RemoteDiscovery: + description: Indicates whether or not remote discovery is supported. + type: boolean + SupportedVersions: + description: Indicates supported ONVIF version(s). + items: + $ref: '#/components/schemas/onvif_OnvifVersion' + type: array + SystemBackup: + description: Indicates whether or not system backup is supported. + type: boolean + SystemLogging: + description: Indicates whether or not system logging is supported. + type: boolean + required: + - DiscoveryResolve + - DiscoveryBye + - RemoteDiscovery + - SystemBackup + - SystemLogging + - FirmwareUpgrade + - SupportedVersions + type: object + onvif_SystemCapabilitiesExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_SystemCapabilitiesExtension2' + HttpFirmwareUpgrade: + type: boolean + HttpSupportInformation: + type: boolean + HttpSystemBackup: + type: boolean + HttpSystemLogging: + type: boolean + type: object + onvif_SystemCapabilitiesExtension2: + type: object + onvif_SystemDateTime: + description: General date time inforamtion returned by the GetSystemDateTime + method. + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/onvif_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + DaylightSavings: + description: Informative indicator whether daylight savings is currently + on/off. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_SystemDateTimeExtension' + LocalDateTime: + allOf: + - $ref: '#/components/schemas/onvif_DateTime' + - description: Date and time in local format. + TimeZone: + allOf: + - $ref: '#/components/schemas/onvif_TimeZone' + - description: Timezone information in Posix format. + UTCDateTime: + allOf: + - $ref: '#/components/schemas/onvif_DateTime' + - description: Current system date and time in UTC format. This field is + mandatory since version 2.0. + required: + - DateTimeType + - DaylightSavings + type: object + onvif_SystemDateTimeExtension: + type: object + onvif_SystemLog: + properties: + Binary: + allOf: + - $ref: '#/components/schemas/onvif_AttachmentData' + - description: The log information as attachment data. + String: + description: The log information as character data. + type: string + type: object + onvif_SystemLogType: + description: Enumeration describing the available system log modes. + enum: + - System + - Access + type: string + onvif_SystemLogUri: + properties: + Type: + $ref: '#/components/schemas/onvif_SystemLogType' + Uri: + type: string + required: + - Type + - Uri + type: object + onvif_SystemLogUriList: + properties: + SystemLog: + items: + $ref: '#/components/schemas/onvif_SystemLogUri' + type: array + type: object + onvif_TLSConfiguration: + properties: + CertificateID: + type: string + required: + - CertificateID + type: object + onvif_Time: + properties: + Hour: + description: Range is 0 to 23. + format: int32 + type: integer + Minute: + description: Range is 0 to 59. + format: int32 + type: integer + Second: + description: Range is 0 to 61 (typically 59). + format: int32 + type: integer + required: + - Hour + - Minute + - Second + type: object + onvif_TimeZone: + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 + section 8.3 + properties: + TZ: + description: Posix timezone string. + type: string + required: + - TZ + type: object + onvif_ToneCompensation: + properties: + Extension: + $ref: '#/components/schemas/onvif_ToneCompensationExtension' + Level: + description: Optional level parameter specified with unitless normalized + value from 0.0 to +1.0. + type: number + Mode: + description: Parameter to enable/disable or automatic ToneCompensation feature. + Its options shall be chosen from tt:ToneCompensationMode Type. + type: string + required: + - Mode + type: object + onvif_ToneCompensationExtension: + type: object + onvif_ToneCompensationMode: + enum: + - false + - true + - AUTO + type: string + onvif_ToneCompensationOptions: + properties: + Level: + description: Indicates whether or not support Level parameter for Tone Compensation. + type: boolean + Mode: + description: Supported options for Tone Compensation mode. Its options shall + be chosen from tt:ToneCompensationMode Type. + items: + type: string + type: array + required: + - Mode + - Level + type: object + onvif_TrackAttributes: + properties: + AudioAttributes: + allOf: + - $ref: '#/components/schemas/onvif_AudioAttributes' + - description: If the track is an audio track, exactly one of this structure + shall be present and contain the audio attributes. + Extension: + $ref: '#/components/schemas/onvif_TrackAttributesExtension' + MetadataAttributes: + allOf: + - $ref: '#/components/schemas/onvif_MetadataAttributes' + - description: If the track is an metadata track, exactly one of this structure + shall be present and contain the metadata attributes. + TrackInformation: + allOf: + - $ref: '#/components/schemas/onvif_TrackInformation' + - description: The basic information about the track. Note that a track + may represent a single contiguous time span or consist of multiple slices. + VideoAttributes: + allOf: + - $ref: '#/components/schemas/onvif_VideoAttributes' + - description: If the track is a video track, exactly one of this structure + shall be present and contain the video attributes. + required: + - TrackInformation + type: object + onvif_TrackAttributesExtension: + type: object + onvif_TrackConfiguration: + properties: + Description: + description: Informative description of the track. + type: string + TrackType: + allOf: + - $ref: '#/components/schemas/onvif_TrackType' + - 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." + required: + - TrackType + - Description + type: object + onvif_TrackInformation: + properties: + DataFrom: + description: The start date and time of the oldest recorded data in the + track. + format: date-time + type: string + DataTo: + description: The stop date and time of the newest recorded data in the track. + format: date-time + type: string + Description: + description: Informative description of the contents of the track. + type: string + TrackToken: + maxLength: 64 + type: string + TrackType: + allOf: + - $ref: '#/components/schemas/onvif_TrackType' + - 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." + required: + - TrackToken + - TrackType + - Description + - DataFrom + - DataTo + type: object + onvif_TrackType: + enum: + - Video + - Audio + - Metadata + - Extended + type: string + onvif_Transformation: + properties: + Extension: + $ref: '#/components/schemas/onvif_TransformationExtension' + Scale: + $ref: '#/components/schemas/onvif_Vector' + Translate: + $ref: '#/components/schemas/onvif_Vector' + type: object + onvif_TransformationExtension: + type: object + onvif_Transport: + properties: + Protocol: + allOf: + - $ref: '#/components/schemas/onvif_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, + RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + Tunnel: + allOf: + - $ref: '#/components/schemas/onvif_Transport' + - description: Optional element to describe further tunnel options. This + element is normally not needed + required: + - Protocol + type: object + onvif_TransportProtocol: + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + onvif_User: + properties: + Extension: + $ref: '#/components/schemas/onvif_UserExtension' + Password: + description: Password string. + type: string + UserLevel: + allOf: + - $ref: '#/components/schemas/onvif_UserLevel' + - description: User level string. + Username: + description: Username string. + type: string + required: + - Username + - UserLevel + type: object + onvif_UserExtension: + type: object + onvif_UserLevel: + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + onvif_Vector: + properties: + x: + type: number + y: + type: number + type: object + onvif_Vector1D: + properties: + space: + description: 'Zoom coordinate space selector. The following options are + defined:' + type: string + x: + type: number + required: + - x + type: object + onvif_Vector2D: + properties: + space: + description: 'Pan/tilt coordinate space selector. The following options + are defined:' + type: string + x: + type: number + y: + type: number + required: + - x + - y + type: object + onvif_VehicleInfo: + properties: + Brand: + $ref: '#/components/schemas/onvif_StringLikelihood' + Model: + $ref: '#/components/schemas/onvif_StringLikelihood' + Type: + $ref: '#/components/schemas/onvif_StringLikelihood' + required: + - Type + type: object + onvif_VehicleType: + enum: + - Bus + - Car + - Truck + - Bicycle + - Motorcycle + type: string + onvif_VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + AnalyticsEngineConfiguration: + $ref: '#/components/schemas/onvif_AnalyticsEngineConfiguration' + RuleEngineConfiguration: + $ref: '#/components/schemas/onvif_RuleEngineConfiguration' + required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + onvif_VideoAnalyticsStream: + properties: + Extension: + items: + $ref: '#/components/schemas/onvif_VideoAnalyticsStreamExtension' + type: array + Frame: + items: + $ref: '#/components/schemas/onvif_Frame' + type: array + type: object + onvif_VideoAnalyticsStreamChoice0: + properties: + Frame: + items: + $ref: '#/components/schemas/onvif_Frame' + type: array + type: object + onvif_VideoAnalyticsStreamChoice1: + properties: + Extension: + items: + $ref: '#/components/schemas/onvif_VideoAnalyticsStreamExtension' + type: array + type: object + onvif_VideoAnalyticsStreamChoice2: + type: object + onvif_VideoAnalyticsStreamExtension: + type: object + onvif_VideoAttributes: + properties: + Bitrate: + description: Average bitrate in kbps. + format: int32 + type: integer + Encoding: + description: Video encoding of the track. Use value from tt:VideoEncoding + for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and + type: string + Framerate: + description: Average framerate in frames per second. + type: number + Height: + description: The height of the video in pixels. + format: int32 + type: integer + Width: + description: The width of the video in pixels. + format: int32 + type: integer + required: + - Width + - Height + - Encoding + - Framerate + type: object + onvif_VideoDecoderConfigurationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_VideoDecoderConfigurationOptionsExtension' + H264DecOptions: + allOf: + - $ref: '#/components/schemas/onvif_H264DecOptions' + - description: If the device is able to decode H.264 streams this element + describes the supported codecs and configurations + JpegDecOptions: + allOf: + - $ref: '#/components/schemas/onvif_JpegDecOptions' + - description: If the device is able to decode Jpeg streams this element + describes the supported codecs and configurations + Mpeg4DecOptions: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4DecOptions' + - description: If the device is able to decode Mpeg4 streams this element + describes the supported codecs and configurations + type: object + onvif_VideoDecoderConfigurationOptionsExtension: + type: object + onvif_VideoEncoder2Configuration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Encoding: + description: Video Media Subtype for the video format. For definitions + see tt:VideoEncodingMimeNames and + type: string + GovLength: + 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. + format: int32 + type: integer + GuaranteedFrameRate: + 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." + type: boolean + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + Profile: + description: The encoder profile as defined in tt:VideoEncodingProfiles. + type: string + Quality: + description: Relative value for the video quantizers and the quality of + the video. A high value within supported quality range means higher + quality + type: number + RateControl: + allOf: + - $ref: '#/components/schemas/onvif_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + Resolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution2' + - description: Configured video resolution + required: + - Encoding + - Resolution + - Quality + type: object + onvif_VideoEncoder2ConfigurationOptions: + properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. + ConstantBitRateSupported: + description: Signal whether enforcing constant bitrate is supported. + type: boolean + Encoding: + description: Video Media Subtype for the video format. For definitions see + tt:VideoEncodingMimeNames and + type: string + FrameRatesSupported: + description: List of supported target frame rates in fps (frames per second). + The list shall be sorted with highest values first. + type: number + GovLengthRange: + 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. + format: int32 + type: integer + GuaranteedFrameRateSupported: + description: Indicates the support for the GuaranteedFrameRate attribute + on the VideoEncoder2Configuration element. + type: boolean + ProfilesSupported: + description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. + type: string + QualityRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: Range of the quality values. A high value means higher quality. + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/onvif_VideoResolution2' + type: array + required: + - Encoding + - QualityRange + - ResolutionsAvailable + - BitrateRange + type: object + onvif_VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Encoding: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + GuaranteedFrameRate: + 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." + type: boolean + H264: + allOf: + - $ref: '#/components/schemas/onvif_H264Configuration' + - description: Optional element to configure H.264 related parameters. + MPEG4: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + Quality: + description: Relative value for the video quantizers and the quality of + the video. A high value within supported quality range means higher + quality + type: number + RateControl: + allOf: + - $ref: '#/components/schemas/onvif_VideoRateControl' + - description: Optional element to configure rate control related parameters. + Resolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution' + - description: Configured video resolution + SessionTimeout: + description: The rtsp session timeout for the related video stream + format: date-time + type: string + required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + onvif_VideoEncoderConfigurationOptions: + properties: + Extension: + $ref: '#/components/schemas/onvif_VideoEncoderOptionsExtension' + GuaranteedFrameRateSupported: + description: Indicates the support for the GuaranteedFrameRate attribute + on the VideoEncoderConfiguration element. + type: boolean + H264: + allOf: + - $ref: '#/components/schemas/onvif_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension + element). + JPEG: + allOf: + - $ref: '#/components/schemas/onvif_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension + element). + MPEG4: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension + element). + QualityRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of the quality values. A high value means higher quality. + required: + - QualityRange + type: object + onvif_VideoEncoderOptionsExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_VideoEncoderOptionsExtension2' + H264: + allOf: + - $ref: '#/components/schemas/onvif_H264Options2' + - description: Optional H.264 encoder settings ranges. + JPEG: + allOf: + - $ref: '#/components/schemas/onvif_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + MPEG4: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. + type: object + onvif_VideoEncoderOptionsExtension2: + type: object + onvif_VideoEncoding: + enum: + - JPEG + - MPEG4 + - H264 + type: string + onvif_VideoEncodingMimeNames: + description: Video Media Subtypes as referenced by IANA (without the leading + "video/" Video Media Type). See also + enum: + - JPEG + - MPV4-ES + - H264 + - H265 + type: string + onvif_VideoEncodingProfiles: + enum: + - Simple + - AdvancedSimple + - Baseline + - Main + - Main10 + - Extended + - High + type: string + onvif_VideoOutput: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + AspectRatio: + description: Aspect ratio of the display as physical extent of width divided + by height. + type: number + Extension: + $ref: '#/components/schemas/onvif_VideoOutputExtension' + Layout: + $ref: '#/components/schemas/onvif_Layout' + RefreshRate: + description: Refresh rate of the display in Hertz. + type: number + Resolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution' + - description: Resolution of the display in Pixel. + required: + - Layout + type: object + description: Representation of a physical video outputs. + onvif_VideoOutputConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + OutputToken: + description: Token of the Video Output the configuration applies to + maxLength: 64 + type: string + required: + - OutputToken + type: object + onvif_VideoOutputConfigurationOptions: + type: object + onvif_VideoOutputExtension: + type: object + onvif_VideoRateControl: + properties: + BitrateLimit: + description: the maximum output bitrate in kbps + format: int32 + type: integer + EncodingInterval: + 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 ...) + format: int32 + type: integer + FrameRateLimit: + description: Maximum output framerate in fps. If an EncodingInterval is + provided the resulting encoded framerate will be reduced by the given + factor. + format: int32 + type: integer + required: + - FrameRateLimit + - EncodingInterval + - BitrateLimit + type: object + onvif_VideoRateControl2: + properties: + BitrateLimit: + description: the maximum output bitrate in kbps + format: int32 + type: integer + ConstantBitRate: + description: Enforce constant bitrate. + type: boolean + FrameRateLimit: + description: Desired frame rate in fps. The actual rate may be lower due + to e.g. performance limitations. + type: number + required: + - FrameRateLimit + - BitrateLimit + type: object + onvif_VideoResolution: + properties: + Height: + description: Number of the lines of the Video image. + format: int32 + type: integer + Width: + description: Number of the columns of the Video image. + format: int32 + type: integer + required: + - Width + - Height + type: object + onvif_VideoResolution2: + properties: + Height: + description: Number of the lines of the Video image. + format: int32 + type: integer + Width: + description: Number of the columns of the Video image. + format: int32 + type: integer + required: + - Width + - Height + type: object + onvif_VideoSource: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Extension: + $ref: '#/components/schemas/onvif_VideoSourceExtension' + Framerate: + description: Frame rate in frames per second. + type: number + Imaging: + allOf: + - $ref: '#/components/schemas/onvif_ImagingSettings' + - description: Optional configuration of the image sensor. + Resolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution' + - description: Horizontal and vertical resolution + required: + - Framerate + - Resolution + type: object + description: Representation of a physical video input. + onvif_VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Bounds: + allOf: + - $ref: '#/components/schemas/onvif_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing + area shall not be larger than the whole Video source area. + Extension: + $ref: '#/components/schemas/onvif_VideoSourceConfigurationExtension' + SourceToken: + description: Reference to the physical input. + maxLength: 64 + type: string + ViewMode: + description: Readonly parameter signalling Source configuration's view + mode, for devices supporting different view modes as defined in tt:viewModes. + type: string + required: + - SourceToken + - Bounds + type: object + onvif_VideoSourceConfigurationExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_VideoSourceConfigurationExtension2' + Rotate: + allOf: + - $ref: '#/components/schemas/onvif_Rotate' + - 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." + type: object + onvif_VideoSourceConfigurationExtension2: + properties: + LensDescription: + description: Optional element describing the geometric lens distortion. + Multiple instances for future variable lens support. + items: + $ref: '#/components/schemas/onvif_LensDescription' + type: array + SceneOrientation: + allOf: + - $ref: '#/components/schemas/onvif_SceneOrientation' + - description: Optional element describing the scene orientation in the + camera’s field of view. + type: object + onvif_VideoSourceConfigurationOptions: + properties: + BoundsRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRectangleRange' + - 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." + Extension: + $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptionsExtension' + MaximumNumberOfProfiles: + description: Maximum number of profiles. + format: int32 + type: integer + VideoSourceTokensAvailable: + description: List of physical inputs. + items: + maxLength: 64 + type: string + type: array + required: + - BoundsRange + - VideoSourceTokensAvailable + type: object + onvif_VideoSourceConfigurationOptionsExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptionsExtension2' + Rotate: + allOf: + - $ref: '#/components/schemas/onvif_RotateOptions' + - description: Options of parameters for Rotation feature. + type: object + onvif_VideoSourceConfigurationOptionsExtension2: + properties: + SceneOrientationMode: + description: Scene orientation modes supported by the device for this configuration. + items: + $ref: '#/components/schemas/onvif_SceneOrientationMode' + type: array + type: object + onvif_VideoSourceExtension: + properties: + Extension: + $ref: '#/components/schemas/onvif_VideoSourceExtension2' + Imaging: + allOf: + - $ref: '#/components/schemas/onvif_ImagingSettings20' + - description: Optional configuration of the image sensor. To be used if + imaging service 2.00 is supported. + type: object + onvif_VideoSourceExtension2: + type: object + onvif_ViewModes: + description: Source view modes supported by device. + enum: + - tt:Fisheye + - tt:360Panorama + - tt:180Panorama + - tt:Quad + - tt:Original + - tt:LeftHalf + - tt:RightHalf + - tt:Dewarp + type: string + onvif_WhiteBalance: + properties: + CbGain: + description: Bgain (unitless). + type: number + CrGain: + description: Rgain (unitless). + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_WhiteBalanceMode' + - description: Auto whitebalancing mode (auto/manual). + required: + - Mode + - CrGain + - CbGain + type: object + onvif_WhiteBalance20: + properties: + CbGain: + description: Bgain (unitless). + type: number + CrGain: + description: Rgain (unitless). + type: number + Extension: + $ref: '#/components/schemas/onvif_WhiteBalance20Extension' + Mode: + allOf: + - $ref: '#/components/schemas/onvif_WhiteBalanceMode' + - description: "'AUTO' or 'MANUAL'" + required: + - Mode + type: object + onvif_WhiteBalance20Extension: + type: object + onvif_WhiteBalanceMode: + enum: + - AUTO + - MANUAL + type: string + onvif_WhiteBalanceOptions: + properties: + Mode: + items: + $ref: '#/components/schemas/onvif_WhiteBalanceMode' + type: array + YbGain: + $ref: '#/components/schemas/onvif_FloatRange' + YrGain: + $ref: '#/components/schemas/onvif_FloatRange' + required: + - Mode + - YrGain + - YbGain + type: object + onvif_WhiteBalanceOptions20: + properties: + Extension: + $ref: '#/components/schemas/onvif_WhiteBalanceOptions20Extension' + Mode: + description: Mode of WhiteBalance. + items: + $ref: '#/components/schemas/onvif_WhiteBalanceMode' + type: array + YbGain: + $ref: '#/components/schemas/onvif_FloatRange' + YrGain: + $ref: '#/components/schemas/onvif_FloatRange' + required: + - Mode + type: object + onvif_WhiteBalanceOptions20Extension: + type: object + onvif_WideDynamicMode: + enum: + - false + - true + type: string + onvif_WideDynamicRange: + properties: + Level: + description: Optional level parameter (unitless) + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_WideDynamicMode' + - description: White dynamic range (on/off) + required: + - Mode + - Level + type: object + onvif_WideDynamicRange20: + description: Type describing whether WDR mode is enabled or disabled (on/off). + properties: + Level: + description: Optional level parameter (unit unspecified). + type: number + Mode: + allOf: + - $ref: '#/components/schemas/onvif_WideDynamicMode' + - description: Wide dynamic range mode (on/off). + required: + - Mode + type: object + onvif_WideDynamicRangeOptions: + properties: + Level: + $ref: '#/components/schemas/onvif_FloatRange' + Mode: + items: + $ref: '#/components/schemas/onvif_WideDynamicMode' + type: array + required: + - Mode + - Level + type: object + onvif_WideDynamicRangeOptions20: + properties: + Level: + $ref: '#/components/schemas/onvif_FloatRange' + Mode: + items: + $ref: '#/components/schemas/onvif_WideDynamicMode' + type: array + required: + - Mode + type: object + onvif_ZoomLimits: + properties: + Range: + allOf: + - $ref: '#/components/schemas/onvif_Space1DDescription' + - description: A range of zoom limit + required: + - Range + type: object + soapenv_Body: + type: object + soapenv_Envelope: + properties: + Body: + $ref: '#/components/schemas/soapenv_Body' + Header: + $ref: '#/components/schemas/soapenv_Header' + required: + - Body + type: object + soapenv_Fault: + description: Fault reporting structure + properties: + Code: + $ref: '#/components/schemas/soapenv_faultcode' + Detail: + $ref: '#/components/schemas/soapenv_detail' + Node: + type: string + Reason: + $ref: '#/components/schemas/soapenv_faultreason' + Role: + type: string + required: + - Code + - Reason + type: object + soapenv_Header: + description: Elements replacing the wildcard MUST be namespace qualified, but + can be in the targetNamespace + type: object + soapenv_NotUnderstoodType: + properties: + qname: + type: string + required: + - qname + type: object + soapenv_SupportedEnvType: + properties: + qname: + type: string + required: + - qname + type: object + soapenv_UpgradeType: + properties: + SupportedEnvelope: + items: + $ref: '#/components/schemas/soapenv_SupportedEnvType' + type: array + required: + - SupportedEnvelope + type: object + soapenv_detail: + type: object + soapenv_faultcode: + properties: + Subcode: + $ref: '#/components/schemas/soapenv_subcode' + Value: + $ref: '#/components/schemas/soapenv_faultcodeEnum' + required: + - Value + type: object + soapenv_faultcodeEnum: + enum: + - tns:DataEncodingUnknown + - tns:MustUnderstand + - tns:Receiver + - tns:Sender + - tns:VersionMismatch + type: string + soapenv_faultreason: + properties: + Text: + items: + $ref: '#/components/schemas/soapenv_reasontext' + type: array + required: + - Text + type: object + soapenv_reasontext: + properties: + lang: + description: "lang (as an attribute name)\n denotes an attribute whose\ + \ value\n is a language code for the natural language of the content\ + \ of\n any element; its value is inherited. This name is reserved\n\ + \ by virtue of its definition in the XML specification." + oneOf: + - type: string + - type: string + type: object + soapenv_subcode: + properties: + Subcode: + $ref: '#/components/schemas/soapenv_subcode' + Value: + type: string + required: + - Value + type: object + tns1_space: + enum: + - default + - preserve + type: string + wsa_AttributedAnyType: + type: object + wsa_AttributedQNameType: + type: object + wsa_AttributedURIType: + type: object + wsa_EndpointReferenceType: + properties: + Address: + $ref: '#/components/schemas/wsa_AttributedURIType' + Metadata: + $ref: '#/components/schemas/wsa_MetadataType' + ReferenceParameters: + $ref: '#/components/schemas/wsa_ReferenceParametersType' + required: + - Address + type: object + wsa_FaultCodesOpenEnumType: + enum: + - tns:InvalidAddressingHeader + - tns:InvalidAddress + - tns:InvalidEPR + - tns:InvalidCardinality + - tns:MissingAddressInEPR + - tns:DuplicateMessageID + - tns:ActionMismatch + - tns:MessageAddressingHeaderRequired + - tns:DestinationUnreachable + - tns:ActionNotSupported + - tns:EndpointUnavailable + type: string + wsa_FaultCodesOpenEnumType1: + oneOf: + - type: object + wsa_MetadataType: + type: object + wsa_ProblemActionType: + properties: + Action: + $ref: '#/components/schemas/wsa_AttributedURIType' + SoapAction: + type: string + type: object + wsa_ReferenceParametersType: + type: object + wsa_RelatesToType: + properties: + RelationshipType: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + type: object + wsa_RelationshipTypeOpenEnum: + enum: + - http://www.w3.org/2005/08/addressing/reply + type: string + wsa_RelationshipTypeOpenEnum1: + oneOf: + - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsnt_CreatePullPoint: + type: object + wsnt_CreatePullPointResponse: + properties: + PullPoint: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + required: + - PullPoint + type: object + wsnt_DestroyPullPoint: + type: object + wsnt_DestroyPullPointResponse: + type: object + wsnt_FilterType: + type: object + wsnt_GetCurrentMessage: + properties: + Topic: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + required: + - Topic + type: object + wsnt_GetCurrentMessageResponse: + type: object + wsnt_GetMessages: + properties: + MaximumNumber: + format: int32 + type: integer + type: object + wsnt_GetMessagesResponse: + properties: + NotificationMessage: + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + type: object + wsnt_InvalidFilterFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + UnknownFilter: + items: + type: string + type: array + required: + - UnknownFilter + type: object + wsnt_InvalidMessageContentExpressionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_InvalidProducerPropertiesExpressionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_InvalidTopicExpressionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_Message: + type: object + wsnt_MultipleTopicsSpecifiedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_NoCurrentMessageOnTopicFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_NotificationMessageHolderType: + properties: + Message: + $ref: '#/components/schemas/wsnt_Message' + ProducerReference: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + SubscriptionReference: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + Topic: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + required: + - Message + type: object + wsnt_NotificationProducerRP: + properties: + FixedTopicSet: + default: true + type: boolean + TopicExpression: + items: + $ref: '#/components/schemas/wsnt_TopicExpressionType' + type: array + TopicExpressionDialect: + items: + type: string + type: array + TopicSet: + $ref: '#/components/schemas/wstop_TopicSetType' + type: object + wsnt_Notify: + properties: + NotificationMessage: + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + required: + - NotificationMessage + type: object + wsnt_NotifyMessageNotSupportedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_PauseFailedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_PauseSubscription: + type: object + wsnt_PauseSubscriptionResponse: + type: object + wsnt_QueryExpressionType: + properties: + Dialect: + type: string + required: + - Dialect + type: object + wsnt_Renew: + properties: + TerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + required: + - TerminationTime + type: object + wsnt_RenewResponse: + properties: + CurrentTime: + format: date-time + type: string + TerminationTime: + format: date-time + type: string + required: + - TerminationTime + type: object + wsnt_ResumeFailedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_ResumeSubscription: + type: object + wsnt_ResumeSubscriptionResponse: + type: object + wsnt_Subscribe: + properties: + ConsumerReference: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + Filter: + $ref: '#/components/schemas/wsnt_FilterType' + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' + SubscriptionPolicy: + $ref: '#/components/schemas/wsnt_SubscriptionPolicy' + required: + - ConsumerReference + type: object + wsnt_SubscribeCreationFailedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_SubscribeResponse: + properties: + CurrentTime: + format: date-time + type: string + SubscriptionReference: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + TerminationTime: + format: date-time + type: string + required: + - SubscriptionReference + type: object + wsnt_SubscriptionManagerRP: + properties: + ConsumerReference: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + CreationTime: + format: date-time + type: string + Filter: + $ref: '#/components/schemas/wsnt_FilterType' + SubscriptionPolicy: + $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' + required: + - ConsumerReference + type: object + wsnt_SubscriptionPolicy: + type: object + wsnt_SubscriptionPolicyType: + type: object + wsnt_TopicExpressionDialectUnknownFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_TopicExpressionType: + properties: + Dialect: + type: string + required: + - Dialect + type: object + wsnt_TopicNotSupportedFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_UnableToCreatePullPointFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_UnableToDestroyPullPointFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_UnableToDestroySubscriptionFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_UnableToGetMessagesFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsnt_UnacceptableInitialTerminationTimeFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + MaximumTime: + format: date-time + type: string + MinimumTime: + format: date-time + type: string + required: + - MinimumTime + type: object + wsnt_UnacceptableTerminationTimeFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + MaximumTime: + format: date-time + type: string + MinimumTime: + format: date-time + type: string + required: + - MinimumTime + type: object + wsnt_UnrecognizedPolicyRequestFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + UnrecognizedPolicy: + items: + type: string + type: array + type: object + wsnt_Unsubscribe: + type: object + wsnt_UnsubscribeResponse: + type: object + wsnt_UnsupportedPolicyRequestFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - properties: + UnsupportedPolicy: + items: + type: string + type: array + type: object + wsnt_UseRaw: + type: object + wsrf-bf_BaseFaultType: + properties: + Description: + items: + $ref: '#/components/schemas/wsrf-bf_Description' + type: array + ErrorCode: + $ref: '#/components/schemas/wsrf-bf_ErrorCode' + FaultCause: + $ref: '#/components/schemas/wsrf-bf_FaultCause' + Originator: + $ref: '#/components/schemas/wsa_EndpointReferenceType' + Timestamp: + format: date-time + type: string + required: + - Timestamp + type: object + wsrf-bf_Description: + properties: + lang: + description: "lang (as an attribute name)\n denotes an attribute whose\ + \ value\n is a language code for the natural language of the content\ + \ of\n any element; its value is inherited. This name is reserved\n\ + \ by virtue of its definition in the XML specification." + oneOf: + - type: string + - type: string + type: object + wsrf-bf_ErrorCode: + properties: + dialect: + type: string + required: + - dialect + type: object + wsrf-bf_FaultCause: + type: object + wstop_Documentation: + type: object + wstop_ExtensibleDocumented: + properties: + documentation: + $ref: '#/components/schemas/wstop_Documentation' + type: object + wstop_QueryExpressionType: + properties: + Dialect: + type: string + required: + - Dialect + type: object + wstop_TopicSetType: + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + xmime_base64Binary: + properties: + contentType: + minLength: 3 + type: string + type: object + xmime_hexBinary: + properties: + contentType: + minLength: 3 + type: string + type: object + xop_Include: + properties: + href: + type: string + required: + - href + type: object + device_AddIPAddressFilter: + properties: + IPAddressFilter: + $ref: '#/components/schemas/onvif_IPAddressFilter' + required: + - IPAddressFilter + type: object + device_AddIPAddressFilterResponse: + type: object + device_AddScopes: + properties: + ScopeItem: + description: Contains a list of new configurable scope parameters that will + be added to the existing configurable scope. + items: + type: string + type: array + required: + - ScopeItem + type: object + device_AddScopesResponse: + type: object + device_AutoGeoModes: + enum: + - Location + - Heading + - Leveling + type: string + device_Capabilities: + type: object + device_CreateCertificate: + properties: + CertificateID: + description: Certificate id. + type: string + Subject: + description: Identification of the entity associated with the public-key. + type: string + ValidNotAfter: + description: Certificate expiry start date. + format: date-time + type: string + ValidNotBefore: + description: Certificate validity start date. + format: date-time + type: string + type: object + device_CreateCertificateResponse: + properties: + NvtCertificate: + allOf: + - $ref: '#/components/schemas/onvif_Certificate' + - description: base64 encoded DER representation of certificate. + required: + - NvtCertificate + type: object + device_CreateDot1XConfiguration: + properties: + Dot1XConfiguration: + $ref: '#/components/schemas/onvif_Dot1XConfiguration' + required: + - Dot1XConfiguration + type: object + device_CreateDot1XConfigurationResponse: + type: object + device_CreateStorageConfiguration: + properties: + StorageConfiguration: + $ref: '#/components/schemas/device_StorageConfigurationData' + required: + - StorageConfiguration + type: object + device_CreateStorageConfigurationResponse: + properties: + Token: + maxLength: 64 + type: string + required: + - Token + type: object + device_CreateUsers: + properties: + User: + 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.' + items: + $ref: '#/components/schemas/onvif_User' + type: array + required: + - User + type: object + device_CreateUsersResponse: + type: object + device_DeleteCertificates: + properties: + CertificateID: + description: List of ids of certificates to delete. + items: + type: string + type: array + required: + - CertificateID + type: object + device_DeleteCertificatesResponse: + type: object + device_DeleteDot1XConfiguration: + properties: + Dot1XConfigurationToken: + items: + maxLength: 64 + type: string + type: array + type: object + device_DeleteDot1XConfigurationResponse: + type: object + device_DeleteGeoLocation: + properties: + Location: + items: + $ref: '#/components/schemas/onvif_LocationEntity' + type: array + required: + - Location + type: object + device_DeleteGeoLocationResponse: + type: object + device_DeleteStorageConfiguration: + properties: + Token: + maxLength: 64 + type: string + required: + - Token + type: object + device_DeleteStorageConfigurationResponse: + type: object + device_DeleteUsers: + properties: + Username: + 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. + items: + type: string + type: array + required: + - Username + type: object + device_DeleteUsersResponse: + type: object + device_DeviceServiceCapabilities: + properties: + Misc: + allOf: + - $ref: '#/components/schemas/device_MiscCapabilities' + - description: Capabilities that do not fit in any of the other categories. + Network: + allOf: + - $ref: '#/components/schemas/device_NetworkCapabilities' + - description: Network capabilities. + Security: + allOf: + - $ref: '#/components/schemas/device_SecurityCapabilities' + - description: Security capabilities. + System: + allOf: + - $ref: '#/components/schemas/device_SystemCapabilities' + - description: System capabilities. + required: + - Network + - Security + - System + type: object + device_Extension: + type: object + device_GetAccessPolicy: + type: object + device_GetAccessPolicyResponse: + properties: + PolicyFile: + $ref: '#/components/schemas/onvif_BinaryData' + required: + - PolicyFile + type: object + device_GetAuthFailureWarningConfiguration: + type: object + device_GetAuthFailureWarningConfigurationResponse: + properties: + Enabled: + type: boolean + MaxAuthFailures: + format: int32 + type: integer + MonitorPeriod: + format: int32 + type: integer + required: + - Enabled + - MonitorPeriod + - MaxAuthFailures + type: object + device_GetAuthFailureWarningOptions: + type: object + device_GetAuthFailureWarningOptionsResponse: + properties: + AuthFailureRange: + $ref: '#/components/schemas/onvif_IntRange' + MonitorPeriodRange: + $ref: '#/components/schemas/onvif_IntRange' + required: + - MonitorPeriodRange + - AuthFailureRange + type: object + device_GetCACertificates: + type: object + device_GetCACertificatesResponse: + properties: + CACertificate: + items: + $ref: '#/components/schemas/onvif_Certificate' + type: array + type: object + device_GetCapabilities: + properties: + Category: + description: List of categories to retrieve capability information on. + items: + $ref: '#/components/schemas/onvif_CapabilityCategory' + type: array + type: object + device_GetCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/onvif_Capabilities' + - description: Capability information. + required: + - Capabilities + type: object + device_GetCertificateInformation: + properties: + CertificateID: + type: string + required: + - CertificateID + type: object + device_GetCertificateInformationResponse: + properties: + CertificateInformation: + $ref: '#/components/schemas/onvif_CertificateInformation' + required: + - CertificateInformation + type: object + device_GetCertificates: + type: object + device_GetCertificatesResponse: + properties: + NvtCertificate: + description: Id and base64 encoded DER representation of all available certificates. + items: + $ref: '#/components/schemas/onvif_Certificate' + type: array + type: object + device_GetCertificatesStatus: + type: object + device_GetCertificatesStatusResponse: + properties: + CertificateStatus: + description: Indicates if a certificate is used in an optional HTTPS configuration + of the device. + items: + $ref: '#/components/schemas/onvif_CertificateStatus' + type: array + type: object + device_GetClientCertificateMode: + type: object + device_GetClientCertificateModeResponse: + properties: + Enabled: + description: Indicates whether or not client certificates are required by + device. + type: boolean + required: + - Enabled + type: object + device_GetDNS: + type: object + device_GetDNSResponse: + properties: + DNSInformation: + allOf: + - $ref: '#/components/schemas/onvif_DNSInformation' + - description: DNS information. + required: + - DNSInformation + type: object + device_GetDPAddresses: + type: object + device_GetDPAddressesResponse: + properties: + DPAddress: + items: + $ref: '#/components/schemas/onvif_NetworkHost' + type: array + type: object + device_GetDeviceInformation: + type: object + device_GetDeviceInformationResponse: + properties: + FirmwareVersion: + description: The firmware version in the device. + type: string + HardwareId: + description: The hardware ID of the device. + type: string + Manufacturer: + description: The manufactor of the device. + type: string + Model: + description: The device model. + type: string + SerialNumber: + description: The serial number of the device. + type: string + required: + - Manufacturer + - Model + - FirmwareVersion + - SerialNumber + - HardwareId + type: object + device_GetDiscoveryMode: + type: object + device_GetDiscoveryModeResponse: + properties: + DiscoveryMode: + allOf: + - $ref: '#/components/schemas/onvif_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + required: + - DiscoveryMode + type: object + device_GetDot11Capabilities: + type: object + device_GetDot11CapabilitiesResponse: + properties: + Capabilities: + $ref: '#/components/schemas/onvif_Dot11Capabilities' + required: + - Capabilities + type: object + device_GetDot11Status: + properties: + InterfaceToken: + maxLength: 64 + type: string + required: + - InterfaceToken + type: object + device_GetDot11StatusResponse: + properties: + Status: + $ref: '#/components/schemas/onvif_Dot11Status' + required: + - Status + type: object + device_GetDot1XConfiguration: + properties: + Dot1XConfigurationToken: + maxLength: 64 + type: string + required: + - Dot1XConfigurationToken + type: object + device_GetDot1XConfigurationResponse: + properties: + Dot1XConfiguration: + $ref: '#/components/schemas/onvif_Dot1XConfiguration' + required: + - Dot1XConfiguration + type: object + device_GetDot1XConfigurations: + type: object + device_GetDot1XConfigurationsResponse: + properties: + Dot1XConfiguration: + items: + $ref: '#/components/schemas/onvif_Dot1XConfiguration' + type: array + type: object + device_GetDynamicDNS: + type: object + device_GetDynamicDNSResponse: + properties: + DynamicDNSInformation: + allOf: + - $ref: '#/components/schemas/onvif_DynamicDNSInformation' + - description: Dynamic DNS information. + required: + - DynamicDNSInformation + type: object + device_GetEndpointReference: + type: object + device_GetEndpointReferenceResponse: + properties: + GUID: + type: string + required: + - GUID + type: object + device_GetGeoLocation: + type: object + device_GetGeoLocationResponse: + properties: + Location: + items: + $ref: '#/components/schemas/onvif_LocationEntity' + type: array + type: object + device_GetHostname: + type: object + device_GetHostnameResponse: + properties: + HostnameInformation: + allOf: + - $ref: '#/components/schemas/onvif_HostnameInformation' + - description: Contains the hostname information. + required: + - HostnameInformation + type: object + device_GetIPAddressFilter: + type: object + device_GetIPAddressFilterResponse: + properties: + IPAddressFilter: + $ref: '#/components/schemas/onvif_IPAddressFilter' + required: + - IPAddressFilter + type: object + device_GetNTP: + type: object + device_GetNTPResponse: + properties: + NTPInformation: + allOf: + - $ref: '#/components/schemas/onvif_NTPInformation' + - description: NTP information. + required: + - NTPInformation + type: object + device_GetNetworkDefaultGateway: + type: object + device_GetNetworkDefaultGatewayResponse: + properties: + NetworkGateway: + allOf: + - $ref: '#/components/schemas/onvif_NetworkGateway' + - description: Gets the default IPv4 and IPv6 gateway settings from the + device. + required: + - NetworkGateway + type: object + device_GetNetworkInterfaces: + type: object + device_GetNetworkInterfacesResponse: + properties: + NetworkInterfaces: + description: List of network interfaces. + items: + $ref: '#/components/schemas/onvif_NetworkInterface' + type: array + required: + - NetworkInterfaces + type: object + device_GetNetworkProtocols: + type: object + device_GetNetworkProtocolsResponse: + properties: + NetworkProtocols: + 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.' + items: + $ref: '#/components/schemas/onvif_NetworkProtocol' + type: array + type: object + device_GetPasswordComplexityConfiguration: + type: object + device_GetPasswordComplexityConfigurationResponse: + properties: + BlockUsernameOccurrence: + type: boolean + MinLen: + format: int32 + type: integer + Number: + format: int32 + type: integer + PolicyConfigurationLocked: + type: boolean + SpecialChars: + format: int32 + type: integer + Uppercase: + format: int32 + type: integer + type: object + device_GetPasswordComplexityOptions: + type: object + device_GetPasswordComplexityOptionsResponse: + properties: + BlockUsernameOccurrenceSupported: + type: boolean + MinLenRange: + $ref: '#/components/schemas/onvif_IntRange' + NumberRange: + $ref: '#/components/schemas/onvif_IntRange' + PolicyConfigurationLockSupported: + type: boolean + SpecialCharsRange: + $ref: '#/components/schemas/onvif_IntRange' + UppercaseRange: + $ref: '#/components/schemas/onvif_IntRange' + type: object + device_GetPasswordHistoryConfiguration: + type: object + device_GetPasswordHistoryConfigurationResponse: + properties: + Enabled: + type: boolean + Length: + format: int32 + type: integer + required: + - Enabled + - Length + type: object + device_GetPkcs10Request: + properties: + Attributes: + allOf: + - $ref: '#/components/schemas/onvif_BinaryData' + - description: Optional base64 encoded DER attributes. + CertificateID: + description: List of ids of certificates to delete. + type: string + Subject: + description: Relative Dinstinguished Name(RDN) CommonName(CN). + type: string + required: + - CertificateID + type: object + device_GetPkcs10RequestResponse: + properties: + Pkcs10Request: + allOf: + - $ref: '#/components/schemas/onvif_BinaryData' + - description: base64 encoded DER representation of certificate. + required: + - Pkcs10Request + type: object + device_GetRelayOutputs: + type: object + device_GetRelayOutputsResponse: + properties: + RelayOutputs: + items: + $ref: '#/components/schemas/onvif_RelayOutput' + type: array + type: object + device_GetRemoteDiscoveryMode: + type: object + device_GetRemoteDiscoveryModeResponse: + properties: + RemoteDiscoveryMode: + allOf: + - $ref: '#/components/schemas/onvif_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + required: + - RemoteDiscoveryMode + type: object + device_GetRemoteUser: + type: object + device_GetRemoteUserResponse: + properties: + RemoteUser: + $ref: '#/components/schemas/onvif_RemoteUser' + type: object + device_GetScopes: + type: object + device_GetScopesResponse: + properties: + Scopes: + 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.' + items: + $ref: '#/components/schemas/onvif_Scope' + type: array + required: + - Scopes + type: object + device_GetServiceCapabilities: + type: object + device_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/device_DeviceServiceCapabilities' + - description: The capabilities for the device service is returned in the + Capabilities element. + required: + - Capabilities + type: object + device_GetServices: + properties: + IncludeCapability: + description: Indicates if the service capabilities (untyped) should be included + in the response. + type: boolean + required: + - IncludeCapability + type: object + device_GetServicesResponse: + properties: + Service: + description: Each Service element contains information about one service. + items: + $ref: '#/components/schemas/device_Service' + type: array + required: + - Service + type: object + device_GetStorageConfiguration: + properties: + Token: + maxLength: 64 + type: string + required: + - Token + type: object + device_GetStorageConfigurationResponse: + properties: + StorageConfiguration: + $ref: '#/components/schemas/device_StorageConfiguration' + required: + - StorageConfiguration + type: object + device_GetStorageConfigurations: + type: object + device_GetStorageConfigurationsResponse: + properties: + StorageConfigurations: + items: + $ref: '#/components/schemas/device_StorageConfiguration' + type: array + type: object + device_GetSystemBackup: + type: object + device_GetSystemBackupResponse: + properties: + BackupFiles: + items: + $ref: '#/components/schemas/onvif_BackupFile' + type: array + required: + - BackupFiles + type: object + device_GetSystemDateAndTime: + type: object + device_GetSystemDateAndTimeResponse: + properties: + SystemDateAndTime: + allOf: + - $ref: '#/components/schemas/onvif_SystemDateTime' + - 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. + required: + - SystemDateAndTime + type: object + device_GetSystemLog: + properties: + LogType: + allOf: + - $ref: '#/components/schemas/onvif_SystemLogType' + - description: Specifies the type of system log to get. + required: + - LogType + type: object + device_GetSystemLogResponse: + properties: + SystemLog: + allOf: + - $ref: '#/components/schemas/onvif_SystemLog' + - description: Contains the system log information. + required: + - SystemLog + type: object + device_GetSystemSupportInformation: + type: object + device_GetSystemSupportInformationResponse: + properties: + SupportInformation: + allOf: + - $ref: '#/components/schemas/onvif_SupportInformation' + - description: Contains the arbitary device diagnostics information. + required: + - SupportInformation + type: object + device_GetSystemUris: + type: object + device_GetSystemUrisResponse: + properties: + Extension: + $ref: '#/components/schemas/device_Extension' + SupportInfoUri: + type: string + SystemBackupUri: + type: string + SystemLogUris: + $ref: '#/components/schemas/onvif_SystemLogUriList' + type: object + device_GetUsers: + type: object + device_GetUsersResponse: + properties: + User: + description: 'Contains a list of the onvif users and following information + is included in each entry: username and user level.' + items: + $ref: '#/components/schemas/onvif_User' + type: array + type: object + device_GetWsdlUrl: + type: object + device_GetWsdlUrlResponse: + properties: + WsdlUrl: + type: string + required: + - WsdlUrl + type: object + device_GetZeroConfiguration: + type: object + device_GetZeroConfigurationResponse: + properties: + ZeroConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_NetworkZeroConfiguration' + - description: Contains the zero-configuration. + required: + - ZeroConfiguration + type: object + device_LoadCACertificates: + properties: + CACertificate: + items: + $ref: '#/components/schemas/onvif_Certificate' + type: array + required: + - CACertificate + type: object + device_LoadCACertificatesResponse: + type: object + device_LoadCertificateWithPrivateKey: + properties: + CertificateWithPrivateKey: + items: + $ref: '#/components/schemas/onvif_CertificateWithPrivateKey' + type: array + required: + - CertificateWithPrivateKey + type: object + device_LoadCertificateWithPrivateKeyResponse: + type: object + device_LoadCertificates: + properties: + NVTCertificate: + description: Optional id and base64 encoded DER representation of certificate. + items: + $ref: '#/components/schemas/onvif_Certificate' + type: array + required: + - NVTCertificate + type: object + device_LoadCertificatesResponse: + type: object + device_MiscCapabilities: + properties: + AuxiliaryCommands: + description: Lists of commands supported by SendAuxiliaryCommand. + type: string + type: object + device_NetworkCapabilities: + properties: + DHCPv6: + description: Indicates support for Stateful IPv6 DHCP. + type: boolean + Dot11Configuration: + description: Indicates support for IEEE 802.11 configuration. + type: boolean + Dot1XConfigurations: + description: Indicates the maximum number of Dot1X configurations supported + by the device + format: int32 + type: integer + DynDNS: + description: Indicates support for dynamic DNS configuration. + type: boolean + HostnameFromDHCP: + description: Indicates support for retrieval of hostname from DHCP. + type: boolean + IPFilter: + description: Indicates support for IP filtering. + type: boolean + IPVersion6: + description: Indicates support for IPv6. + type: boolean + NTP: + description: Maximum number of NTP servers supported by the devices SetNTP + command. + format: int32 + type: integer + ZeroConfiguration: + description: Indicates support for zeroconf. + type: boolean + type: object + device_RemoveIPAddressFilter: + properties: + IPAddressFilter: + $ref: '#/components/schemas/onvif_IPAddressFilter' + required: + - IPAddressFilter + type: object + device_RemoveIPAddressFilterResponse: + type: object + device_RemoveScopes: + properties: + ScopeItem: + description: Contains a list of URIs that should be removed from the device + scope. + items: + type: string + type: array + required: + - ScopeItem + type: object + device_RemoveScopesResponse: + properties: + ScopeItem: + description: Contains a list of URIs that has been removed from the device + scope + items: + type: string + type: array + type: object + device_RestoreSystem: + properties: + BackupFiles: + items: + $ref: '#/components/schemas/onvif_BackupFile' + type: array + required: + - BackupFiles + type: object + device_RestoreSystemResponse: + type: object + device_ScanAvailableDot11Networks: + properties: + InterfaceToken: + maxLength: 64 + type: string + required: + - InterfaceToken + type: object + device_ScanAvailableDot11NetworksResponse: + properties: + Networks: + items: + $ref: '#/components/schemas/onvif_Dot11AvailableNetworks' + type: array + type: object + device_SecurityCapabilities: + properties: + AccessPolicyConfig: + description: Indicates support for access policy configuration. + type: boolean + DefaultAccessPolicy: + description: Indicates support for the ONVIF default access policy. + type: boolean + Dot1X: + description: Indicates support for IEEE 802.1X configuration. + type: boolean + HttpDigest: + description: Indicates support for WS over HTTP digest authenticated communication + layer. + type: boolean + KerberosToken: + description: Indicates support for WS-Security Kerberos token. + type: boolean + MaxPasswordHistory: + description: Maximum number of passwords that the device can remember for + each user + format: int32 + type: integer + MaxPasswordLength: + description: Maximum number of characters supported for the password by + CreateUsers and SetUser. + format: int32 + type: integer + MaxUserNameLength: + description: Maximum number of characters supported for the username by + CreateUsers. + format: int32 + type: integer + MaxUsers: + description: The maximum number of users that the device supports. + format: int32 + type: integer + OnboardKeyGeneration: + description: Indicates support for onboard key generation. + type: boolean + RELToken: + description: Indicates support for WS-Security REL token. + type: boolean + RemoteUserHandling: + description: Indicates support for remote user configuration. Used when + accessing another device. + type: boolean + SAMLToken: + description: Indicates support for WS-Security SAML token. + type: boolean + SecurityPolicies: + description: 'Indicates which security policies are supported. Options are: + ModifyPassword, PasswordComplexity, AuthFailureWarnings' + type: string + SupportedEAPMethods: + description: EAP Methods supported by the device. The int values refer to + the + format: int32 + type: integer + TLS1.0: + description: Indicates support for TLS 1.0. + type: boolean + TLS1.1: + description: Indicates support for TLS 1.1. + type: boolean + TLS1.2: + description: Indicates support for TLS 1.2. + type: boolean + UsernameToken: + description: Indicates support for WS-Security Username token. + type: boolean + X.509Token: + description: Indicates support for WS-Security X.509 token. + type: boolean + type: object + device_SendAuxiliaryCommand: + properties: + AuxiliaryCommand: + maxLength: 128 + type: string + required: + - AuxiliaryCommand + type: object + device_SendAuxiliaryCommandResponse: + properties: + AuxiliaryCommandResponse: + maxLength: 128 + type: string + type: object + device_Service: + properties: + Capabilities: + $ref: '#/components/schemas/device_Capabilities' + Namespace: + 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. + type: string + Version: + allOf: + - $ref: '#/components/schemas/onvif_OnvifVersion' + - description: The version of the service (not the ONVIF core spec version). + XAddr: + 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). + type: string + required: + - Namespace + - XAddr + - Version + type: object + device_SetAccessPolicy: + properties: + PolicyFile: + $ref: '#/components/schemas/onvif_BinaryData' + required: + - PolicyFile + type: object + device_SetAccessPolicyResponse: + type: object + device_SetAuthFailureWarningConfiguration: + properties: + Enabled: + type: boolean + MaxAuthFailures: + format: int32 + type: integer + MonitorPeriod: + format: int32 + type: integer + required: + - Enabled + - MonitorPeriod + - MaxAuthFailures + type: object + device_SetAuthFailureWarningConfigurationResponse: + type: object + device_SetCertificatesStatus: + properties: + CertificateStatus: + description: Indicates if a certificate is to be used in an optional HTTPS + configuration of the device. + items: + $ref: '#/components/schemas/onvif_CertificateStatus' + type: array + type: object + device_SetCertificatesStatusResponse: + type: object + device_SetClientCertificateMode: + properties: + Enabled: + description: Indicates whether or not client certificates are required by + device. + type: boolean + required: + - Enabled + type: object + device_SetClientCertificateModeResponse: + type: object + device_SetDNS: + properties: + DNSManual: + description: DNS address(es) set manually. + items: + $ref: '#/components/schemas/onvif_IPAddress' + type: array + FromDHCP: + description: Indicate if the DNS address is to be retrieved using DHCP. + type: boolean + SearchDomain: + description: DNS search domain. + items: + type: string + type: array + required: + - FromDHCP + type: object + device_SetDNSResponse: + type: object + device_SetDPAddresses: + properties: + DPAddress: + items: + $ref: '#/components/schemas/onvif_NetworkHost' + type: array + type: object + device_SetDPAddressesResponse: + type: object + device_SetDiscoveryMode: + properties: + DiscoveryMode: + allOf: + - $ref: '#/components/schemas/onvif_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + required: + - DiscoveryMode + type: object + device_SetDiscoveryModeResponse: + type: object + device_SetDot1XConfiguration: + properties: + Dot1XConfiguration: + $ref: '#/components/schemas/onvif_Dot1XConfiguration' + required: + - Dot1XConfiguration + type: object + device_SetDot1XConfigurationResponse: + type: object + device_SetDynamicDNS: + properties: + Name: + description: DNS name. + type: string + TTL: + description: DNS record time to live. + format: date-time + type: string + Type: + allOf: + - $ref: '#/components/schemas/onvif_DynamicDNSType' + - description: Dynamic DNS type. + required: + - Type + type: object + device_SetDynamicDNSResponse: + type: object + device_SetGeoLocation: + properties: + Location: + items: + $ref: '#/components/schemas/onvif_LocationEntity' + type: array + required: + - Location + type: object + device_SetGeoLocationResponse: + type: object + device_SetHostname: + properties: + Name: + description: The hostname to set. + type: string + required: + - Name + type: object + device_SetHostnameFromDHCP: + properties: + FromDHCP: + description: True if the hostname shall be obtained via DHCP. + type: boolean + required: + - FromDHCP + type: object + device_SetHostnameFromDHCPResponse: + properties: + RebootNeeded: + description: Indicates whether or not a reboot is required after configuration + updates. + type: boolean + required: + - RebootNeeded + type: object + device_SetHostnameResponse: + type: object + device_SetIPAddressFilter: + properties: + IPAddressFilter: + $ref: '#/components/schemas/onvif_IPAddressFilter' + required: + - IPAddressFilter + type: object + device_SetIPAddressFilterResponse: + type: object + device_SetNTP: + properties: + FromDHCP: + description: Indicate if NTP address information is to be retrieved using + DHCP. + type: boolean + NTPManual: + description: Manual NTP settings. + items: + $ref: '#/components/schemas/onvif_NetworkHost' + type: array + required: + - FromDHCP + type: object + device_SetNTPResponse: + type: object + device_SetNetworkDefaultGateway: + properties: + IPv4Address: + description: Sets IPv4 gateway address used as default setting. + items: + type: string + type: array + IPv6Address: + description: Sets IPv6 gateway address used as default setting. + items: + type: string + type: array + type: object + device_SetNetworkDefaultGatewayResponse: + type: object + device_SetNetworkInterfaces: + properties: + InterfaceToken: + description: Symbolic network interface name. + maxLength: 64 + type: string + NetworkInterface: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfiguration' + - description: Network interface name. + required: + - InterfaceToken + - NetworkInterface + type: object + device_SetNetworkInterfacesResponse: + properties: + RebootNeeded: + 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." + type: boolean + required: + - RebootNeeded + type: object + device_SetNetworkProtocols: + properties: + NetworkProtocols: + 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.' + items: + $ref: '#/components/schemas/onvif_NetworkProtocol' + type: array + required: + - NetworkProtocols + type: object + device_SetNetworkProtocolsResponse: + type: object + device_SetPasswordComplexityConfiguration: + properties: + BlockUsernameOccurrence: + type: boolean + MinLen: + format: int32 + type: integer + Number: + format: int32 + type: integer + PolicyConfigurationLocked: + type: boolean + SpecialChars: + format: int32 + type: integer + Uppercase: + format: int32 + type: integer + type: object + device_SetPasswordComplexityConfigurationResponse: + type: object + device_SetPasswordHistoryConfiguration: + properties: + Enabled: + type: boolean + Length: + format: int32 + type: integer + required: + - Enabled + - Length + type: object + device_SetPasswordHistoryConfigurationResponse: + type: object + device_SetRelayOutputSettings: + properties: + Properties: + $ref: '#/components/schemas/onvif_RelayOutputSettings' + RelayOutputToken: + maxLength: 64 + type: string + required: + - RelayOutputToken + - Properties + type: object + device_SetRelayOutputSettingsResponse: + type: object + device_SetRelayOutputState: + properties: + LogicalState: + $ref: '#/components/schemas/onvif_RelayLogicalState' + RelayOutputToken: + maxLength: 64 + type: string + required: + - RelayOutputToken + - LogicalState + type: object + device_SetRelayOutputStateResponse: + type: object + device_SetRemoteDiscoveryMode: + properties: + RemoteDiscoveryMode: + allOf: + - $ref: '#/components/schemas/onvif_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' + required: + - RemoteDiscoveryMode + type: object + device_SetRemoteDiscoveryModeResponse: + type: object + device_SetRemoteUser: + properties: + RemoteUser: + $ref: '#/components/schemas/onvif_RemoteUser' + type: object + device_SetRemoteUserResponse: + type: object + device_SetScopes: + properties: + Scopes: + description: Contains a list of scope parameters that will replace all existing + configurable scope parameters. + items: + type: string + type: array + required: + - Scopes + type: object + device_SetScopesResponse: + type: object + device_SetStorageConfiguration: + properties: + StorageConfiguration: + $ref: '#/components/schemas/device_StorageConfiguration' + required: + - StorageConfiguration + type: object + device_SetStorageConfigurationResponse: + type: object + device_SetSystemDateAndTime: + properties: + DateTimeType: + allOf: + - $ref: '#/components/schemas/onvif_SetDateTimeType' + - description: Defines if the date and time is set via NTP or manually. + DaylightSavings: + description: Automatically adjust Daylight savings if defined in TimeZone. + type: boolean + TimeZone: + allOf: + - $ref: '#/components/schemas/onvif_TimeZone' + - description: The time zone in POSIX 1003.1 format + UTCDateTime: + allOf: + - $ref: '#/components/schemas/onvif_DateTime' + - description: Date and time in UTC. If time is obtained via NTP, UTCDateTime + has no meaning + required: + - DateTimeType + - DaylightSavings + type: object + device_SetSystemDateAndTimeResponse: + type: object + device_SetSystemFactoryDefault: + properties: + FactoryDefault: + allOf: + - $ref: '#/components/schemas/onvif_FactoryDefaultType' + - description: Specifies the factory default action type. + required: + - FactoryDefault + type: object + device_SetSystemFactoryDefaultResponse: + type: object + device_SetUser: + properties: + User: + 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. + items: + $ref: '#/components/schemas/onvif_User' + type: array + required: + - User + type: object + device_SetUserResponse: + type: object + device_SetZeroConfiguration: + properties: + Enabled: + description: Specifies if the zero-configuration should be enabled or not. + type: boolean + InterfaceToken: + description: Unique identifier referencing the physical interface. + maxLength: 64 + type: string + required: + - InterfaceToken + - Enabled + type: object + device_SetZeroConfigurationResponse: + type: object + device_StartFirmwareUpgrade: + type: object + device_StartFirmwareUpgradeResponse: + properties: + ExpectedDownTime: + format: date-time + type: string + UploadDelay: + format: date-time + type: string + UploadUri: + type: string + required: + - UploadUri + - UploadDelay + - ExpectedDownTime + type: object + device_StartSystemRestore: + type: object + device_StartSystemRestoreResponse: + properties: + ExpectedDownTime: + format: date-time + type: string + UploadUri: + type: string + required: + - UploadUri + - ExpectedDownTime + type: object + device_StorageConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Data: + $ref: '#/components/schemas/device_StorageConfigurationData' + required: + - Data + type: object + device_StorageConfigurationData: + properties: + Extension: + $ref: '#/components/schemas/device_Extension' + LocalPath: + description: local path + type: string + StorageUri: + description: Storage server address + type: string + User: + allOf: + - $ref: '#/components/schemas/device_UserCredential' + - description: User credential for the storage server + type: + description: StorageType lists the acceptable values for type attribute + type: string + required: + - type + type: object + device_StorageType: + enum: + - NFS + - CIFS + - CDMI + - FTP + type: string + device_SystemCapabilities: + properties: + Addons: + description: List of supported Addons by the device. + type: string + AutoGeo: + description: List of supported automatic GeoLocation adjustment supported + by the device. Valid items are defined by tds:AutoGeoMode. + type: string + DiscoveryBye: + description: Indicates support for WS-Discovery Bye. + type: boolean + DiscoveryNotSupported: + description: Indicates no support for network discovery. + type: boolean + DiscoveryResolve: + description: Indicates support for WS Discovery resolve requests. + type: boolean + FirmwareUpgrade: + description: Indicates support for firmware upgrade through MTOM. + type: boolean + GeoLocationEntries: + description: If present signals support for geo location. The value signals + the supported number of entries. + format: int32 + type: integer + HttpFirmwareUpgrade: + description: Indicates support for firmware upgrade through HTTP. + type: boolean + HttpSupportInformation: + description: Indicates support for retrieving support information through + HTTP. + type: boolean + HttpSystemBackup: + description: Indicates support for system backup through HTTP. + type: boolean + HttpSystemLogging: + description: Indicates support for retrieval of system logging through HTTP. + type: boolean + MaxStorageConfigurations: + description: Indicates maximum number of storage configurations supported. + format: int32 + type: integer + NetworkConfigNotSupported: + description: Indicates no support for network configuration. + type: boolean + RemoteDiscovery: + description: Indicates support for remote discovery. + type: boolean + StorageConfiguration: + description: Indicates support for storage configuration interfaces. + type: boolean + StorageTypesSupported: + description: Enumerates the supported StorageTypes, see tds:StorageType. + type: string + SystemBackup: + description: Indicates support for system backup through MTOM. + type: boolean + SystemLogging: + description: Indicates support for retrieval of system logging through MTOM. + type: boolean + UserConfigNotSupported: + description: Indicates no support for user configuration. + type: boolean + type: object + device_SystemReboot: + type: object + device_SystemRebootResponse: + properties: + Message: + description: Contains the reboot message sent by the device. + type: string + required: + - Message + type: object + device_UpgradeSystemFirmware: + properties: + Firmware: + $ref: '#/components/schemas/onvif_AttachmentData' + required: + - Firmware + type: object + device_UpgradeSystemFirmwareResponse: + properties: + Message: + type: string + type: object + device_UserCredential: + properties: + Extension: + $ref: '#/components/schemas/device_Extension' + Password: + description: optional password + type: string + UserName: + description: User name + type: string + required: + - UserName + type: object + PullMessagesFaultResponse_Error: + properties: + PullMessagesFaultResponse: + $ref: '#/components/schemas/event_PullMessagesFaultResponse' + required: + - PullMessagesFaultResponse + type: object + ResourceUnknownFault_Error: + properties: + ResourceUnknownFault: + $ref: '#/components/schemas/wsrf-r_ResourceUnknownFaultType' + required: + - ResourceUnknownFault + type: object + UnableToCreatePullPointFault_Error: + properties: + UnableToCreatePullPointFault: + $ref: '#/components/schemas/wsnt_UnableToCreatePullPointFaultType' + required: + - UnableToCreatePullPointFault + type: object + event_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + event_AddEventBroker: + properties: + EventBroker: + $ref: '#/components/schemas/event_EventBrokerConfig' + required: + - EventBroker + type: object + event_AddEventBrokerResponse: + type: object + event_Capabilities: + properties: + EventBrokerProtocols: + description: A space separated list of supported event broker protocols + as defined by the tev:EventBrokerProtocol datatype. + type: string + MaxEventBrokers: + description: Maxiumum number of event broker configurations that can be + added to the device. + format: int32 + type: integer + MaxNotificationProducers: + description: Maximum number of supported notification producers as defined + by WS-BaseNotification. + format: int32 + type: integer + MaxPullPoints: + description: Maximum supported number of notification pull points. + format: int32 + type: integer + MetadataOverMQTT: + description: Indicates that metadata streaming over MQTT is supported + type: boolean + PersistentNotificationStorage: + description: Indication if the device supports persistent notification storage. + type: boolean + WSPausableSubscriptionManagerInterfaceSupport: + description: Indicates that the WS Pausable Subscription Manager Interface + is supported. + type: boolean + WSPullPointSupport: + description: Indicates that the WS Pull Point is supported. + type: boolean + WSSubscriptionPolicySupport: + description: Indicates that the WS Subscription policy is supported. + type: boolean + type: object + event_ConnectionStatus: + enum: + - Offline + - Connecting + - Connected + type: string + event_CreatePullPointSubscription: + properties: + Filter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - description: Optional XPATH expression to select specific topics. + InitialTerminationTime: + allOf: + - oneOf: + - nullable: true + - $ref: '#/components/schemas/event_AbsoluteOrRelativeTimeType' + - description: Initial termination time. + SubscriptionPolicy: + allOf: + - $ref: '#/components/schemas/event_SubscriptionPolicy' + - description: Refer to + type: object + event_CreatePullPointSubscriptionResponse: + properties: + CurrentTime: + description: Current time of the server for synchronization purposes. + format: date-time + type: string + SubscriptionReference: + allOf: + - $ref: '#/components/schemas/wsa_EndpointReferenceType' + - description: Endpoint reference of the subscription to be used for pulling + the messages. + TerminationTime: + description: Date time when the PullPoint will be shut down without further + pull requests. + format: date-time + type: string + required: + - SubscriptionReference + - CurrentTime + - TerminationTime + type: object + event_DeleteEventBroker: + properties: + Address: + type: string + required: + - Address + type: object + event_DeleteEventBrokerResponse: + type: object + event_EventBrokerConfig: + properties: + Address: + 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. + type: string + CertPathValidationPolicyID: + 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. + type: string + CertificateID: + description: Optional certificate ID in the key store pointing to a client + certificate to be used for authenticating the device at the message broker. + type: string + MetadataFilter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - description: Concrete Topic Expression to select specific metadata topics + to publish. + Password: + description: Password for the event broker. Password shall not be included + when returned with GetEventBrokers. + type: string + PublishFilter: + allOf: + - $ref: '#/components/schemas/wsnt_FilterType' + - description: Concrete Topic Expression to select specific event topics + to publish. + QoS: + 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.' + format: int32 + type: integer + Status: + description: Current connection status (see tev:ConnectionStatus for possible + values). + type: string + TopicPrefix: + 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. + type: string + UserName: + description: User name for the event broker. + type: string + required: + - Address + - TopicPrefix + type: object + event_EventBrokerProtocol: + enum: + - mqtt + - mqtts + - ws + - wss + type: string + event_GetEventBrokers: + properties: + Address: + type: string + type: object + event_GetEventBrokersResponse: + properties: + EventBroker: + items: + $ref: '#/components/schemas/event_EventBrokerConfig' + type: array + type: object + event_GetEventProperties: + type: object + event_GetEventPropertiesResponse: + properties: + FixedTopicSet: + description: True when topicset is fixed for all times. + type: boolean + MessageContentFilterDialect: + description: Defines the XPath function set supported for message content + filtering. + items: + type: string + type: array + MessageContentSchemaLocation: + 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." + items: + type: string + type: array + ProducerPropertiesFilterDialect: + description: Optional ProducerPropertiesDialects. Refer to + items: + type: string + type: array + TopicExpressionDialect: + description: Defines the XPath expression syntax supported for matching + topic expressions. + items: + type: string + type: array + TopicNamespaceLocation: + description: List of topic namespaces supported. + items: + type: string + type: array + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - description: Set of topics supported. + required: + - TopicNamespaceLocation + - FixedTopicSet + - TopicSet + - TopicExpressionDialect + - MessageContentFilterDialect + - MessageContentSchemaLocation + type: object + event_GetServiceCapabilities: + type: object + event_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/event_Capabilities' + - description: The capabilities for the event service is returned in the + Capabilities element. + required: + - Capabilities + type: object + event_PullMessages: + properties: + MessageLimit: + description: Upper limit for the number of messages to return at once. A + server implementation may decide to return less messages. + format: int32 + type: integer + Timeout: + description: Maximum time to block until this method returns. + format: date-time + type: string + required: + - Timeout + - MessageLimit + type: object + event_PullMessagesFaultResponse: + properties: + MaxMessageLimit: + description: Maximum message limit supported by the device. + format: int32 + type: integer + MaxTimeout: + description: Maximum timeout supported by the device. + format: date-time + type: string + required: + - MaxTimeout + - MaxMessageLimit + type: object + event_PullMessagesResponse: + properties: + CurrentTime: + description: The date and time when the messages have been delivered by + the web server to the client. + format: date-time + type: string + NotificationMessage: + description: List of messages. This list shall be empty in case of a timeout. + items: + $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' + type: array + TerminationTime: + description: Date time when the PullPoint will be shut down without further + pull requests. + format: date-time + type: string + required: + - CurrentTime + - TerminationTime + type: object + event_Seek: + properties: + Reverse: + description: Reverse the pull direction of PullMessages. + type: boolean + UtcTime: + description: The date and time to match against stored messages. + format: date-time + type: string + required: + - UtcTime + type: object + event_SeekResponse: + type: object + event_SetSynchronizationPoint: + type: object + event_SetSynchronizationPointResponse: + type: object + event_SubscriptionPolicy: + description: Refer to + type: object + wsrf-r_ResourceUnavailableFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + wsrf-r_ResourceUnknownFaultType: + allOf: + - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' + - type: object + imaging_Capabilities: + properties: + AdaptablePreset: + description: Indicates whether or not imaging preset settings can be updated. + type: boolean + ImageStabilization: + 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." + type: boolean + Presets: + description: Indicates whether or not Imaging Presets feature is supported. + type: boolean + type: object + imaging_GetCurrentPreset: + properties: + VideoSourceToken: + description: Reference token to the VideoSource where the current Imaging + Preset should be requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_GetCurrentPresetResponse: + properties: + Preset: + allOf: + - $ref: '#/components/schemas/imaging_ImagingPreset' + - description: Current Imaging Preset in use for the specified Video Source. + type: object + imaging_GetImagingSettings: + properties: + VideoSourceToken: + description: Reference token to the VideoSource for which the ImagingSettings. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_GetImagingSettingsResponse: + properties: + ImagingSettings: + allOf: + - $ref: '#/components/schemas/onvif_ImagingSettings20' + - description: ImagingSettings for the VideoSource that was requested. + required: + - ImagingSettings + type: object + imaging_GetMoveOptions: + properties: + VideoSourceToken: + description: Reference token to the VideoSource for the requested move options. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_GetMoveOptionsResponse: + properties: + MoveOptions: + allOf: + - $ref: '#/components/schemas/onvif_MoveOptions20' + - description: Valid ranges for the focus lens move options. + required: + - MoveOptions + type: object + imaging_GetOptions: + properties: + VideoSourceToken: + description: Reference token to the VideoSource for which the imaging parameter + options are requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_GetOptionsResponse: + properties: + ImagingOptions: + allOf: + - $ref: '#/components/schemas/onvif_ImagingOptions20' + - description: Valid ranges for the imaging parameters that are categorized + as device specific. + required: + - ImagingOptions + type: object + imaging_GetPresets: + properties: + VideoSourceToken: + description: A reference to the VideoSource where the operation should take + place. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_GetPresetsResponse: + properties: + Preset: + description: List of Imaging Presets which are available for the requested + VideoSource. + items: + $ref: '#/components/schemas/imaging_ImagingPreset' + type: array + required: + - Preset + type: object + imaging_GetServiceCapabilities: + type: object + imaging_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/imaging_Capabilities' + - description: The capabilities for the imaging service is returned in the + Capabilities element. + required: + - Capabilities + type: object + imaging_GetStatus: + properties: + VideoSourceToken: + description: Reference token to the VideoSource where the imaging status + should be requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_GetStatusResponse: + properties: + Status: + allOf: + - $ref: '#/components/schemas/onvif_ImagingStatus20' + - description: Requested imaging status. + required: + - Status + type: object + imaging_ImagingPreset: + description: Type describing the Imaging Preset settings. + properties: + Name: + description: Human readable name of the Imaging Preset. + maxLength: 64 + type: string + token: + description: Unique identifier of this Imaging Preset. + maxLength: 64 + type: string + type: + description: "Indicates Imaging Preset Type. Use timg:ImagingPresetType.\ + \ \n\t\t\t\t\t\tUsed for multi-language support and display." + type: string + required: + - token + - type + - Name + type: object + imaging_ImagingPresetType: + description: "Describes standard Imaging Preset types, used to facilitate Multi-language\ + \ support and client display.\n\t\t\t\t\t\"Custom\" Type shall be used when\ + \ Imaging Preset Name does not match any of the types included in the standard\ + \ classification." + enum: + - Custom + - ClearWeather + - Cloudy + - Fog + - Rain + - Snowing + - Snow + - WDR + - Shade + - Night + - Indoor + - Fluorescent + - Incandescent + - Sodium(Natrium) + - Sunrise(Horizon) + - Sunset(Rear) + - ExtremeHot + - ExtremeCold + - Underwater + - CloseUp + - Motion + - FlickerFree50 + - FlickerFree60 + type: string + imaging_Move: + properties: + Focus: + allOf: + - $ref: '#/components/schemas/onvif_FocusMove' + - description: Content of the requested move (focus) operation. + VideoSourceToken: + description: Reference to the VideoSource for the requested move (focus) + operation. + maxLength: 64 + type: string + required: + - VideoSourceToken + - Focus + type: object + imaging_MoveResponse: + type: object + imaging_SetCurrentPreset: + properties: + PresetToken: + description: Reference token to the Imaging Preset to be applied to the + specified Video Source. + maxLength: 64 + type: string + VideoSourceToken: + description: Reference token to the VideoSource to which the specified Imaging + Preset should be applied. + maxLength: 64 + type: string + required: + - VideoSourceToken + - PresetToken + type: object + imaging_SetCurrentPresetResponse: + type: object + imaging_SetImagingSettings: + properties: + ForcePersistence: + type: boolean + ImagingSettings: + $ref: '#/components/schemas/onvif_ImagingSettings20' + VideoSourceToken: + maxLength: 64 + type: string + required: + - VideoSourceToken + - ImagingSettings + type: object + imaging_SetImagingSettingsResponse: + type: object + imaging_Stop: + properties: + VideoSourceToken: + description: Reference token to the VideoSource where the focus movement + should be stopped. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + imaging_StopResponse: + type: object + media_AddAudioDecoderConfiguration: + properties: + ConfigurationToken: + description: This element contains a reference to the AudioDecoderConfiguration + to add. + maxLength: 64 + type: string + ProfileToken: + description: This element contains a reference to the profile where the + configuration should be added. + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddAudioDecoderConfigurationResponse: + type: object + media_AddAudioEncoderConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the AudioEncoderConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddAudioEncoderConfigurationResponse: + type: object + media_AddAudioOutputConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the AudioOutputConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddAudioOutputConfigurationResponse: + type: object + media_AddAudioSourceConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the AudioSourceConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddAudioSourceConfigurationResponse: + type: object + media_AddMetadataConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the MetadataConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddMetadataConfigurationResponse: + type: object + media_AddPTZConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the PTZConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddPTZConfigurationResponse: + type: object + media_AddVideoAnalyticsConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the VideoAnalyticsConfiguration to + add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddVideoAnalyticsConfigurationResponse: + type: object + media_AddVideoEncoderConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the VideoEncoderConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddVideoEncoderConfigurationResponse: + type: object + media_AddVideoSourceConfiguration: + properties: + ConfigurationToken: + description: Contains a reference to the VideoSourceConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + - ConfigurationToken + type: object + media_AddVideoSourceConfigurationResponse: + type: object + media_Capabilities: + properties: + EXICompression: + description: Indicates the support for the Efficient XML Interchange (EXI) + binary XML format. + type: boolean + OSD: + description: Indicates if OSD is supported. + type: boolean + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/media_ProfileCapabilities' + - description: Media profile capabilities. + Rotation: + description: Indicates whether or not Rotation feature is supported. + type: boolean + SnapshotUri: + description: Indicates if GetSnapshotUri is supported. + type: boolean + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/media_StreamingCapabilities' + - description: Streaming capabilities. + TemporaryOSDText: + description: Indicates the support for temporary osd text configuration. + type: boolean + VideoSourceMode: + description: Indicates the support for changing video source mode. + type: boolean + required: + - ProfileCapabilities + - StreamingCapabilities + type: object + media_CreateOSD: + properties: + OSD: + allOf: + - $ref: '#/components/schemas/onvif_OSDConfiguration' + - description: Contain the initial OSD configuration for create. + required: + - OSD + type: object + media_CreateOSDResponse: + properties: + OSDToken: + description: Returns Token of the newly created OSD + maxLength: 64 + type: string + required: + - OSDToken + type: object + media_CreateProfile: + properties: + Name: + description: friendly name of the profile to be created + maxLength: 64 + type: string + Token: + description: Optional token, specifying the unique identifier of the new + profile. + maxLength: 64 + type: string + required: + - Name + type: object + media_CreateProfileResponse: + properties: + Profile: + allOf: + - $ref: '#/components/schemas/onvif_Profile' + - description: returns the new created profile + required: + - Profile + type: object + media_DeleteOSD: + properties: + OSDToken: + description: This element contains a reference to the OSD configuration + that should be deleted. + maxLength: 64 + type: string + required: + - OSDToken + type: object + media_DeleteOSDResponse: + type: object + media_DeleteProfile: + properties: + ProfileToken: + description: This element contains a reference to the profile that should + be deleted. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_DeleteProfileResponse: + type: object + media_GetAudioDecoderConfiguration: + properties: + ConfigurationToken: + description: Token of the requested audio decoder configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetAudioDecoderConfigurationOptions: + properties: + ConfigurationToken: + description: Optional audio decoder configuration token that specifies an + existing configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetAudioDecoderConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfigurationOptions' + - 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. + required: + - Options + type: object + media_GetAudioDecoderConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + - description: The requested audio decoder configuration + required: + - Configuration + type: object + media_GetAudioDecoderConfigurations: + type: object + media_GetAudioDecoderConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio decoder configurations + items: + $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + type: array + type: object + media_GetAudioEncoderConfiguration: + properties: + ConfigurationToken: + description: Token of the requested audio encoder configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetAudioEncoderConfigurationOptions: + properties: + ConfigurationToken: + description: Optional audio encoder configuration token that specifies an + existing configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetAudioEncoderConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfigurationOptions' + - 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. + required: + - Options + type: object + media_GetAudioEncoderConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + - description: The requested audio encoder configuration + required: + - Configuration + type: object + media_GetAudioEncoderConfigurations: + type: object + media_GetAudioEncoderConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio encoder configurations. + items: + $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + type: array + type: object + media_GetAudioOutputConfiguration: + properties: + ConfigurationToken: + description: Token of the requested audio output configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetAudioOutputConfigurationOptions: + properties: + ConfigurationToken: + description: Optional audio output configuration token that specifies an + existing configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetAudioOutputConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfigurationOptions' + - 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. + required: + - Options + type: object + media_GetAudioOutputConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + - description: The requested audio output configuration. + required: + - Configuration + type: object + media_GetAudioOutputConfigurations: + type: object + media_GetAudioOutputConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio output configurations + items: + $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + type: array + type: object + media_GetAudioOutputs: + type: object + media_GetAudioOutputsResponse: + properties: + AudioOutputs: + description: List of existing Audio Outputs + items: + $ref: '#/components/schemas/onvif_AudioOutput' + type: array + type: object + media_GetAudioSourceConfiguration: + properties: + ConfigurationToken: + description: Token of the requested audio source configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetAudioSourceConfigurationOptions: + properties: + ConfigurationToken: + description: Optional audio source configuration token that specifies an + existing configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetAudioSourceConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfigurationOptions' + - 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. + required: + - Options + type: object + media_GetAudioSourceConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: The requested audio source configuration. + required: + - Configuration + type: object + media_GetAudioSourceConfigurations: + type: object + media_GetAudioSourceConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio source configurations. + items: + $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + type: array + type: object + media_GetAudioSources: + type: object + media_GetAudioSourcesResponse: + properties: + AudioSources: + description: List of existing Audio Sources + items: + $ref: '#/components/schemas/onvif_AudioSource' + type: array + type: object + media_GetCompatibleAudioDecoderConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleAudioDecoderConfigurationsResponse: + properties: + Configurations: + description: Contains a list of audio decoder configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + type: array + type: object + media_GetCompatibleAudioEncoderConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleAudioEncoderConfigurationsResponse: + properties: + Configurations: + description: Contains a list of audio encoder configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + type: array + type: object + media_GetCompatibleAudioOutputConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleAudioOutputConfigurationsResponse: + properties: + Configurations: + description: Contains a list of audio output configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + type: array + type: object + media_GetCompatibleAudioSourceConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleAudioSourceConfigurationsResponse: + properties: + Configurations: + description: Contains a list of audio source configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + type: array + type: object + media_GetCompatibleMetadataConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleMetadataConfigurationsResponse: + properties: + Configurations: + description: Contains a list of metadata configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_MetadataConfiguration' + type: array + type: object + media_GetCompatibleVideoAnalyticsConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleVideoAnalyticsConfigurationsResponse: + properties: + Configurations: + description: Contains a list of video analytics configurations that are + compatible with the specified media profile. + items: + $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + type: array + type: object + media_GetCompatibleVideoEncoderConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleVideoEncoderConfigurationsResponse: + properties: + Configurations: + description: Contains a list of video encoder configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + type: array + type: object + media_GetCompatibleVideoSourceConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetCompatibleVideoSourceConfigurationsResponse: + properties: + Configurations: + description: Contains a list of video source configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + type: array + type: object + media_GetGuaranteedNumberOfVideoEncoderInstances: + properties: + ConfigurationToken: + description: Token of the video source configuration + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetGuaranteedNumberOfVideoEncoderInstancesResponse: + properties: + H264: + 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. + format: int32 + type: integer + JPEG: + 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. + format: int32 + type: integer + MPEG4: + 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. + format: int32 + type: integer + TotalNumber: + description: The minimum guaranteed total number of encoder instances (applications) + per VideoSourceConfiguration. The device is able to deliver the TotalNumber + of streams + format: int32 + type: integer + required: + - TotalNumber + type: object + media_GetMetadataConfiguration: + properties: + ConfigurationToken: + description: Token of the requested metadata configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetMetadataConfigurationOptions: + properties: + ConfigurationToken: + description: Optional metadata configuration token that specifies an existing + configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetMetadataConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfigurationOptions' + - 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. + required: + - Options + type: object + media_GetMetadataConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: The requested metadata configuration. + required: + - Configuration + type: object + media_GetMetadataConfigurations: + type: object + media_GetMetadataConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of metadata configurations + items: + $ref: '#/components/schemas/onvif_MetadataConfiguration' + type: array + type: object + media_GetOSD: + properties: + OSDToken: + description: The GetOSD command fetches the OSD configuration if the OSD + token is known. + maxLength: 64 + type: string + required: + - OSDToken + type: object + media_GetOSDOptions: + properties: + ConfigurationToken: + description: Video Source Configuration Token that specifies an existing + video source configuration that the options shall be compatible with. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetOSDOptionsResponse: + properties: + OSDOptions: + $ref: '#/components/schemas/onvif_OSDConfigurationOptions' + required: + - OSDOptions + type: object + media_GetOSDResponse: + properties: + OSD: + allOf: + - $ref: '#/components/schemas/onvif_OSDConfiguration' + - description: The requested OSD configuration. + required: + - OSD + type: object + media_GetOSDs: + properties: + ConfigurationToken: + description: Token of the Video Source Configuration, which has OSDs associated + with are requested. If token not exist, request all available OSDs. + maxLength: 64 + type: string + type: object + media_GetOSDsResponse: + properties: + OSDs: + description: This element contains a list of requested OSDs. + items: + $ref: '#/components/schemas/onvif_OSDConfiguration' + type: array + type: object + media_GetProfile: + properties: + ProfileToken: + description: this command requests a specific profile + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetProfileResponse: + properties: + Profile: + allOf: + - $ref: '#/components/schemas/onvif_Profile' + - description: returns the requested media profile + required: + - Profile + type: object + media_GetProfiles: + type: object + media_GetProfilesResponse: + properties: + Profiles: + description: lists all profiles that exist in the media service + items: + $ref: '#/components/schemas/onvif_Profile' + type: array + type: object + media_GetServiceCapabilities: + type: object + media_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/media_Capabilities' + - description: The capabilities for the media service is returned in the + Capabilities element. + required: + - Capabilities + type: object + media_GetSnapshotUri: + properties: + ProfileToken: + description: The ProfileToken element indicates the media profile to use + and will define the source and dimensions of the snapshot. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_GetSnapshotUriResponse: + properties: + MediaUri: + $ref: '#/components/schemas/onvif_MediaUri' + required: + - MediaUri + type: object + media_GetStreamUri: + properties: + ProfileToken: + description: The ProfileToken element indicates the media profile to use + and will define the configuration of the content of the stream. + maxLength: 64 + type: string + StreamSetup: + allOf: + - $ref: '#/components/schemas/onvif_StreamSetup' + - description: Stream Setup that should be used with the uri + required: + - StreamSetup + - ProfileToken + type: object + media_GetStreamUriResponse: + properties: + MediaUri: + $ref: '#/components/schemas/onvif_MediaUri' + required: + - MediaUri + type: object + media_GetVideoAnalyticsConfiguration: + properties: + ConfigurationToken: + description: Token of the requested video analytics configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetVideoAnalyticsConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + - description: The requested video analytics configuration. + required: + - Configuration + type: object + media_GetVideoAnalyticsConfigurations: + type: object + media_GetVideoAnalyticsConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of VideoAnalytics configurations. + items: + $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + type: array + type: object + media_GetVideoEncoderConfiguration: + properties: + ConfigurationToken: + description: Token of the requested video encoder configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetVideoEncoderConfigurationOptions: + properties: + ConfigurationToken: + description: Optional video encoder configuration token that specifies an + existing configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetVideoEncoderConfigurationOptionsResponse: + properties: + Options: + $ref: '#/components/schemas/onvif_VideoEncoderConfigurationOptions' + required: + - Options + type: object + media_GetVideoEncoderConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + - description: The requested video encoder configuration. + required: + - Configuration + type: object + media_GetVideoEncoderConfigurations: + type: object + media_GetVideoEncoderConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of video encoder configurations. + items: + $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + type: array + type: object + media_GetVideoSourceConfiguration: + properties: + ConfigurationToken: + description: Token of the requested video source configuration. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media_GetVideoSourceConfigurationOptions: + properties: + ConfigurationToken: + description: Optional video source configurationToken that specifies an + existing configuration that the options are intended for. + maxLength: 64 + type: string + ProfileToken: + description: Optional ProfileToken that specifies an existing media profile + that the options shall be compatible with. + maxLength: 64 + type: string + type: object + media_GetVideoSourceConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptions' + - 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. + required: + - Options + type: object + media_GetVideoSourceConfigurationResponse: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: The requested video source configuration. + required: + - Configuration + type: object + media_GetVideoSourceConfigurations: + type: object + media_GetVideoSourceConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of video source configurations. + items: + $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + type: array + type: object + media_GetVideoSourceModes: + properties: + VideoSourceToken: + description: Contains a video source reference for which a video source + mode is requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + media_GetVideoSourceModesResponse: + properties: + VideoSourceModes: + description: Return the information for specified video source mode. + items: + $ref: '#/components/schemas/media_VideoSourceMode' + type: array + required: + - VideoSourceModes + type: object + media_GetVideoSources: + type: object + media_GetVideoSourcesResponse: + properties: + VideoSources: + description: List of existing Video Sources + items: + $ref: '#/components/schemas/onvif_VideoSource' + type: array + type: object + media_ProfileCapabilities: + properties: + MaximumNumberOfProfiles: + description: Maximum number of profiles supported. + format: int32 + type: integer + type: object + media_RemoveAudioDecoderConfiguration: + properties: + ProfileToken: + description: This element contains a reference to the media profile from + which the AudioDecoderConfiguration shall be removed. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveAudioDecoderConfigurationResponse: + type: object + media_RemoveAudioEncoderConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + AudioEncoderConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveAudioEncoderConfigurationResponse: + type: object + media_RemoveAudioOutputConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + AudioOutputConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveAudioOutputConfigurationResponse: + type: object + media_RemoveAudioSourceConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + AudioSourceConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveAudioSourceConfigurationResponse: + type: object + media_RemoveMetadataConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + MetadataConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveMetadataConfigurationResponse: + type: object + media_RemovePTZConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + PTZConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemovePTZConfigurationResponse: + type: object + media_RemoveVideoAnalyticsConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + VideoAnalyticsConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveVideoAnalyticsConfigurationResponse: + type: object + media_RemoveVideoEncoderConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + VideoEncoderConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveVideoEncoderConfigurationResponse: + type: object + media_RemoveVideoSourceConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + VideoSourceConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_RemoveVideoSourceConfigurationResponse: + type: object + media_SetAudioDecoderConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + - description: Contains the modified audio decoder configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetAudioDecoderConfigurationResponse: + type: object + media_SetAudioEncoderConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + - description: Contains the modified audio encoder configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetAudioEncoderConfigurationResponse: + type: object + media_SetAudioOutputConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + - description: Contains the modified audio output configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetAudioOutputConfigurationResponse: + type: object + media_SetAudioSourceConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: Contains the modified audio source configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetAudioSourceConfigurationResponse: + type: object + media_SetMetadataConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Contains the modified metadata configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetMetadataConfigurationResponse: + type: object + media_SetOSD: + properties: + OSD: + allOf: + - $ref: '#/components/schemas/onvif_OSDConfiguration' + - description: Contains the modified OSD configuration. + required: + - OSD + type: object + media_SetOSDResponse: + type: object + media_SetSynchronizationPoint: + properties: + ProfileToken: + description: Contains a Profile reference for which a Synchronization Point + is requested. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_SetSynchronizationPointResponse: + type: object + media_SetVideoAnalyticsConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + - description: Contains the modified video analytics configuration. The + configuration shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetVideoAnalyticsConfigurationResponse: + type: object + media_SetVideoEncoderConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + - description: Contains the modified video encoder configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetVideoEncoderConfigurationResponse: + type: object + media_SetVideoSourceConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: Contains the modified video source configuration. The configuration + shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean + required: + - Configuration + - ForcePersistence + type: object + media_SetVideoSourceConfigurationResponse: + type: object + media_SetVideoSourceMode: + properties: + VideoSourceModeToken: + description: Indicate video source mode. + maxLength: 64 + type: string + VideoSourceToken: + description: Contains a video source reference for which a video source + mode is requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + - VideoSourceModeToken + type: object + media_SetVideoSourceModeResponse: + properties: + Reboot: + description: The response contains information about rebooting after returning + response. When Reboot is set true, a device will reboot automatically + after setting mode. + type: boolean + required: + - Reboot + type: object + media_StartMulticastStreaming: + properties: + ProfileToken: + description: Contains the token of the Profile that is used to define the + multicast stream. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_StartMulticastStreamingResponse: + type: object + media_StopMulticastStreaming: + properties: + ProfileToken: + description: Contains the token of the Profile that is used to define the + multicast stream. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media_StopMulticastStreamingResponse: + type: object + media_StreamingCapabilities: + properties: + NoRTSPStreaming: + description: Indicates the device does not support live media streaming + via RTSP. + type: boolean + NonAggregateControl: + description: Indicates support for non aggregate RTSP control. + type: boolean + RTPMulticast: + description: Indicates support for RTP multicast. + type: boolean + RTP_RTSP_TCP: + description: Indicates support for RTP/RTSP/TCP. + type: boolean + RTP_TCP: + description: Indicates support for RTP over TCP. + type: boolean + type: object + media_VideoSourceMode: + properties: + Description: + description: Informative description of this video source mode. This field + should be described in English. + type: string + Enabled: + 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. + type: boolean + Encodings: + description: Indication which encodings are supported for this video source. + The list may contain one or more enumeration values of tt:VideoEncoding. + items: + type: string + type: array + Extension: + $ref: '#/components/schemas/media_VideoSourceModeExtension' + MaxFramerate: + description: Max frame rate in frames per second for this video source mode. + type: number + MaxResolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution' + - description: Max horizontal and vertical resolution for this video source + mode. + Reboot: + 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. + type: boolean + token: + description: Indicate token for video source mode. + maxLength: 64 + type: string + required: + - token + - MaxFramerate + - MaxResolution + - Encodings + - Reboot + type: object + media_VideoSourceModeExtension: + type: object + media2_AddConfiguration: + properties: + Configuration: + 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. + items: + $ref: '#/components/schemas/media2_ConfigurationRef' + type: array + Name: + description: Optional item. If present updates the Name property of the + profile. + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media2_AddConfigurationResponse: + type: object + media2_Capabilities2: + properties: + Mask: + description: Indicates if Masking is supported. + type: boolean + OSD: + description: Indicates if OSD is supported. + type: boolean + ProfileCapabilities: + allOf: + - $ref: '#/components/schemas/media2_ProfileCapabilities' + - description: Media profile capabilities. + Rotation: + description: Indicates whether or not Rotation feature is supported. + type: boolean + SnapshotUri: + description: Indicates if GetSnapshotUri is supported. + type: boolean + SourceMask: + 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." + type: boolean + StreamingCapabilities: + allOf: + - $ref: '#/components/schemas/media2_StreamingCapabilities' + - description: Streaming capabilities. + TemporaryOSDText: + description: Indicates the support for temporary osd text configuration. + type: boolean + VideoSourceMode: + description: Indicates the support for changing video source mode. + type: boolean + required: + - ProfileCapabilities + - StreamingCapabilities + type: object + media2_ConfigurationEnumeration: + enum: + - All + - VideoSource + - VideoEncoder + - AudioSource + - AudioEncoder + - AudioOutput + - AudioDecoder + - Metadata + - Analytics + - PTZ + - Receiver + type: string + media2_ConfigurationRef: + properties: + Token: + 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." + maxLength: 64 + type: string + Type: + description: Type of the configuration as defined by tr2:ConfigurationEnumeration. + type: string + required: + - Type + type: object + media2_ConfigurationSet: + description: A set of media configurations. + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + - description: Optional configuration of the analytics module and rule engine. + AudioDecoder: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + AudioEncoder: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' + - description: Optional configuration of the Audio encoder. + AudioOutput: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + AudioSource: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + Metadata: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + PTZ: + allOf: + - $ref: '#/components/schemas/onvif_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + Receiver: + allOf: + - $ref: '#/components/schemas/media2_ReceiverConfiguration' + - description: Optional configuration of the Receiver. + VideoEncoder: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' + - description: Optional configuration of the Video encoder. + VideoSource: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + type: object + media2_CreateMask: + properties: + Mask: + allOf: + - $ref: '#/components/schemas/media2_Mask' + - description: Contain the initial mask configuration for create. + required: + - Mask + type: object + media2_CreateMaskResponse: + properties: + Token: + description: Returns Token of the newly created Mask + maxLength: 64 + type: string + required: + - Token + type: object + media2_CreateOSD: + properties: + OSD: + allOf: + - $ref: '#/components/schemas/onvif_OSDConfiguration' + - description: Contain the initial OSD configuration for create. + required: + - OSD + type: object + media2_CreateOSDResponse: + properties: + OSDToken: + description: Returns Token of the newly created OSD + maxLength: 64 + type: string + required: + - OSDToken + type: object + media2_CreateProfile: + properties: + Configuration: + description: Optional set of configurations to be assigned to the profile. + List entries with tr2:ConfigurationEnumeration value "All" shall be ignored. + items: + $ref: '#/components/schemas/media2_ConfigurationRef' + type: array + Name: + description: friendly name of the profile to be created + maxLength: 64 + type: string + required: + - Name + type: object + media2_CreateProfileResponse: + properties: + Token: + description: Token assigned by the device for the newly created profile. + maxLength: 64 + type: string + required: + - Token + type: object + media2_DeleteMask: + properties: + Token: + description: This element contains a reference to the Mask configuration + that should be deleted. + maxLength: 64 + type: string + required: + - Token + type: object + media2_DeleteOSD: + properties: + OSDToken: + description: This element contains a reference to the OSD configuration + that should be deleted. + maxLength: 64 + type: string + required: + - OSDToken + type: object + media2_DeleteProfile: + properties: + Token: + description: This element contains a reference to the profile that should + be deleted. + maxLength: 64 + type: string + required: + - Token + type: object + media2_DeleteProfileResponse: + type: object + media2_EncoderInstance: + properties: + Encoding: + description: Video Media Subtype for the video format. For definitions see + tt:VideoEncodingMimeNames and + type: string + Number: + description: The minimum guaranteed number of encoder instances (applications) + for the VideoSourceConfiguration. + format: int32 + type: integer + required: + - Encoding + - Number + type: object + media2_EncoderInstanceInfo: + properties: + Codec: + 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. + items: + $ref: '#/components/schemas/media2_EncoderInstance' + type: array + Total: + description: The minimum guaranteed total number of encoder instances (applications) + per VideoSourceConfiguration. The device is able to deliver the Total + number of streams + format: int32 + type: integer + required: + - Total + type: object + media2_GetAnalyticsConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of Analytics configurations. + items: + $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + type: array + type: object + media2_GetAudioDecoderConfigurationOptionsResponse: + properties: + Options: + 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. + items: + $ref: '#/components/schemas/onvif_AudioEncoder2ConfigurationOptions' + type: array + required: + - Options + type: object + media2_GetAudioDecoderConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio decoder configurations + items: + $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + type: array + type: object + media2_GetAudioEncoderConfigurationOptionsResponse: + properties: + Options: + 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. + items: + $ref: '#/components/schemas/onvif_AudioEncoder2ConfigurationOptions' + type: array + required: + - Options + type: object + media2_GetAudioEncoderConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio encoder configurations. + items: + $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' + type: array + type: object + media2_GetAudioOutputConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfigurationOptions' + - 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. + required: + - Options + type: object + media2_GetAudioOutputConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio output configurations + items: + $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + type: array + type: object + media2_GetAudioSourceConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfigurationOptions' + - 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. + required: + - Options + type: object + media2_GetAudioSourceConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of audio source configurations. + items: + $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + type: array + type: object + media2_GetConfiguration: + properties: + ConfigurationToken: + description: Token of the requested configuration. + maxLength: 64 + type: string + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + type: object + media2_GetMaskOptions: + properties: + ConfigurationToken: + description: Video Source Configuration Token that specifies an existing + video source configuration that the options shall be compatible with. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media2_GetMaskOptionsResponse: + properties: + Options: + $ref: '#/components/schemas/media2_MaskOptions' + required: + - Options + type: object + media2_GetMasks: + properties: + ConfigurationToken: + description: Optional token of a Video Source Configuration. + maxLength: 64 + type: string + Token: + description: Optional mask token of an existing mask. + maxLength: 64 + type: string + type: object + media2_GetMasksResponse: + properties: + Masks: + description: List of Mask configurations. + items: + $ref: '#/components/schemas/media2_Mask' + type: array + type: object + media2_GetMetadataConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfigurationOptions' + - 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. + required: + - Options + type: object + media2_GetMetadataConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of metadata configurations + items: + $ref: '#/components/schemas/onvif_MetadataConfiguration' + type: array + type: object + media2_GetOSDOptions: + properties: + ConfigurationToken: + description: Video Source Configuration Token that specifies an existing + video source configuration that the options shall be compatible with. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media2_GetOSDOptionsResponse: + properties: + OSDOptions: + $ref: '#/components/schemas/onvif_OSDConfigurationOptions' + required: + - OSDOptions + type: object + media2_GetOSDs: + properties: + ConfigurationToken: + description: Token of the Video Source Configuration, which has OSDs associated + with are requested. If token not exist, request all available OSDs. + maxLength: 64 + type: string + OSDToken: + description: The GetOSDs command fetches the OSD configuration if the OSD + token is known. + maxLength: 64 + type: string + type: object + media2_GetOSDsResponse: + properties: + OSDs: + description: This element contains a list of requested OSDs. + items: + $ref: '#/components/schemas/onvif_OSDConfiguration' + type: array + type: object + media2_GetProfiles: + properties: + Token: + description: Optional token of the requested profile. + maxLength: 64 + type: string + Type: + description: The types shall be provided as defined by tr2:ConfigurationEnumeration. + items: + type: string + type: array + type: object + media2_GetProfilesResponse: + properties: + Profiles: + 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." + items: + $ref: '#/components/schemas/media2_MediaProfile' + type: array + type: object + media2_GetServiceCapabilities: + type: object + media2_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/media2_Capabilities2' + - description: The capabilities for the media service is returned in the + Capabilities element. + required: + - Capabilities + type: object + media2_GetSnapshotUri: + properties: + ProfileToken: + description: The ProfileToken element indicates the media profile to use + and will define the source and dimensions of the snapshot. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media2_GetSnapshotUriResponse: + properties: + Uri: + description: Stable Uri to be used for requesting snapshot images. + type: string + required: + - Uri + type: object + media2_GetStreamUri: + properties: + ProfileToken: + description: The ProfileToken element indicates the media profile to use + and will define the configuration of the content of the stream. + maxLength: 64 + type: string + Protocol: + description: Defines the network protocol for streaming as defined by tr2:TransportProtocol + type: string + required: + - Protocol + - ProfileToken + type: object + media2_GetStreamUriResponse: + properties: + Uri: + description: Stable Uri to be used for requesting the media stream + type: string + required: + - Uri + type: object + media2_GetVideoEncoderConfigurationOptionsResponse: + properties: + Options: + items: + $ref: '#/components/schemas/onvif_VideoEncoder2ConfigurationOptions' + type: array + required: + - Options + type: object + media2_GetVideoEncoderConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of video encoder configurations. + items: + $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' + type: array + type: object + media2_GetVideoEncoderInstances: + properties: + ConfigurationToken: + description: Token of the video source configuration + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + media2_GetVideoEncoderInstancesResponse: + properties: + Info: + allOf: + - $ref: '#/components/schemas/media2_EncoderInstanceInfo' + - description: The minimum guaranteed total number of encoder instances + (applications) per VideoSourceConfiguration. + required: + - Info + type: object + media2_GetVideoSourceConfigurationOptionsResponse: + properties: + Options: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptions' + - 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. + required: + - Options + type: object + media2_GetVideoSourceConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of video source configurations. + items: + $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + type: array + type: object + media2_GetVideoSourceModes: + properties: + VideoSourceToken: + description: Contains a video source reference for which a video source + mode is requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + type: object + media2_GetVideoSourceModesResponse: + properties: + VideoSourceModes: + description: Return the information for specified video source mode. + items: + $ref: '#/components/schemas/media2_VideoSourceMode' + type: array + required: + - VideoSourceModes + type: object + media2_Mask: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_Color' + - description: Color of the masked area. + ConfigurationToken: + description: Token of the VideoSourceConfiguration the Mask is associated + with. + maxLength: 64 + type: string + Enabled: + description: If set the mask will cover the image, otherwise it will be + fully transparent. + type: boolean + Polygon: + allOf: + - $ref: '#/components/schemas/onvif_Polygon' + - description: Geometric representation of the mask area. + Type: + description: 'Type of masking as defined by tr2:MaskType:' + type: string + token: + description: Token of the mask. + maxLength: 64 + type: string + required: + - ConfigurationToken + - Polygon + - Type + - Enabled + type: object + media2_MaskOptions: + properties: + Color: + allOf: + - $ref: '#/components/schemas/onvif_ColorOptions' + - description: Colors supported. + MaxMasks: + description: Maximum supported number of masks per VideoSourceConfiguration. + format: int32 + type: integer + MaxPoints: + description: Maximum supported number of points per mask. + format: int32 + type: integer + RectangleOnly: + description: Information whether the polygon must have four points and a + rectangular shape. + type: boolean + SingleColorOnly: + 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. + type: boolean + Types: + description: Information which types of tr2:MaskType are supported. Valid + values are 'Color', 'Pixelated' and 'Blurred'. + items: + type: string + type: array + required: + - MaxMasks + - MaxPoints + - Types + - Color + type: object + media2_MaskType: + enum: + - Color + - Pixelated + - Blurred + type: string + media2_MediaProfile: + description: A media profile consists of a set of media configurations. + properties: + Configurations: + allOf: + - $ref: '#/components/schemas/media2_ConfigurationSet' + - description: The configurations assigned to the profile. + Name: + description: User readable name of the profile. + maxLength: 64 + type: string + fixed: + description: A value of true signals that the profile cannot be deleted. + Default is false. + type: boolean + token: + description: Unique identifier of the profile. + maxLength: 64 + type: string + required: + - token + - Name + type: object + media2_ProfileCapabilities: + properties: + ConfigurationsSupported: + description: The configurations supported by the device as defined by tr2:ConfigurationEnumeration. + The enumeration value "All" shall not be included in this list. + type: string + MaximumNumberOfProfiles: + description: Maximum number of profiles supported. + format: int32 + type: integer + type: object + media2_ReceiverConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ReceiverConfiguration' + - properties: + token: + maxLength: 64 type: string - requestBody: - content: - application/json: - schema: - example: - UnsubscribeCameraEvent: {} - properties: - UnsubscribeCameraEvent: - properties: {} - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 07 Oct 2022 21:56:20 GMT - type: string - X-Correlation-Id: - schema: - example: eaf40875-3176-4457-8c4b-de3282175733 - type: string - summary: UnsubscribeCameraEvent - tags: - - Event Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Users: - get: - 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. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetUsers - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: object + media2_RemoveConfiguration: + properties: + Configuration: + 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. + items: + $ref: '#/components/schemas/media2_ConfigurationRef' + type: array + ProfileToken: + description: This element contains a reference to the media profile from + which the AudioDecoderConfiguration shall be removed. + maxLength: 64 + type: string + required: + - ProfileToken + - Configuration + type: object + media2_RemoveConfigurationResponse: + type: object + media2_SetAudioDecoderConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + - description: Contains the modified audio decoder configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetAudioEncoderConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' + - description: Contains the modified audio encoder configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetAudioOutputConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + - description: Contains the modified audio output configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetAudioSourceConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: Contains the modified audio source configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetConfigurationResponse: + type: object + media2_SetMask: + properties: + Mask: + allOf: + - $ref: '#/components/schemas/media2_Mask' + - description: Mask to be updated. + required: + - Mask + type: object + media2_SetMetadataConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Contains the modified metadata configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetOSD: + properties: + OSD: + allOf: + - $ref: '#/components/schemas/onvif_OSDConfiguration' + - description: Contains the modified OSD configuration. + required: + - OSD + type: object + media2_SetSynchronizationPoint: + properties: + ProfileToken: + description: Contains a Profile reference for which a Synchronization Point + is requested. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media2_SetSynchronizationPointResponse: + type: object + media2_SetVideoEncoderConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' + - description: Contains the modified video encoder configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetVideoSourceConfiguration: + properties: + Configuration: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: Contains the modified video source configuration. The configuration + shall exist in the device. + required: + - Configuration + type: object + media2_SetVideoSourceMode: + properties: + VideoSourceModeToken: + description: Indicate video source mode. + maxLength: 64 + type: string + VideoSourceToken: + description: Contains a video source reference for which a video source + mode is requested. + maxLength: 64 + type: string + required: + - VideoSourceToken + - VideoSourceModeToken + type: object + media2_SetVideoSourceModeResponse: + properties: + Reboot: + description: The response contains information about rebooting after returning + response. When Reboot is set true, a device will reboot automatically + after setting mode. + type: boolean + required: + - Reboot + type: object + media2_StartStopMulticastStreaming: + properties: + ProfileToken: + description: Contains the token of the Profile that is used to define the + multicast stream. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + media2_StreamingCapabilities: + properties: + AutoStartMulticast: + description: Indicates support for non-RTSP controlled multicast streaming. + type: boolean + NonAggregateControl: + description: Indicates support for non aggregate RTSP control. + type: boolean + RTPMulticast: + description: Indicates support for RTP multicast. + type: boolean + RTP_RTSP_TCP: + description: Indicates support for RTP/RTSP/TCP. + type: boolean + RTSPStreaming: + description: Indicates support for live media streaming via RTSP. + type: boolean + RTSPWebSocketUri: + description: If streaming over WebSocket is supported, this shall return + the RTSP WebSocket URI as described in Streaming Specification Section + 5.1.1.5. + type: string + type: object + media2_TransportProtocol: + enum: + - RtspUnicast + - RtspMulticast + - RTSP + - RtspOverHttp + type: string + media2_VideoSourceMode: + properties: + Description: + description: Informative description of this video source mode. This field + should be described in English. + type: string + Enabled: + 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. + type: boolean + Encodings: + description: List of one or more encodings supported for this video source. For + name definitions see tt:VideoEncodingMimeNames, and see + items: type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - id: 8e524ecd-674d-4dd8-b728-de78b8245189 - origin: 1664077238993899500 - profileName: onvif-camera - readings: - - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - id: f5086b88-9876-4627-91d5-7ce39431652e - objectValue: - User: - - UserLevel: Administrator - Username: admin - - UserLevel: User - Username: user - origin: 1664077238993899500 - profileName: onvif-camera - resourceName: Users - value: '' - valueType: Object - sourceName: Users - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - User: - items: - properties: - UserLevel: - type: string - Username: - type: string - required: - - UserLevel - - Username - type: object - type: array - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '609' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Sun, 25 Sep 2022 03:40:38 GMT - type: string - X-Correlation-Id: - schema: - example: 16c7a0fe-a3fc-4b4f-a8e3-110ba2f0325a - type: string - summary: Get users - tags: - - User Handling - put: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetUser - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + type: array + MaxFramerate: + description: Max frame rate in frames per second for this video source mode. + type: number + MaxResolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution' + - description: Max horizontal and vertical resolution for this video source + mode. + Reboot: + 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. + type: boolean + token: + description: Indicate token for video source mode. + maxLength: 64 + type: string + required: + - token + - MaxFramerate + - MaxResolution + - Encodings + - Reboot + type: object + ptz_AbsoluteMove: + properties: + Position: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: A Position vector specifying the absolute target position. + ProfileToken: + description: A reference to the MediaProfile. + maxLength: 64 + type: string + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: An optional Speed. + required: + - ProfileToken + - Position + type: object + ptz_AbsoluteMoveResponse: + type: object + ptz_Capabilities: + properties: + EFlip: + description: Indicates whether or not EFlip is supported. + type: boolean + GetCompatibleConfigurations: + description: Indicates support for the GetCompatibleConfigurations command. + type: boolean + MoveAndTrack: + description: Indication of the methods of MoveAndTrack that are supported, + acceptable values are defined in tt:MoveAndTrackMethod. + type: string + MoveStatus: + description: Indicates that the PTZStatus includes MoveStatus information. + type: boolean + Reverse: + description: Indicates whether or not reversing of PT control direction + is supported. + type: boolean + StatusPosition: + description: Indicates that the PTZStatus includes Position information. + type: boolean + type: object + ptz_ContinuousMove: + properties: + ProfileToken: + description: A reference to the MediaProfile. + maxLength: 64 + type: string + Timeout: + description: An optional Timeout parameter. + format: date-time + type: string + Velocity: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: A Velocity vector specifying the velocity of pan, tilt and + zoom. + required: + - ProfileToken + - Velocity + type: object + ptz_ContinuousMoveResponse: + type: object + ptz_CreatePresetTour: + properties: + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_CreatePresetTourResponse: + properties: + PresetTourToken: + maxLength: 64 + type: string + required: + - PresetTourToken + type: object + ptz_GeoMove: + properties: + AreaHeight: + description: An optional indication of the height of the target/area. + type: number + AreaWidth: + description: An optional indication of the width of the target/area. + type: number + ProfileToken: + description: A reference to the MediaProfile. + maxLength: 64 + type: string + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: An optional Speed. + Target: + allOf: + - $ref: '#/components/schemas/onvif_GeoLocation' + - description: The geolocation of the target position. + required: + - ProfileToken + - Target + type: object + ptz_GeoMoveResponse: + type: object + ptz_GetCompatibleConfigurations: + properties: + ProfileToken: + description: Contains the token of an existing media profile the configurations + shall be compatible with. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_GetCompatibleConfigurationsResponse: + properties: + PTZConfiguration: + description: A list of all existing PTZConfigurations on the NVT that is + suitable to be added to the addressed media profile. + items: + $ref: '#/components/schemas/onvif_PTZConfiguration' + type: array + type: object + ptz_GetConfiguration: + properties: + PTZConfigurationToken: + description: Token of the requested PTZConfiguration. + maxLength: 64 + type: string + required: + - PTZConfigurationToken + type: object + ptz_GetConfigurationOptions: + properties: + ConfigurationToken: + description: Token of an existing configuration that the options are intended + for. + maxLength: 64 + type: string + required: + - ConfigurationToken + type: object + ptz_GetConfigurationOptionsResponse: + properties: + PTZConfigurationOptions: + allOf: + - $ref: '#/components/schemas/onvif_PTZConfigurationOptions' + - description: The requested PTZ configuration options. + required: + - PTZConfigurationOptions + type: object + ptz_GetConfigurationResponse: + properties: + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_PTZConfiguration' + - description: A requested PTZConfiguration. + required: + - PTZConfiguration + type: object + ptz_GetConfigurations: + type: object + ptz_GetConfigurationsResponse: + properties: + PTZConfiguration: + description: A list of all existing PTZConfigurations on the device. + items: + $ref: '#/components/schemas/onvif_PTZConfiguration' + type: array + type: object + ptz_GetNode: + properties: + NodeToken: + description: Token of the requested PTZNode. + maxLength: 64 + type: string + required: + - NodeToken + type: object + ptz_GetNodeResponse: + properties: + PTZNode: + allOf: + - $ref: '#/components/schemas/onvif_PTZNode' + - description: A requested PTZNode. + required: + - PTZNode + type: object + ptz_GetNodes: + type: object + ptz_GetNodesResponse: + properties: + PTZNode: + description: A list of the existing PTZ Nodes on the device. + items: + $ref: '#/components/schemas/onvif_PTZNode' + type: array + type: object + ptz_GetPresetTour: + properties: + PresetTourToken: + maxLength: 64 + type: string + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + - PresetTourToken + type: object + ptz_GetPresetTourOptions: + properties: + PresetTourToken: + maxLength: 64 + type: string + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_GetPresetTourOptionsResponse: + properties: + Options: + $ref: '#/components/schemas/onvif_PTZPresetTourOptions' + required: + - Options + type: object + ptz_GetPresetTourResponse: + properties: + PresetTour: + $ref: '#/components/schemas/onvif_PresetTour' + required: + - PresetTour + type: object + ptz_GetPresetTours: + properties: + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_GetPresetToursResponse: + properties: + PresetTour: + items: + $ref: '#/components/schemas/onvif_PresetTour' + type: array + type: object + ptz_GetPresets: + properties: + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_GetPresetsResponse: + properties: + Preset: + description: A list of presets which are available for the requested MediaProfile. + items: + $ref: '#/components/schemas/onvif_PTZPreset' + type: array + type: object + ptz_GetServiceCapabilities: + type: object + ptz_GetServiceCapabilitiesResponse: + properties: + Capabilities: + allOf: + - $ref: '#/components/schemas/ptz_Capabilities' + - description: The capabilities for the PTZ service is returned in the Capabilities + element. + required: + - Capabilities + type: object + ptz_GetStatus: + properties: + ProfileToken: + description: A reference to the MediaProfile where the PTZStatus should + be requested. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_GetStatusResponse: + properties: + PTZStatus: + allOf: + - $ref: '#/components/schemas/onvif_PTZStatus' + - description: The PTZStatus for the requested MediaProfile. + required: + - PTZStatus + type: object + ptz_GotoHomePosition: + properties: + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: A requested speed.The speed parameter can only be specified + when Speed Spaces are available for the PTZ Node. + required: + - ProfileToken + type: object + ptz_GotoHomePositionResponse: + type: object + ptz_GotoPreset: + properties: + PresetToken: + description: A requested preset token. + maxLength: 64 + type: string + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: A requested speed.The speed parameter can only be specified + when Speed Spaces are available for the PTZ Node. + required: + - ProfileToken + - PresetToken + type: object + ptz_GotoPresetResponse: + type: object + ptz_ModifyPresetTour: + properties: + PresetTour: + $ref: '#/components/schemas/onvif_PresetTour' + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + - PresetTour + type: object + ptz_ModifyPresetTourResponse: + type: object + ptz_MoveAndStartTracking: + properties: + GeoLocation: + allOf: + - $ref: '#/components/schemas/onvif_GeoLocation' + - description: The geolocation of the target position. + ObjectID: + description: Object ID of the object to track. + format: int32 + type: integer + PresetToken: + description: A preset token. + maxLength: 64 + type: string + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: Speed vector specifying the velocity of pan, tilt and zoom. + TargetPosition: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: A Position vector specifying the absolute target position. + required: + - ProfileToken + type: object + ptz_MoveAndStartTrackingResponse: + type: object + ptz_OperatePresetTour: + properties: + Operation: + $ref: '#/components/schemas/onvif_PTZPresetTourOperation' + PresetTourToken: + maxLength: 64 + type: string + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + - PresetTourToken + - Operation + type: object + ptz_OperatePresetTourResponse: + type: object + ptz_RelativeMove: + properties: + ProfileToken: + description: A reference to the MediaProfile. + maxLength: 64 + type: string + Speed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: An optional Speed parameter. + Translation: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - description: A positional Translation relative to the current position + required: + - ProfileToken + - Translation + type: object + ptz_RelativeMoveResponse: + type: object + ptz_RemovePreset: + properties: + PresetToken: + description: A requested preset token. + maxLength: 64 + type: string + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + required: + - ProfileToken + - PresetToken + type: object + ptz_RemovePresetResponse: + type: object + ptz_RemovePresetTour: + properties: + PresetTourToken: + maxLength: 64 + type: string + ProfileToken: + maxLength: 64 + type: string + required: + - ProfileToken + - PresetTourToken + type: object + ptz_RemovePresetTourResponse: + type: object + ptz_SendAuxiliaryCommand: + properties: + AuxiliaryData: + description: The Auxiliary request data. + maxLength: 128 + type: string + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + required: + - ProfileToken + - AuxiliaryData + type: object + ptz_SendAuxiliaryCommandResponse: + properties: + AuxiliaryResponse: + description: The response contains the auxiliary response. + maxLength: 128 + type: string + required: + - AuxiliaryResponse + type: object + ptz_SetConfiguration: + properties: + ForcePersistence: + description: 'Flag that makes configuration persistent. Example: User wants + the configuration to exist after reboot.' + type: boolean + PTZConfiguration: + $ref: '#/components/schemas/onvif_PTZConfiguration' + required: + - PTZConfiguration + - ForcePersistence + type: object + ptz_SetConfigurationResponse: + type: object + ptz_SetHomePosition: + properties: + ProfileToken: + description: A reference to the MediaProfile where the home position should + be set. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_SetHomePositionResponse: + type: object + ptz_SetPreset: + properties: + PresetName: + description: A requested preset name. + type: string + PresetToken: + description: A requested preset token. + maxLength: 64 + type: string + ProfileToken: + description: A reference to the MediaProfile where the operation should + take place. + maxLength: 64 + type: string + required: + - ProfileToken + type: object + ptz_SetPresetResponse: + properties: + PresetToken: + description: A token to the Preset which has been set. + maxLength: 64 + type: string + required: + - PresetToken + type: object + ptz_Stop: + properties: + PanTilt: + description: Set true when we want to stop ongoing pan and tilt movements.If + PanTilt arguments are not present, this command stops these movements. + type: boolean + ProfileToken: + description: A reference to the MediaProfile that indicate what should be + stopped. + maxLength: 64 + type: string + Zoom: + description: Set true when we want to stop ongoing zoom movement.If Zoom + arguments are not present, this command stops ongoing zoom movement. + type: boolean + required: + - ProfileToken + type: object + ptz_StopResponse: + type: object + Event: + description: A discrete event containing one or more readings + properties: + apiVersion: + description: A version number shows the API version in DTOs. + type: string + id: + description: The unique identifier for the event + type: string + format: uuid + deviceName: + description: The name of the device from which the event originated + type: string + profileName: + description: The name of the device profile from which the event originated + type: string + sourceName: + description: The name of the source device resource or command from which + the event originated + type: string + origin: + description: A Unix timestamp indicating when the event was originated at + the source device (can support nanoseconds) + type: integer + readings: + description: One or more readings captured at the time of the event + type: array + items: + $ref: '#/components/schemas/BaseReading' + required: + - apiVersion + - id + - deviceName + - profileName + - sourceName + - origin + - readings + BaseEventResponse: + allOf: + - $ref: '#/components/schemas/BaseResponse' + - properties: + event: + $ref: '#/components/schemas/Event' + description: A response type for returning an Event to the caller. + ObjectEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/ObjectReading' + BinaryEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/BinaryReading' + StringEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/StringReading' + BoolEventResponse: + allOf: + - $ref: '#/components/schemas/BaseEventResponse' + - properties: + event: + properties: + readings: + items: + $ref: '#/components/schemas/BoolReading' + BaseResponse: + description: Defines basic properties which all use-case specific response DTO + instances should support + type: object + properties: + apiVersion: + description: A version number shows the API version in DTOs. + type: string + example: v2 + statusCode: + description: A numeric code signifying the operational status of the response. + type: integer + BaseReading: + description: A base reading type containing common properties from which more + specific reading types inherit. This definition should not be implemented + but is used elsewhere to indicate support for a mixed list of simple/binary + readings in a single event. + type: object + properties: + id: + description: The unique identifier for the reading + type: string + format: uuid + origin: + description: A Unix timestamp indicating when the reading was originated + at the source device (can support nanoseconds) + type: integer + deviceName: + description: The name of the device from which the reading originated + type: string + resourceName: + description: The device resource name for the reading + type: string + profileName: + description: The device profile name for the reading + type: string + valueType: + description: Indicates the datatype of the value property + type: string + enum: + - Bool + - String + - Object + - Binary + required: + - apiVersion + - deviceName + - resourceName + - profileName + - origin + - valueType + BoolReading: + description: An event reading for a bool data type + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + example: Bool + value: + description: A string representation of the reading's value type: string - requestBody: - content: - application/json: - schema: - example: - Users: - User: - - Password: Password1! - UserLevel: Administrator - Username: user1 - - Password: Password1! - UserLevel: Operator - Username: user2 - properties: - Users: - properties: - User: - items: - properties: - Password: - type: string - UserLevel: - type: string - Username: - type: string - required: - - Username - - Password - - UserLevel - type: object - type: array - type: object - type: object - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - statusCode: 200 - schema: - properties: - apiVersion: - type: string - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '37' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Sun, 25 Sep 2022 03:40:53 GMT - type: string - X-Correlation-Id: - schema: - example: bc42d5ca-4132-47e5-b159-98ca2aa1cdb8 - type: string - summary: Set users - tags: - - User Handling - /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfiguration: - get: - description: If the video encoder configuration token is already known, the - encoder configuration can be fetched through the GetVideoEncoderConfiguration - command. - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfiguration - parameters: - - example: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: + enum: + - 'true' + - 'false' + required: + - value + StringReading: + description: An event reading for a string data type + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + example: String + value: + description: A string representation of the reading's value type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + required: + - value + ObjectReading: + description: An event reading for an object data type + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + example: Object + value: + description: Use objectValue instead. type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 598079d0-d169-4385-86f3-cb7a106345a5 - origin: 1659659207626081000 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 86aed436-65cb-4162-b3e6-14def8e4e4d3 - objectValue: - Configuration: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_1 - Quality: 3 - RateControl: - BitrateLimit: 1024 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 1080 - Width: 1920 - SessionTimeout: PT0H1M5S - Token: main - UseCount: 1 - origin: 1659659207626081000 - profileName: onvif-camera - resourceName: VideoEncoderConfiguration - value: '' - valueType: Object - sourceName: VideoEncoderConfiguration - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Configuration: - properties: - Encoding: - type: string - H264: - properties: - GovLength: - type: number - H264Profile: - type: string - type: object - Multicast: - properties: - Address: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - AutoStart: - type: boolean - Port: - type: number - TTL: - type: number - type: object - Name: - type: string - Quality: - type: number - RateControl: - properties: - BitrateLimit: - type: number - EncodingInterval: - type: number - FrameRateLimit: - type: number - type: object - Resolution: - properties: - Height: - type: number - Width: - type: number - type: object - SessionTimeout: - type: string - Token: - type: string - UseCount: - type: number - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '937' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:47 GMT - type: string - X-Correlation-Id: - schema: - example: 2eee5539-10bd-4e4d-b259-be10351c1de2 - type: string - summary: VideoEncoderConfiguration - tags: - - Video Encoder Configuration - put: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetVideoEncoderConfiguration - parameters: - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + example: '' + objectValue: + description: Object representation of the reading's value + type: object + required: + - objectValue + BinaryReading: + description: An event reading for a binary data type + allOf: + - $ref: '#/components/schemas/BaseReading' + - type: object + properties: + valueType: + description: Indicates the datatype of the value property type: string - requestBody: - content: - application/json: - schema: - example: - VideoEncoderConfiguration: - Configuration: - Encoding: H264 - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 8860 - TTL: 1 - Quality: 3 - Resolution: - Height: 1080 - Width: 1920 - token: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}' - ForcePersistence: false - properties: - VideoEncoderConfiguration: - properties: - Configuration: - properties: - Encoding: - type: string - Multicast: - properties: - Address: - properties: - IPv4Address: - type: string - Type: - type: string - type: object - AutoStart: - type: boolean - Port: - type: number - TTL: - type: number - type: object - Quality: - type: number - Resolution: - properties: - Height: - type: number - Width: - type: number - type: object - token: - type: string - type: object - ForcePersistence: - type: boolean - type: object - type: object - responses: - '500': - content: - application/json: - example: - apiVersion: v2 - message: 'request failed, status code: 500, err: {"apiVersion":"v2","message":"error - writing DeviceResourece VideoEncoderConfiguration for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - -\u003e failed to execute write command, \u003cnil\u003e -\u003e - invalid request for the function ''SetVideoEncoderConfiguration'' - of web service ''Media''. Onvif error: fault reason: , fault detail: - , fault code: SOAP-ENV:Sender ","statusCode":500}' - statusCode: 500 - schema: - properties: - apiVersion: - type: string - message: - type: string - statusCode: - type: number - type: object - description: Internal Server Error - headers: - Content-Length: - schema: - example: '489' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:56 GMT - type: string - X-Correlation-Id: - schema: - example: 8888c1a3-e632-4223-9013-41c5e938eb4d - type: string - summary: SetVideoEncoderConfiguration - tags: - - Video Encoder Configuration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfigurationOptions: - get: - 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.' - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurationOptions - parameters: - - example: '{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}' - in: query - name: jsonObject - schema: + example: Binary + enum: + - Binary + binaryValue: + description: If the value of the reading is binary, it will be found in + this property as a base64 string type: string - - example: Camera001 - in: path - name: EDGEX_DEVICE_NAME - required: true - schema: + format: base64 + mediaType: + description: E.g. MIME Type, indicates what the content type of the binaryValue + property is if it's populated. type: string - responses: - '200': - content: - application/json: - example: - apiVersion: v2 - event: - apiVersion: v2 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 187b2e94-6efe-421f-b618-186a20fd41df - origin: 1659659212171416600 - profileName: onvif-camera - readings: - - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - id: 0b709715-f644-4cf0-a477-dcc3b5ef218c - objectValue: - Options: - Extension: - H264: - BitrateRange: - Max: 1024 - Min: 256 - EncodingIntervalRange: - Max: 1 - Min: 1 - FrameRateRange: - Max: 15 - Min: 1 - GovLengthRange: - Max: 25 - Min: 25 - H264ProfilesSupported: - - Main - ResolutionsAvailable: - - Height: 1080 - Width: 1920 - - Height: 720 - Width: 1280 - - Height: 360 - Width: 640 - H264: - EncodingIntervalRange: - Max: 1 - Min: 1 - FrameRateRange: - Max: 15 - Min: 1 - GovLengthRange: - Max: 25 - Min: 25 - H264ProfilesSupported: - - Main - ResolutionsAvailable: - - Height: 1080 - Width: 1920 - - Height: 720 - Width: 1280 - - Height: 360 - Width: 640 - QualityRange: - Max: 5 - Min: 1 - origin: 1659659212171416600 - profileName: onvif-camera - resourceName: VideoEncoderConfigurationOptions - value: '' - valueType: Object - sourceName: VideoEncoderConfigurationOptions - statusCode: 200 - schema: - properties: - apiVersion: - type: string - event: - properties: - apiVersion: - type: string - deviceName: - type: string - id: - type: string - origin: - type: number - profileName: - type: string - readings: - items: - properties: - deviceName: - type: string - id: - type: string - objectValue: - properties: - Options: - properties: - Extension: - properties: - H264: - properties: - BitrateRange: - properties: - Max: - type: number - Min: - type: number - type: object - EncodingIntervalRange: - properties: - Max: - type: number - Min: - type: number - type: object - FrameRateRange: - properties: - Max: - type: number - Min: - type: number - type: object - GovLengthRange: - properties: - Max: - type: number - Min: - type: number - type: object - H264ProfilesSupported: - items: - type: string - type: array - ResolutionsAvailable: - items: - properties: - Height: - type: number - Width: - type: number - required: - - Height - - Width - type: object - type: array - type: object - type: object - H264: - properties: - EncodingIntervalRange: - properties: - Max: - type: number - Min: - type: number - type: object - FrameRateRange: - properties: - Max: - type: number - Min: - type: number - type: object - GovLengthRange: - properties: - Max: - type: number - Min: - type: number - type: object - H264ProfilesSupported: - items: - type: string - type: array - ResolutionsAvailable: - items: - properties: - Height: - type: number - Width: - type: number - required: - - Height - - Width - type: object - type: array - type: object - QualityRange: - properties: - Max: - type: number - Min: - type: number - type: object - type: object - type: object - origin: - type: number - profileName: - type: string - resourceName: - type: string - value: - type: string - valueType: - type: string - type: object - type: array - sourceName: - type: string - type: object - statusCode: - type: number - type: object - description: OK - headers: - Content-Length: - schema: - example: '1189' - type: integer - Content-Type: - schema: - example: application/json - type: string - Date: - schema: - example: Fri, 05 Aug 2022 00:26:52 GMT - type: string - X-Correlation-Id: - schema: - example: a84e4fb9-68a1-4b93-a48e-12d6467b5a52 - type: string - summary: VideoEncoderConfigurationOptions - tags: - - Video Encoder Configuration -servers: - - url: http://0.0.0.0:59882 -tags: - - name: Network Configuration - - name: System Function - - name: Metadata Configuration - - name: Video Streaming - - name: Video Encoder Configuration - - name: User Handling - - name: Auto Discovery - - name: PTZ - - name: PTZ - Capabilities - - name: PTZ - Configuration - - name: PTZ - Actuation - - name: PTZ - Preset - - name: PTZ - Home Position - - name: PTZ - Auxiliary - - name: Event Handling - - name: Analytics - - name: Analytics - Profile Configuration - - name: Analytics - Modules - - name: Analytics - Rules - - description: Custom commands outside of the ONVIF spec handled by the device service - directly. - name: Custom + example: image/jpeg + value: + description: Use binaryValue instead. + type: string + example: '' + required: + - binaryValue + - mediaType + ErrorResponse: + allOf: + - $ref: '#/components/schemas/BaseResponse' + - properties: + message: + description: A field that can contain a free-form message, such as an + error message. + type: string + description: A response type for returning a generic error to the caller. + type: object + headers: + correlatedResponseHeader: + description: A response header that returns the unique correlation ID used to + initiate the request. + schema: + type: string + format: uuid + example: 14a42ea6-c394-41c3-8bcd-a29b9f5e6835 + examples: + 200Example: + value: + apiVersion: v2 + statusCode: 200 + 400Example: + value: + apiVersion: v2 + statusCode: 400 + message: Bad Request + 404Example: + value: + apiVersion: v2 + statusCode: 404 + message: The requested resource does not exist + 416Example: + value: + apiVersion: v2 + statusCode: 416 + message: Range Not Satisfiable + 423Example: + value: + apiVersion: v2 + statusCode: 423 + message: The device is locked (AdminState) + 500Example: + value: + apiVersion: v2 + statusCode: 500 + message: Internal Server Error + 503Example: + value: + apiVersion: v2 + statusCode: 503 + message: HTTP request timeout diff --git a/doc/postman/config.p2ojx.json b/doc/postman/config.p2ojx.json deleted file mode 100644 index a19be484..00000000 --- a/doc/postman/config.p2ojx.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "info": { - "title": "EdgeX Onvif Device Service", - "version": "2.2.0", - "description": "EdgeX Onvif Device Service REST APIs" - }, - "folders": { - "separator": " - " - }, - "additionalVars": { - "EDGEX_DEVICE_NAME": "Camera001" - } -} diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index b68ad34f..8d35ab03 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -1,7 +1,7 @@ { "info": { - "_postman_id": "117aa9ba-01bf-421f-bf59-fb109888c2d4", - "name": "device-onvif-camera Copy 4", + "_postman_id": "74f237f6-a599-4413-8a00-83b908e0d9a8", + "name": "device-onvif-camera", "description": "The Open Network Video Interface Forum (ONVIF) Device Service is a microservice created to address the lack of standardization and automation of camera discovery and onboarding. EdgeX Foundry is a flexible microservice-based architecture created to promote the interoperability of multiple device interface combinations at the edge. In an EdgeX deployment, the ONVIF Device Service controls and communicates with ONVIF-compliant cameras, while EdgeX Foundry presents a standard interface to application developers. With normalized connectivity protocols and a vendor-neutral architecture, EdgeX paired with ONVIF Camera Device Service, simplifies deployment of edge camera devices.\n\nUse the ONVIF Device Service to streamline and scale your edge camera device deployment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "19151794" @@ -762,6 +762,15 @@ "originalRequest": { "method": "GET", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", "protocol": "http", @@ -948,6 +957,15 @@ "originalRequest": { "method": "GET", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", "protocol": "http", @@ -1218,6 +1236,15 @@ "originalRequest": { "method": "GET", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", "protocol": "http", @@ -1338,21 +1365,9 @@ "code": 200, "_postman_previewlanguage": "json", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "X-Correlation-Id", "value": "fb9339bb-b588-49f8-82b1-d0da167897c0" - }, - { - "key": "Date", - "value": "Fri, 23 Sep 2022 16:27:07 GMT" - }, - { - "key": "Content-Length", - "value": "37" } ], "cookie": [], From 20a20690839ead0e5462979966cf8264891313e1 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Sun, 16 Oct 2022 21:02:34 -0700 Subject: [PATCH 02/15] docs: cleanup yaml generation Signed-off-by: Anthony Casagrande --- doc/openapi/python/postprocess.py | 169 ++- doc/openapi/sidecar.yaml | 7 + doc/openapi/v2/device-onvif-camera.yaml | 1194 +++++++++++++---- ...evice-onvif-camera.postman_collection.json | 48 +- 4 files changed, 1079 insertions(+), 339 deletions(-) diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 0f28bb99..5351bda8 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -1,13 +1,13 @@ #!/usr/bin/env python3 import dataclasses -import io import sys import copy import textwrap from ruamel.yaml import YAML from ruamel.yaml.scalarstring import LiteralScalarString + yaml = YAML() EDGEX = 'EdgeX' @@ -42,6 +42,10 @@ def make_scalar(val): return LiteralScalarString(textwrap.dedent(val)) +def single_quote(s): + return f"'{s}'" + + @dataclasses.dataclass class YamlProcessor: input_file: str @@ -102,7 +106,8 @@ def _process_apis(self): content = method_obj['responses']['200']['content'] if 'application/json' not in content or \ len(content['application/json']) == 0 or \ - ('example' in content['application/json'] and len(content['application/json']['example']) == 2): + ('example' in content['application/json'] and len( + content['application/json']['example']) == 2): print(f'Overriding empty 200 response for {service}_{fn}') method_obj['responses'][code] = resp_obj @@ -113,11 +118,13 @@ def _process_apis(self): # clone the 200 response to avoid mangling pointer references resp_200 = copy.deepcopy(method_obj['responses']['200']) # apply the defined schema - resp_200['content']['application/json']['schema'] = self.sidecar['responses']['edgex'][cmd] + resp_200['content']['application/json']['schema'] = self.sidecar['responses']['edgex'][ + cmd] # override with cloned one method_obj['responses']['200'] = resp_200 else: - print(f'\033[33m[WARNING] \t -- Missing schema response definition for EdgeX command {method.upper()} {cmd}\033[0m') + print( + f'\033[33m[WARNING] \t -- Missing schema response definition for EdgeX command {method.upper()} {cmd}\033[0m') elif method == 'put': if cmd in self.sidecar['requests']['edgex']: # look for the json response object, so we can modify it @@ -136,7 +143,8 @@ def _process_apis(self): 'type': 'object' } else: - print(f'\033[33m[WARNING] \t -- Missing schema request definition for EdgeX command {method.upper()} {cmd}\033[0m') + print( + f'\033[33m[WARNING] \t -- Missing schema request definition for EdgeX command {method.upper()} {cmd}\033[0m') # override the response schema with default 200 response method_obj['responses']['200'] = self.sidecar['responses']['canned']['200'] @@ -216,23 +224,49 @@ def _process_apis(self): if 'type' in schema and schema['type'] == 'object' and len(schema) == 1: print(f'Skipping empty request schema for {service}_{fn}') else: - buf = io.BytesIO() - yaml.dump({ - f'{service.lower()}_{fn}': - self.yml['components']['schemas'][f'{service.lower()}_{fn}']}, - buf) - method_obj['description'] = make_scalar(method_obj['description'] + f''' - -
- -**`jsonObject` Schema:** - -_See: [{service.lower()}_{fn}](#{service.lower()}_{fn})_ - + found = False + for param in method_obj['parameters']: + if param['name'] == 'jsonObject': + found = True + self._set_json_object(param, service, fn) + break + if not found: + print(f'\033[33m[WARNING] \t -- Expected jsonObject parameter for command {cmd}! Creating one.\033[0m') + param = { + 'name': 'jsonObject', + 'in': 'query', + 'schema': { + 'type': 'string' + } + } + self._set_json_object(param, service, fn) + method_obj['parameters'].insert(0, param) + + def _set_json_object(self, param, service, fn): + desc = f'''**Format:**
+This field is a Base64 encoded json string. + +**JSON Schema:** ```yaml -{self._gen_pretty_schema(None, self.yml['components']['schemas'][f'{service.lower()}_{fn}'], - indent=0, all_types=set(f'{service.lower()}_{fn}'))} -```''') +{self._gen_pretty_schema_for(f'{service.lower()}_{fn}')} +``` + +**Field Descriptions:** +{self._gen_field_desc_for(f'{service.lower()}_{fn}')} + +**Schema Reference:** [{service.lower()}_{fn}](#{service.lower()}_{fn}) +''' + if 'description' in param: + desc += f''' +**Example:**
+```json +{param['description']} +``` +''' + param['description'] = make_scalar(desc) + # todo: setting the format to Base64 messes with the Swagger UI, and makes it + # choose file box, which does not end up working + # param['schema']['format'] = 'base64' def _combine_schemas(self): """ @@ -255,7 +289,7 @@ def _combine_schemas(self): self.yml['components'] = { 'schemas': schemas, 'headers': {}, - 'examples': {}, + 'examples': {} } # note: sidecar should always be added last to override the onvif schemas @@ -266,39 +300,102 @@ def _combine_schemas(self): for k, v in self.sidecar['components'][component].items(): self.yml['components'][component][k] = v + def _gen_field_desc_for(self, typ): + """ + Generate a pretty field description in markdown for a specific onvif type + :param typ: the onvif type + :return: string + """ + return self._gen_field_desc(None, '', self.yml['components']['schemas'][typ], indent=0, all_types=set(typ)) + + def _gen_field_desc(self, name, desc, val, indent, all_types): + if 'allOf' in val: + desc2 = '' + if len(val['allOf']) > 1 and 'description' in val['allOf'][1]: + desc2 = val['allOf'][1]['description'] + return self._gen_field_desc(name, desc2, val['allOf'][0], indent, all_types) + if '$ref' in val: + typ = val['$ref'].split('/')[-1] + if typ in all_types: + output = " " * indent + f'- **{name}** _[Recursive object of type [{typ}](#{typ})]_\n' + if desc.strip() != '': + output += f'
{" " * indent} {desc}\n' + return output + all_types.add(typ) + return self._gen_field_desc(name, desc, self.yml['components']['schemas'][typ], indent, all_types) + + desc2 = desc if 'description' not in val else val['description'] + + if val['type'] == 'object': + output = '' + if name is not None: + output = " " * indent + f'- **{name}** _[object]_\n' + if desc2.strip() != '': + output += f'
{" " * indent} {desc2}\n' + for prop, prop_val in val['properties'].items(): + output += self._gen_field_desc(prop, '', prop_val, indent + 2, all_types) + return output + else: + output = f'{" " * indent}- **{name}** _[{val["type"]}]_\n' + if desc2.strip() != '': # add description if present + output += f'
{" " * indent} {desc2}\n' + if 'enum' in val: # add enum values + output += f'
{" " * indent} _Enum: [{", ".join([single_quote(e) for e in val["enum"]])}]_\n' + return output + + def _gen_pretty_schema_for(self, typ): + """ + Return the pretty json formatted schema for a specific onvif type + :param typ: the onvif type + :return: string + """ + return self._gen_pretty_schema(None, self.yml['components']['schemas'][typ], indent=0, all_types=set(typ)) + def _gen_pretty_schema(self, name, val, indent, all_types): + """ + Recursively generates a pretty json schema + :param name: + :param val: + :param indent: + :param all_types: + :return: + """ if 'allOf' in val: return self._gen_pretty_schema(name, val['allOf'][0], indent, all_types) if '$ref' in val: typ = val['$ref'].split('/')[-1] if typ in all_types: - return " "*indent + '"%s": { $ref: %s }' % (name, typ) + return " " * indent + '"%s": { $ref: %s }' % (name, typ) all_types.add(typ) return self._gen_pretty_schema(name, self.yml['components']['schemas'][typ], indent, all_types) if val['type'] == 'object': if name is None: - output = " "*indent + '{\n' + output = " " * indent + '{\n' else: - output = " "*indent + '"%s": {\n' % name + output = " " * indent + '"%s": {\n' % name inners = [] for prop, prop_val in val['properties'].items(): - inners.append(self._gen_pretty_schema(prop, prop_val, indent+2, all_types)) - output += ',\n'.join(inners) + '\n' + " "*indent + '}' + inners.append(self._gen_pretty_schema(prop, prop_val, indent + 2, all_types)) + output += ',\n'.join(inners) + '\n' + " " * indent + '}' return output elif val['type'] == 'array': - return f'{" "*indent}"{name}": []' + return f'{" " * indent}"{name}": []' elif val['type'] == 'string': - return f'{" "*indent}"{name}": "<{name}>"' + example = f'<{name}>' + if 'enum' in val: + # example = f"Enum: <{', '.join([single_quote(e) for e in val['enum']])}>" + example = '|'.join(val['enum']) + return f'{" " * indent}"{name}": "{example}"' elif val['type'] == 'integer' or val['type'] == 'number': - return f'{" "*indent}"{name}": <{name}>' + return f'{" " * indent}"{name}": <{name}>' elif val['type'] == 'boolean': - return f'{" "*indent}"{name}": true|false' - + return f'{" " * indent}"{name}": true|false' + raise ProcessingError('unsupported data type') def _verify_complete(self): @@ -330,12 +427,14 @@ def _add_example_vars(self): for _, path_obj in self.yml['paths'].items(): for _, method_obj in path_obj.items(): for param_obj in method_obj['parameters']: - if param_obj['name'] == 'EDGEX_DEVICE_NAME': - param_obj['example'] = EDGEX_DEVICE_NAME + if param_obj['name'] in self.sidecar['parameters']: + param_obj['example'] = self.sidecar['parameters'][param_obj['name']]['example'] + param_obj['description'] = self.sidecar['parameters'][param_obj['name']]['description'] def _clean_response_headers(self): """ - Remove superfluous headers from response objects + - Remove superfluous headers from response objects + - Patches X-Correlation-Id header """ for _, path_obj in self.yml['paths'].items(): for _, method_obj in path_obj.items(): diff --git a/doc/openapi/sidecar.yaml b/doc/openapi/sidecar.yaml index 35cb25fe..7e8a99ff 100644 --- a/doc/openapi/sidecar.yaml +++ b/doc/openapi/sidecar.yaml @@ -143,6 +143,13 @@ responses: examples: 503Example: $ref: '#/components/examples/503Example' +parameters: + EDGEX_DEVICE_NAME: + example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. components: headers: correlatedResponseHeader: diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 0f5b3087..94099ecf 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -46,6 +46,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -182,6 +186,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': &id006 description: OK @@ -218,6 +226,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -295,6 +307,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -322,6 +338,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -419,6 +439,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -445,6 +469,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -535,6 +563,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -561,6 +593,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -636,6 +672,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -661,6 +701,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -788,6 +832,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -814,6 +862,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -885,6 +937,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1006,6 +1062,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -1044,6 +1104,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -1069,6 +1133,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1126,6 +1194,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -1153,6 +1225,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1205,32 +1281,42 @@ paths: tags: - Metadata Configuration summary: MetadataConfiguration - description: |- - The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. - -
- - **`jsonObject` Schema:** - - _See: [media_GetMetadataConfiguration](#media_GetMetadataConfiguration)_ - - ```yaml - { - "ConfigurationToken": "" - } - ``` + description: >- + The GetMetadataConfiguration command fetches the metadata configuration + if the metadata token is known. parameters: - name: jsonObject in: query schema: type: string example: '{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Token of the requested metadata configuration. + + + **Schema Reference:** [media_GetMetadataConfiguration](#media_GetMetadataConfiguration) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1314,6 +1400,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -1329,32 +1419,46 @@ paths: tags: - Metadata Configuration summary: CompatibleMetadataConfigurations - 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. - -
- - **`jsonObject` Schema:** - - _See: [media_GetCompatibleMetadataConfigurations](#media_GetCompatibleMetadataConfigurations)_ - - ```yaml - { - "ProfileToken": "" - } - ``` + 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. parameters: - name: jsonObject in: query schema: type: string example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ProfileToken** _[string]_ +
Contains the token of an existing media profile the configurations shall be compatible with. + + + **Schema Reference:** [media_GetCompatibleMetadataConfigurations](#media_GetCompatibleMetadataConfigurations) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1407,33 +1511,46 @@ paths: tags: - Metadata Configuration summary: MetadataConfigurationOptions - description: |- - This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. - -
- - **`jsonObject` Schema:** - - _See: [media_GetMetadataConfigurationOptions](#media_GetMetadataConfigurationOptions)_ - - ```yaml - { - "ConfigurationToken": "", - "ProfileToken": "" - } - ``` + description: >- + This operation returns the available options (supported values and + ranges for metadata configuration parameters) for changing the metadata + configuration. parameters: - name: jsonObject in: query schema: type: string example: '{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "", + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Optional metadata configuration token that specifies an existing configuration that the options are intended for. + - **ProfileToken** _[string]_ +
Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + + + **Schema Reference:** [media_GetMetadataConfigurationOptions](#media_GetMetadataConfigurationOptions) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1513,6 +1630,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -1552,6 +1673,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -1580,6 +1705,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1864,41 +1993,80 @@ paths: tags: - Video Streaming summary: StreamUri - 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). + 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. + The correct syntax for the StreamSetup element for these media stream + setups defined in 5.1.1 of the streaming specification are as follows: - For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets. + RTP unicast over UDP: StreamType = "RTP_unicast", TransportProtocol = + "UDP" -
+ RTP over RTSP over HTTP over TCP: StreamType = "RTP_unicast", + TransportProtocol = "HTTP" - **`jsonObject` Schema:** + RTP over RTSP over TCP: StreamType = "RTP_unicast", TransportProtocol = + "RTSP" - _See: [media_GetStreamUri](#media_GetStreamUri)_ - ```yaml - { - "ProfileToken": "", - "StreamSetup": { - "Stream": "", - "Transport": { - "Protocol": "", - "Tunnel": { $ref: onvif_Transport } - } - } - } - ``` + 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. parameters: - name: jsonObject in: query schema: type: string + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ProfileToken": "", + "StreamSetup": { + "Stream": "RTP-Unicast|RTP-Multicast", + "Transport": { + "Protocol": "UDP|TCP|RTSP|HTTP", + "Tunnel": { $ref: onvif_Transport } + } + } + } + ``` + + **Field Descriptions:** + - **ProfileToken** _[string]_ +
The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. + - **StreamSetup** _[object]_ +
Stream Setup that should be used with the uri + - **Stream** _[string]_ +
Defines if a multicast or unicast stream is requested +
_Enum: ['RTP-Unicast', 'RTP-Multicast']_ + - **Transport** _[object]_ + - **Protocol** _[string]_ +
Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP +
_Enum: ['UDP', 'TCP', 'RTSP', 'HTTP']_ + - **Tunnel** _[Recursive object of type [onvif_Transport](#onvif_Transport)]_ +
Optional element to describe further tunnel options. This element is normally not needed + + + **Schema Reference:** [media_GetStreamUri](#media_GetStreamUri) + + **Example:**
+ ```json + {"ProfileToken":"profile_1"} + ``` example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' - name: EDGEX_DEVICE_NAME in: path @@ -1906,6 +2074,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -1975,6 +2147,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2028,6 +2204,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2103,32 +2283,43 @@ paths: tags: - Video Encoder Configuration summary: VideoEncoderConfiguration - description: |- - If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. - -
- - **`jsonObject` Schema:** - - _See: [media_GetVideoEncoderConfiguration](#media_GetVideoEncoderConfiguration)_ - - ```yaml - { - "ConfigurationToken": "" - } - ``` + description: >- + If the video encoder configuration token is already known, the encoder + configuration can be fetched through the GetVideoEncoderConfiguration + command. parameters: - name: jsonObject in: query schema: type: string example: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Token of the requested video encoder configuration. + + + **Schema Reference:** [media_GetVideoEncoderConfiguration](#media_GetVideoEncoderConfiguration) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2253,6 +2444,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '500': description: Internal Server Error @@ -2289,37 +2484,60 @@ paths: tags: - Video Encoder Configuration summary: VideoEncoderConfigurationOptions - 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. + description: >- + This operation returns the available options (supported values and + ranges for video encoder configuration parameters) when the video + encoder parameters are reconfigured. -
- **`jsonObject` Schema:** + 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. - _See: [media_GetVideoEncoderConfigurationOptions](#media_GetVideoEncoderConfigurationOptions)_ - ```yaml - { - "ConfigurationToken": "", - "ProfileToken": "" - } - ``` + 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. parameters: - name: jsonObject in: query schema: type: string example: '{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "", + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Optional video encoder configuration token that specifies an existing configuration that the options are intended for. + - **ProfileToken** _[string]_ +
Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + + + **Schema Reference:** [media_GetVideoEncoderConfigurationOptions](#media_GetVideoEncoderConfigurationOptions) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2429,6 +2647,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2522,6 +2744,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -2575,6 +2801,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -2619,6 +2849,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -2646,6 +2880,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2722,6 +2960,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -2763,6 +3005,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -2800,6 +3046,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -2888,6 +3138,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -2929,6 +3183,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '500': description: Internal Server Error @@ -2981,6 +3239,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -3091,26 +3353,34 @@ paths: tags: - PTZ - Capabilities summary: GetNode - description: |- - Get a specific PTZ Node identified by a reference token or a name. - -
- - **`jsonObject` Schema:** - - _See: [ptz_GetNode](#ptz_GetNode)_ - - ```yaml - { - "NodeToken": "" - } - ``` + description: Get a specific PTZ Node identified by a reference token or a name. parameters: - name: jsonObject in: query schema: type: string - description: '{"NodeToken": "Node0"}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "NodeToken": "" + } + ``` + + **Field Descriptions:** + - **NodeToken** _[string]_ +
Token of the requested PTZNode. + + + **Schema Reference:** [ptz_GetNode](#ptz_GetNode) + + **Example:**
+ ```json + {"NodeToken": "Node0"} + ``` example: eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ== - name: EDGEX_DEVICE_NAME in: path @@ -3118,6 +3388,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -3257,6 +3531,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -3327,30 +3605,58 @@ paths: tags: - PTZ - Configuration summary: GetConfiguration - 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. + description: >- + Get a specific PTZconfiguration from the device, identified by its + reference token or name. -
- **`jsonObject` Schema:** + 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. - _See: [ptz_GetConfiguration](#ptz_GetConfiguration)_ - ```yaml - { - "PTZConfigurationToken": "" - } - ``` + 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. parameters: - name: jsonObject in: query schema: type: string - description: '{"PTZConfigurationToken": "PTZConfiguration0"}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "PTZConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **PTZConfigurationToken** _[string]_ +
Token of the requested PTZConfiguration. + + + **Schema Reference:** [ptz_GetConfiguration](#ptz_GetConfiguration) + + **Example:**
+ ```json + {"PTZConfigurationToken": "PTZConfiguration0"} + ``` example: eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - name: EDGEX_DEVICE_NAME in: path @@ -3358,6 +3664,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -3458,6 +3768,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3473,26 +3787,42 @@ paths: tags: - PTZ - Configuration summary: GetConfigurationOptions - 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. - -
- - **`jsonObject` Schema:** - - _See: [ptz_GetConfigurationOptions](#ptz_GetConfigurationOptions)_ - - ```yaml - { - "ConfigurationToken": "" - } - ``` + 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. parameters: - name: jsonObject in: query schema: type: string - description: '{"ConfigurationToken": "PTZConfiguration0"}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Token of an existing configuration that the options are intended for. + + + **Schema Reference:** [ptz_GetConfigurationOptions](#ptz_GetConfigurationOptions) + + **Example:**
+ ```json + {"ConfigurationToken": "PTZConfiguration0"} + ``` example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - name: EDGEX_DEVICE_NAME in: path @@ -3500,6 +3830,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -3632,6 +3966,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3668,6 +4006,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3715,6 +4057,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3764,6 +4110,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3808,6 +4158,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3823,26 +4177,34 @@ paths: tags: - PTZ - Actuation summary: GetStatus - description: |- - Operation to request PTZ status for the Node in the selected profile. - -
- - **`jsonObject` Schema:** - - _See: [ptz_GetStatus](#ptz_GetStatus)_ - - ```yaml - { - "ProfileToken": "" - } - ``` + description: Operation to request PTZ status for the Node in the selected profile. parameters: - name: jsonObject in: query schema: type: string - description: '{"ProfileToken":"profile_1"}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ProfileToken** _[string]_ +
A reference to the MediaProfile where the PTZStatus should be requested. + + + **Schema Reference:** [ptz_GetStatus](#ptz_GetStatus) + + **Example:**
+ ```json + {"ProfileToken":"profile_1"} + ``` example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== - name: EDGEX_DEVICE_NAME in: path @@ -3850,6 +4212,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -3936,6 +4302,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3984,6 +4354,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -3999,26 +4373,45 @@ paths: tags: - PTZ - Preset summary: GetPresets - 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. - -
- - **`jsonObject` Schema:** - - _See: [ptz_GetPresets](#ptz_GetPresets)_ - - ```yaml - { - "ProfileToken": "" - } - ``` + 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. parameters: - name: jsonObject in: query schema: type: string - description: '{"ProfileToken":"profile_1"}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ProfileToken** _[string]_ +
A reference to the MediaProfile where the operation should take place. + + + **Schema Reference:** [ptz_GetPresets](#ptz_GetPresets) + + **Example:**
+ ```json + Json: + ```json + {"ProfileToken":"PROFILE_3305967797"} + ``` + + Base64: + ``` + eyJQcm9maWxlVG9rZW4iOiJQUk9GSUxFXzMzMDU5Njc3OTcifQ== + ``` + ``` example: '{{PTZ_CONFIG_TOKEN_BASE64}}' - name: EDGEX_DEVICE_NAME in: path @@ -4026,6 +4419,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -4127,6 +4524,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4167,6 +4568,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4205,6 +4610,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4246,6 +4655,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4320,6 +4733,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4349,6 +4766,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -4541,6 +4962,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4594,6 +5019,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4632,6 +5061,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4644,28 +5077,47 @@ paths: tags: - Analytics - Profile Configuration summary: GetProfiles - 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. + 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. + parameters: + - name: jsonObject + in: query + schema: + type: string + description: | + **Format:**
+ This field is a Base64 encoded json string. -
+ **JSON Schema:** + ```yaml + { + "Token": "", + "Type": [] + } + ``` - **`jsonObject` Schema:** + **Field Descriptions:** + - **Token** _[string]_ +
Optional token of the requested profile. + - **Type** _[array]_ +
The types shall be provided as defined by tr2:ConfigurationEnumeration. - _See: [media2_GetProfiles](#media2_GetProfiles)_ - ```yaml - { - "Token": "", - "Type": [] - } - ``` - parameters: + **Schema Reference:** [media2_GetProfiles](#media2_GetProfiles) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '500': description: Internal Server Error @@ -4734,6 +5186,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '500': description: Internal Server Error @@ -4823,6 +5279,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4865,6 +5325,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -4880,27 +5344,41 @@ paths: tags: - Analytics - Modules summary: GetSupportedAnalyticsModules - description: |- - List all analytics modules that are supported by the given VideoAnalyticsConfiguration. + description: >- + List all analytics modules that are supported by the given + VideoAnalyticsConfiguration. + parameters: + - name: jsonObject + in: query + schema: + type: string + description: | + **Format:**
+ This field is a Base64 encoded json string. -
+ **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` - **`jsonObject` Schema:** + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Reference to an existing VideoAnalyticsConfiguration. - _See: [analytics_GetSupportedAnalyticsModules](#analytics_GetSupportedAnalyticsModules)_ - ```yaml - { - "ConfigurationToken": "" - } - ``` - parameters: + **Schema Reference:** [analytics_GetSupportedAnalyticsModules](#analytics_GetSupportedAnalyticsModules) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -4936,32 +5414,42 @@ paths: tags: - Analytics - Modules summary: GetAnalyticsModules - description: |- - List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. - -
- - **`jsonObject` Schema:** - - _See: [analytics_GetAnalyticsModules](#analytics_GetAnalyticsModules)_ - - ```yaml - { - "ConfigurationToken": "" - } - ``` + description: >- + List the currently assigned set of analytics modules of a + VideoAnalyticsConfiguration. parameters: - name: jsonObject in: query schema: type: string example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Reference to an existing VideoAnalyticsConfiguration. + + + **Schema Reference:** [analytics_GetAnalyticsModules](#analytics_GetAnalyticsModules) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5050,6 +5538,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5121,6 +5613,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5161,6 +5657,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5176,33 +5676,45 @@ paths: tags: - Analytics - Modules summary: GetAnalyticsModuleOptions - description: |- - Return the options for the supported analytics modules that specify an Option attribute. - -
- - **`jsonObject` Schema:** - - _See: [analytics_GetAnalyticsModuleOptions](#analytics_GetAnalyticsModuleOptions)_ - - ```yaml - { - "ConfigurationToken": "", - "Type": "" - } - ``` + description: >- + Return the options for the supported analytics modules that specify an + Option attribute. parameters: - name: jsonObject in: query schema: type: string example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "", + "Type": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Reference to an existing AnalyticsConfiguration. + - **Type** _[string]_ +
Reference to an SupportedAnalyticsModule Type returned from GetSupportedAnalyticsModules. + + + **Schema Reference:** [analytics_GetAnalyticsModuleOptions](#analytics_GetAnalyticsModuleOptions) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5260,32 +5772,43 @@ paths: tags: - Analytics - Rules summary: GetSupportedRules - description: |- - List all rules that are supported by the given VideoAnalyticsConfiguration. - -
- - **`jsonObject` Schema:** - - _See: [analytics_GetSupportedRules](#analytics_GetSupportedRules)_ - - ```yaml - { - "ConfigurationToken": "" - } - ``` + description: >- + List all rules that are supported by the given + VideoAnalyticsConfiguration. parameters: - name: jsonObject in: query schema: type: string example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
References an existing Video Analytics configuration. The list of available tokens can be obtained + via the Media service GetVideoAnalyticsConfigurations method. + + + **Schema Reference:** [analytics_GetSupportedRules](#analytics_GetSupportedRules) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5489,32 +6012,42 @@ paths: tags: - Analytics - Rules summary: GetRules - description: |- - List the currently assigned set of rules of a VideoAnalyticsConfiguration. - -
- - **`jsonObject` Schema:** - - _See: [analytics_GetRules](#analytics_GetRules)_ - - ```yaml - { - "ConfigurationToken": "" - } - ``` + description: >- + List the currently assigned set of rules of a + VideoAnalyticsConfiguration. parameters: - name: jsonObject in: query schema: type: string example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Reference to an existing VideoAnalyticsConfiguration. + + + **Schema Reference:** [analytics_GetRules](#analytics_GetRules) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5608,6 +6141,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5623,33 +6160,45 @@ paths: tags: - Analytics - Rules summary: GetRuleOptions - description: |- - Return the options for the supported rules that specify an Option attribute. - -
- - **`jsonObject` Schema:** - - _See: [analytics_GetRuleOptions](#analytics_GetRuleOptions)_ - - ```yaml - { - "ConfigurationToken": "", - "RuleType": "" - } - ``` + description: >- + Return the options for the supported rules that specify an Option + attribute. parameters: - name: jsonObject in: query schema: type: string example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "", + "RuleType": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Reference to an existing analytics configuration. + - **RuleType** _[string]_ +
Reference to an SupportedRule Type returned from GetSupportedRules. + + + **Schema Reference:** [analytics_GetRuleOptions](#analytics_GetRuleOptions) - name: EDGEX_DEVICE_NAME in: path schema: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5761,6 +6310,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5799,6 +6352,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5822,6 +6379,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5859,7 +6420,21 @@ paths: tags: - Custom summary: Set MACAddress - description: This command sets the MAC address associated with a device. + description: >- + MACAddress can also be set via Edgex device command. This is useful for + setting the MAC Address for devices which do not contain + + the MAC Address in the Endpoint Reference Address, or have been added + manually without a MAC Address. + + Since the MAC is used to map credentials for cameras, it is important to + have this field filled out. + + + > Note: When a camera successfully becomes `UpWithAuth`, the MAC Address + is automatically queried and overridden by the system if available. + + Device resource MACAddress is used to set `MACAddress` of a camera. requestBody: content: application/json: @@ -5879,6 +6454,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5902,6 +6481,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -5963,6 +6546,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -5976,8 +6563,61 @@ paths: - Custom summary: Get CustomMetadata description: >- - This command returns the user specified custom metadata associated with - a device. + **Get Custom Metadata** + + Use this command to return all of the data in the CustomMetadata field. + + + **Get Specific Custom Metadata** + + + Pass the `CustomMetadata` resource a query to get specific field(s) in + CustomMetadata. The query must be a base64 encoded json object with an + array of fields you want to access. + + + 1. Json object holding an array of fields you want to query. + + ```json + + '[ + "Color", + "Location" + ]' + + ``` + + + 2. Use this command to convert the json object to base64. + + ```shell + + echo '[ + "Color", + "Location" + ]' | base64 + + ``` + + + 3. The response converted to base64. + + ``` + + WwogICAgIkNvbG9yIiwKICAgICJMb2NhdGlvbiIKXQo= + + ``` + + + 4. Use this command to query the fields you provided in the json object. + + ```shell + + curl http://localhost:59882/api/v2/device/name//CustomMetadata?jsonObject=WwogICAgIkNvbG9yIiwKICAgICJMb2NhdGlvbiIKXQo= + | jq . + + ``` parameters: - name: EDGEX_DEVICE_NAME in: path @@ -5985,6 +6625,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': description: OK @@ -6052,6 +6696,9 @@ paths: tags: - Custom summary: Set CustomMetadata + description: >- + Use the CustomMetadata resource to set the fields of `CustomMetadata`. + Choose the key/value pairs to represent your custom fields. requestBody: content: application/json: @@ -6074,6 +6721,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 @@ -6086,6 +6737,9 @@ paths: tags: - Custom summary: Delete CustomMetadata + description: >- + Use the `DeleteCustomMetadata` resource to delete entries in custom + metadata requestBody: content: application/json: @@ -6109,6 +6763,10 @@ paths: type: string required: true example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. responses: '200': *id006 '400': *id001 diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index 8d35ab03..45158e1d 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -1,10 +1,10 @@ { "info": { - "_postman_id": "74f237f6-a599-4413-8a00-83b908e0d9a8", - "name": "device-onvif-camera", + "_postman_id": "41b06358-d096-4b9b-8735-a0905762330f", + "name": "device-onvif-camera Copy 2", "description": "The Open Network Video Interface Forum (ONVIF) Device Service is a microservice created to address the lack of standardization and automation of camera discovery and onboarding. EdgeX Foundry is a flexible microservice-based architecture created to promote the interoperability of multiple device interface combinations at the edge. In an EdgeX deployment, the ONVIF Device Service controls and communicates with ONVIF-compliant cameras, while EdgeX Foundry presents a standard interface to application developers. With normalized connectivity protocols and a vendor-neutral architecture, EdgeX paired with ONVIF Camera Device Service, simplifies deployment of edge camera devices.\n\nUse the ONVIF Device Service to streamline and scale your edge camera device deployment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", - "_exporter_id": "19151794" + "_exporter_id": "7889146" }, "item": [ { @@ -762,15 +762,6 @@ "originalRequest": { "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", "protocol": "http", @@ -957,15 +948,6 @@ "originalRequest": { "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", "protocol": "http", @@ -1236,15 +1218,6 @@ "originalRequest": { "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", "protocol": "http", @@ -2407,7 +2380,8 @@ "query": [ { "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" + "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}", + "description": "{\"ProfileToken\":\"profile_1\"}" } ] }, @@ -5207,7 +5181,7 @@ { "key": "jsonObject", "value": "{{PTZ_CONFIG_TOKEN_BASE64}}", - "description": "{\"ProfileToken\":\"profile_1\"}" + "description": "Json: \n```json\n{\"ProfileToken\":\"PROFILE_3305967797\"}\n```\n\nBase64:\n```\neyJQcm9maWxlVG9rZW4iOiJQUk9GSUxFXzMzMDU5Njc3OTcifQ==\n```" } ] }, @@ -7377,7 +7351,7 @@ "MACAddress" ] }, - "description": "This command sets the MAC address associated with a device." + "description": "MACAddress can also be set via Edgex device command. This is useful for setting the MAC Address for devices which do not contain \nthe MAC Address in the Endpoint Reference Address, or have been added manually without a MAC Address. \nSince the MAC is used to map credentials for cameras, it is important to have this field filled out.\n\n> Note: When a camera successfully becomes `UpWithAuth`, the MAC Address is automatically queried and overridden by the system if available.\nDevice resource MACAddress is used to set `MACAddress` of a camera." }, "response": [ { @@ -7663,7 +7637,7 @@ "CustomMetadata" ] }, - "description": "This command returns the user specified custom metadata associated with a device." + "description": "**Get Custom Metadata**\nUse this command to return all of the data in the CustomMetadata field.\n\n**Get Specific Custom Metadata**\n\nPass the `CustomMetadata` resource a query to get specific field(s) in CustomMetadata. The query must be a base64 encoded json object with an array of fields you want to access.\n\n1. Json object holding an array of fields you want to query.\n```json\n'[\n \"Color\",\n \"Location\"\n]'\n```\n\n2. Use this command to convert the json object to base64.\n```shell\necho '[\n \"Color\",\n \"Location\"\n]' | base64\n```\n\n3. The response converted to base64.\n```\nWwogICAgIkNvbG9yIiwKICAgICJMb2NhdGlvbiIKXQo=\n```\n\n4. Use this command to query the fields you provided in the json object.\n```shell\ncurl http://localhost:59882/api/v2/device/name//CustomMetadata?jsonObject=WwogICAgIkNvbG9yIiwKICAgICJMb2NhdGlvbiIKXQo= | jq .\n```" }, "response": [ { @@ -7818,7 +7792,8 @@ "{{EDGEX_DEVICE_NAME}}", "CustomMetadata" ] - } + }, + "description": "Use the CustomMetadata resource to set the fields of `CustomMetadata`. Choose the key/value pairs to represent your custom fields." }, "response": [ { @@ -7926,7 +7901,8 @@ "{{EDGEX_DEVICE_NAME}}", "DeleteCustomMetadata" ] - } + }, + "description": "Use the `DeleteCustomMetadata` resource to delete entries in custom metadata" }, "response": [ { From ddc402424a16b21316db11748cb4739afdee7209 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Mon, 17 Oct 2022 23:16:54 -0700 Subject: [PATCH 03/15] docs: add validation camera matrix for swagger file Signed-off-by: Anthony Casagrande --- doc/openapi/.gitignore | 1 + doc/openapi/Makefile | 8 +- doc/openapi/python/__init__.py | 2 + doc/openapi/python/matrix.py | 110 ++ doc/openapi/python/postprocess.py | 78 +- doc/openapi/python/xmlstrip.py | 3 + doc/openapi/sidecar.yaml | 5 + doc/openapi/v2/device-onvif-camera.yaml | 1312 +++++++++++++++-------- 8 files changed, 1010 insertions(+), 509 deletions(-) create mode 100644 doc/openapi/python/__init__.py create mode 100644 doc/openapi/python/matrix.py diff --git a/doc/openapi/.gitignore b/doc/openapi/.gitignore index 6e193a4b..fc7d4edd 100644 --- a/doc/openapi/.gitignore +++ b/doc/openapi/.gitignore @@ -2,3 +2,4 @@ tmp/ ref/out/ schemas/_extracted.json openapi.json +python/__pycache__/ diff --git a/doc/openapi/Makefile b/doc/openapi/Makefile index 31e3d208..c6b35179 100644 --- a/doc/openapi/Makefile +++ b/doc/openapi/Makefile @@ -1,3 +1,5 @@ +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 .PHONY: gen install clean @@ -9,14 +11,16 @@ OPENAPI_TEMP_FILE = tmp/device-onvif-camera.yaml POSTMAN_2_OPENAPI_OPTIONS = p2o-options.json SIDECAR_FILE = sidecar.yaml PROFILE_FILE = ../../cmd/res/profiles/camera.yaml +ONVIF_TESTED_FILE = ../ONVIF-protocol.md +ONVIF_FOOTNOTES_FILE = ../onvif-footnotes.md # list of all services in the ./ref folder SERVICES = analytics device event imaging media media2 ptz # todo: replace the API version number based on the actual source code version -$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) python/postprocess.py Makefile - python3 python/postprocess.py $(OPENAPI_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) +$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) python/postprocess.py python/matrix.py Makefile + python3 python/postprocess.py $(OPENAPI_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) $(OPENAPI_TEMP_FILE): $(POSTMAN_COLLECTION) $(POSTMAN_2_OPENAPI_OPTIONS) | ./tmp p2o $(POSTMAN_COLLECTION) -f $(OPENAPI_TEMP_FILE) -o $(POSTMAN_2_OPENAPI_OPTIONS) > /dev/null diff --git a/doc/openapi/python/__init__.py b/doc/openapi/python/__init__.py new file mode 100644 index 00000000..6b0e0edd --- /dev/null +++ b/doc/openapi/python/__init__.py @@ -0,0 +1,2 @@ +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 diff --git a/doc/openapi/python/matrix.py b/doc/openapi/python/matrix.py new file mode 100644 index 00000000..24e323e0 --- /dev/null +++ b/doc/openapi/python/matrix.py @@ -0,0 +1,110 @@ +#!/usr/bin/env python3 +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + +from enum import Enum, auto +from dataclasses import dataclass, field +import sys +import os + +from ruamel.yaml import YAML + +yaml = YAML() + + +class State(Enum): + NotStarted = auto() + WantSection = auto() + NewSection = auto() + Commands = auto() + + +@dataclass +class CameraSupport: + camera: str + support: str + + +@dataclass +class Command: + section: str + func: str + cameras: dict = field(default_factory=dict) + + +@dataclass +class Section: + name: str + cameras: list = field(default_factory=list) + + +@dataclass +class MarkdownMatrix: + tested_file: str + footnotes_file: str + section: Section = None + state: State = State.NotStarted + validated: dict = field(default_factory=dict) + footnotes: dict = field(default_factory=dict) + + def _load_footnotes(self): + basename = os.path.basename(self.footnotes_file) + current_key = None + current_data = '' + with open(self.footnotes_file) as f: + while line := f.readline(): + if not line.startswith('### '): + if current_key is None: + continue + current_data += line.strip() + ' ' + else: + if current_key is not None: + self.footnotes[current_key] = current_data.strip() + current_data = '' + key = line.lstrip('### ').lower().replace(' ', '-').strip() + current_key = f'{basename}#{key}' + if current_key is not None: + self.footnotes[current_key] = current_data.strip() + + def parse(self): + self._load_footnotes() + with open(self.tested_file) as f: + i = 0 + for line in f: + i += 1 + line = line.strip() + if self.state == State.NotStarted: + if line.startswith('## Tested Onvif Cameras'): + self.state = State.WantSection + continue + + if line.startswith('### '): + self.state = State.NewSection + self.section = Section(line.lstrip('### ').strip()) + continue + + if self.state == State.NewSection: + if not line.startswith('| Onvif Web Service | Onvif Function'): + raise RuntimeError(f'Invalid state! Expected New section table!. Line #{i}: "{line.strip()}"') + tokens = line.lstrip('| Onvif Web Service | Onvif Function').split('|') + cameras = [x.strip() for x in tokens if x.strip() != ''] + self.section.cameras = cameras + self.state = State.Commands + elif self.state == State.Commands: + if not line.startswith('|'): + continue + fields = [x.strip() for x in line.split('|')][1:] + if fields[0].startswith('----'): + continue + command = Command(self.section.name, fields[1]) + for i in range(len(self.section.cameras)): + camera = self.section.cameras[i] + data = fields[i+2].strip() + if data == '': + continue # skip empty results + if '[ⓘ](' in data: + key = data[data.rfind('[ⓘ](')+4:-1] + if key in self.footnotes: + data = data[:data.rfind('[ⓘ]')] + self.footnotes[key] + command.cameras[camera] = data.strip() + self.validated[command.func] = command diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 5351bda8..41acea1f 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -1,15 +1,19 @@ #!/usr/bin/env python3 -import dataclasses +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + +from dataclasses import dataclass, field import sys import copy import textwrap from ruamel.yaml import YAML from ruamel.yaml.scalarstring import LiteralScalarString - yaml = YAML() +from matrix import MarkdownMatrix + EDGEX = 'EdgeX' EDGEX_DEVICE_NAME = 'Camera001' API_PREFIX = '/api/v2/device/name/{EDGEX_DEVICE_NAME}' @@ -28,9 +32,8 @@ # list of superfluous headers to remove from response objects HEADERS_TO_REMOVE = [ 'Content-Length', - 'Content-Type', 'Date', - 'Transfer-Encoding', + 'Transfer-Encoding' ] @@ -38,25 +41,28 @@ class ProcessingError(RuntimeError): pass -def make_scalar(val): +def multiline_string(val: str): + """Takes a string value and wraps it so that ruamel.yaml will format it as a raw multi-line string""" return LiteralScalarString(textwrap.dedent(val)) -def single_quote(s): +def single_quote(s: str): + """Returns the input value wrapped in single quote marks""" return f"'{s}'" -@dataclasses.dataclass +@dataclass class YamlProcessor: input_file: str sidecar_file: str profile_file: str output_file: str + matrix: MarkdownMatrix yml = None sidecar = None profile = None - resources = {} - wsdl_files = {} + resources: dict = field(default_factory=dict) + wsdl_files: dict = field(default_factory=dict) def _load(self): """Read input yaml file and sidecar yaml files""" @@ -72,6 +78,10 @@ def _load(self): with open(self.profile_file) as f: self.profile = yaml.load(f) + print(f'Loading validation matrix file: {self.matrix.tested_file}') + print(f'Loading footnotes file: {self.matrix.footnotes_file}') + self.matrix.parse() + def _parse(self): """Parse the device resources into a lookup table""" for resource in self.profile['deviceResources']: @@ -85,7 +95,11 @@ def _write(self): def _process_apis(self): """ - Sideload externalDocs using EdgeX profile file, update descriptions, and set schemas + - Side-load externalDocs using EdgeX profile file + - update descriptions + - set schemas + - add response codes + etc... """ for path, path_obj in self.yml['paths'].items(): @@ -118,13 +132,11 @@ def _process_apis(self): # clone the 200 response to avoid mangling pointer references resp_200 = copy.deepcopy(method_obj['responses']['200']) # apply the defined schema - resp_200['content']['application/json']['schema'] = self.sidecar['responses']['edgex'][ - cmd] + resp_200['content']['application/json']['schema'] = self.sidecar['responses']['edgex'][cmd] # override with cloned one method_obj['responses']['200'] = resp_200 else: - print( - f'\033[33m[WARNING] \t -- Missing schema response definition for EdgeX command {method.upper()} {cmd}\033[0m') + print(f'\033[33m[WARNING] \t -- Missing schema response definition for EdgeX command {method.upper()} {cmd}\033[0m') elif method == 'put': if cmd in self.sidecar['requests']['edgex']: # look for the json response object, so we can modify it @@ -143,8 +155,7 @@ def _process_apis(self): 'type': 'object' } else: - print( - f'\033[33m[WARNING] \t -- Missing schema request definition for EdgeX command {method.upper()} {cmd}\033[0m') + print(f'\033[33m[WARNING] \t -- Missing schema request definition for EdgeX command {method.upper()} {cmd}\033[0m') # override the response schema with default 200 response method_obj['responses']['200'] = self.sidecar['responses']['canned']['200'] @@ -170,6 +181,13 @@ def _process_apis(self): print(f'Copying description for {service}_{fn}') method_obj['description'] = api['description'] + if fn in self.matrix.validated: + print(f'Patching validated camera list for {fn}') + val_desc = f'
\n\n| Camera | Supported? |\n|-------|-------|\n' + for camera, result in self.matrix.validated[fn].cameras.items(): + val_desc += f'| {camera} | {result} |\n' + method_obj['description'] = multiline_string(method_obj['description'] + val_desc) + # Special handling for PUT calls: # - Move example out of schema into json object itself # - Patch the input body schema based on the EdgeX command name and the Onvif function name @@ -243,6 +261,9 @@ def _process_apis(self): method_obj['parameters'].insert(0, param) def _set_json_object(self, param, service, fn): + """ + This sets the param (which is a jsonObject param) description field to include auto-generated docs + """ desc = f'''**Format:**
This field is a Base64 encoded json string. @@ -256,6 +277,7 @@ def _set_json_object(self, param, service, fn): **Schema Reference:** [{service.lower()}_{fn}](#{service.lower()}_{fn}) ''' + # if there is a description in the original data, append it here before it gets overridden if 'description' in param: desc += f''' **Example:**
@@ -263,7 +285,7 @@ def _set_json_object(self, param, service, fn): {param['description']} ``` ''' - param['description'] = make_scalar(desc) + param['description'] = multiline_string(desc) # todo: setting the format to Base64 messes with the Swagger UI, and makes it # choose file box, which does not end up working # param['schema']['format'] = 'base64' @@ -309,6 +331,7 @@ def _gen_field_desc_for(self, typ): return self._gen_field_desc(None, '', self.yml['components']['schemas'][typ], indent=0, all_types=set(typ)) def _gen_field_desc(self, name, desc, val, indent, all_types): + """Internal recursive field description generator""" if 'allOf' in val: desc2 = '' if len(val['allOf']) > 1 and 'description' in val['allOf'][1]: @@ -352,14 +375,7 @@ def _gen_pretty_schema_for(self, typ): return self._gen_pretty_schema(None, self.yml['components']['schemas'][typ], indent=0, all_types=set(typ)) def _gen_pretty_schema(self, name, val, indent, all_types): - """ - Recursively generates a pretty json schema - :param name: - :param val: - :param indent: - :param all_types: - :return: - """ + """Internal recursive pretty json schema generator""" if 'allOf' in val: return self._gen_pretty_schema(name, val['allOf'][0], indent, all_types) if '$ref' in val: @@ -399,9 +415,7 @@ def _gen_pretty_schema(self, name, val, indent, all_types): raise ProcessingError('unsupported data type') def _verify_complete(self): - """ - _verify_complete checks that all functions from the device profile exist in the openapi file - """ + """Checks that all functions from the device profile exist in the openapi file""" for cmd, cmd_obj in self.resources.items(): if cmd_obj['isHidden'] is True: continue # skip hidden commands (not callable by the core-command service) @@ -434,7 +448,7 @@ def _add_example_vars(self): def _clean_response_headers(self): """ - Remove superfluous headers from response objects - - Patches X-Correlation-Id header + - Patches X-Correlation-Id header to be a $ref """ for _, path_obj in self.yml['paths'].items(): for _, method_obj in path_obj.items(): @@ -462,11 +476,11 @@ def process(self): def main(): - if len(sys.argv) != 5: - print(f'Usage: {sys.argv[0]} ') + if len(sys.argv) != 7: + print(f'Usage: {sys.argv[0]} ') sys.exit(1) - proc = YamlProcessor(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4]) + proc = YamlProcessor(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4], MarkdownMatrix(sys.argv[5], sys.argv[6])) proc.process() diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py index 63abd710..118a27aa 100755 --- a/doc/openapi/python/xmlstrip.py +++ b/doc/openapi/python/xmlstrip.py @@ -1,5 +1,8 @@ #!/usr/bin/env python3 +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + import re import sys import yaml diff --git a/doc/openapi/sidecar.yaml b/doc/openapi/sidecar.yaml index 7e8a99ff..afe341e7 100644 --- a/doc/openapi/sidecar.yaml +++ b/doc/openapi/sidecar.yaml @@ -1,3 +1,6 @@ +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 + # This file contains additional OpenAPI metadata to be side-loaded into the final OpenAPI document # Note: Due to the use of ruamel.yaml, any blank lines or comments below will be copied as-is to the output file @@ -30,6 +33,8 @@ requests: type: string CustomMetadata: type: object + additionalProperties: + type: string DeleteCustomMetadata: type: array items: diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 94099ecf..f19c6281 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -35,10 +35,15 @@ paths: tags: - Network Configuration summary: Hostname - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -54,6 +59,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -158,14 +167,16 @@ paths: tags: - Network Configuration summary: SetHostname - description: >- - This operation sets the hostname on a device. It shall be possible to - set the device hostname configurations through the SetHostname - command. + 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 formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings.
- A device shall accept string formatted according to RFC 1123 section 2.1 - or alternatively to RFC 952, other string shall be considered as invalid - strings. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -216,9 +227,15 @@ paths: tags: - Network Configuration summary: DNS - description: >- - This operation gets the DNS settings from a device. The device shall - return its DNS configurations through the GetDNS command. + description: | + This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -234,6 +251,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -281,9 +302,15 @@ paths: tags: - Network Configuration summary: SetDNS - description: >- - This operation sets the DNS settings on a device. It shall be possible - to set the device DNS configurations through the SetDNS command. + description: | + This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -326,11 +353,15 @@ paths: tags: - Network Configuration summary: NetworkInterfaces - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -346,6 +377,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -406,15 +441,17 @@ paths: tags: - Network Configuration summary: SetNetworkInterfaces - 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -458,10 +495,15 @@ paths: tags: - Network Configuration summary: NetworkProtocols - description: >- - This operation gets defined network protocols from a device. The device - shall support the GetNetworkProtocols command returning configured - network protocols. + description: | + This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -477,6 +519,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -530,10 +576,15 @@ paths: tags: - Network Configuration summary: SetNetworkProtocols - description: >- - This operation configures defined network protocols on a device. The - device shall support configuration of defined network protocols through - the SetNetworkProtocols command. + description: | + This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -582,10 +633,15 @@ paths: tags: - Network Configuration summary: NetworkDefaultGateway - description: >- - This operation gets the default gateway settings from a device. The - device shall support the GetNetworkDefaultGateway command returning - configured default gateway address(es). + description: | + This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es).
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -601,6 +657,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -648,10 +708,15 @@ paths: tags: - Network Configuration summary: SetNetworkDefaultGateway - description: >- - This operation sets the default gateway settings on a device. The device - shall support configuration of default gateway through the - SetNetworkDefaultGateway command. + description: | + This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -709,6 +774,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -840,6 +909,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -854,7 +927,15 @@ paths: tags: - System Function summary: DeviceInformation - description: This operation gets basic device information from the device. + description: | + This operation gets basic device information from the device.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -870,6 +951,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -922,14 +1007,17 @@ paths: tags: - System Function summary: SystemDateAndTime - 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. + 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.
- A device shall provide the UTCDateTime information. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -945,6 +1033,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1014,24 +1106,21 @@ paths: tags: - System Function summary: SetSystemDateAndTime - 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. + 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. - 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -1081,9 +1170,15 @@ paths: tags: - System Function summary: SetSystemFactoryDefault - description: >- - This operation reloads the parameters on the device to their factory - default values. + description: | + This operation reloads the parameters on the device to their factory default values.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -1141,6 +1236,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1214,10 +1313,15 @@ paths: tags: - Metadata Configuration summary: MetadataConfigurations - description: >- - This operation lists all existing metadata configurations. The client - need not know anything apriori about the metadata in order to use the - command. + description: | + This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -1233,6 +1337,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1281,9 +1389,15 @@ paths: tags: - Metadata Configuration summary: MetadataConfiguration - description: >- - The GetMetadataConfiguration command fetches the metadata configuration - if the metadata token is known. + description: | + The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: jsonObject in: query @@ -1321,6 +1435,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1368,15 +1486,15 @@ paths: tags: - Metadata Configuration summary: SetMetadataConfiguration - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -1419,13 +1537,15 @@ paths: tags: - Metadata Configuration summary: CompatibleMetadataConfigurations - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: jsonObject in: query @@ -1463,6 +1583,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1511,10 +1635,15 @@ paths: tags: - Metadata Configuration summary: MetadataConfigurationOptions - description: >- - This operation returns the available options (supported values and - ranges for metadata configuration parameters) for changing the metadata - configuration. + description: | + This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: jsonObject in: query @@ -1555,6 +1684,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1603,12 +1736,15 @@ paths: tags: - Metadata Configuration summary: AddMetadataConfiguration - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -1649,10 +1785,15 @@ paths: tags: - Metadata Configuration summary: RemoveMetadataConfiguration - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -1692,12 +1833,15 @@ paths: tags: - Video Streaming summary: Profiles - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -1713,6 +1857,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -1993,35 +2141,24 @@ paths: tags: - Video Streaming summary: StreamUri - 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: + 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). - RTP unicast over UDP: StreamType = "RTP_unicast", TransportProtocol = - "UDP" + 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" - RTP over RTSP over HTTP over TCP: StreamType = "RTP_unicast", - TransportProtocol = "HTTP" + If a multicast stream is requested at least one of VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration shall have a valid multicast setting. - RTP over RTSP over TCP: StreamType = "RTP_unicast", TransportProtocol = - "RTSP" + For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets.
- - 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: jsonObject in: query @@ -2082,6 +2219,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2155,6 +2296,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2212,6 +2357,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2283,10 +2432,15 @@ paths: tags: - Video Encoder Configuration summary: VideoEncoderConfiguration - description: >- - If the video encoder configuration token is already known, the encoder - configuration can be fetched through the GetVideoEncoderConfiguration - command. + description: | + If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: jsonObject in: query @@ -2324,6 +2478,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2394,22 +2552,17 @@ paths: tags: - Video Encoder Configuration summary: SetVideoEncoderConfiguration - 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -2452,6 +2605,10 @@ paths: '500': description: Internal Server Error headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2484,24 +2641,19 @@ paths: tags: - Video Encoder Configuration summary: VideoEncoderConfigurationOptions - description: >- - This operation returns the available options (supported values and - ranges for video encoder configuration parameters) when the video - encoder parameters are reconfigured. + 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. - 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.
- - 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: jsonObject in: query @@ -2542,6 +2694,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2635,11 +2791,15 @@ paths: tags: - User Handling summary: Get users - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -2655,6 +2815,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2706,18 +2870,17 @@ paths: tags: - User Handling summary: Set users - 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -2763,18 +2926,17 @@ paths: tags: - User Handling summary: Create Users - 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -2820,13 +2982,15 @@ paths: tags: - User Handling summary: Delete users - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -2868,11 +3032,15 @@ paths: tags: - Auto Discovery summary: GetDiscoveryMode - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -2888,6 +3056,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -2935,11 +3107,15 @@ paths: tags: - Auto Discovery summary: Set DiscoveryMode - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -2979,11 +3155,15 @@ paths: tags: - Auto Discovery summary: Add Scopes - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -3024,21 +3204,18 @@ paths: tags: - Auto Discovery summary: Get Scopes - 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: - + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3054,6 +3231,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3111,12 +3292,15 @@ paths: tags: - Auto Discovery summary: Put Scopes - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -3157,11 +3341,15 @@ paths: tags: - Auto Discovery summary: Remove Scopes - 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 + 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
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ✔ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ✔ | requestBody: content: application/json: @@ -3191,6 +3379,10 @@ paths: '500': description: Internal Server Error headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3223,15 +3415,17 @@ paths: tags: - PTZ - Capabilities summary: GetNodes - description: >- + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3247,6 +3441,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3353,7 +3551,15 @@ paths: tags: - PTZ - Capabilities summary: GetNode - description: Get a specific PTZ Node identified by a reference token or a name. + description: | + Get a specific PTZ Node identified by a reference token or a name.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -3396,6 +3602,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3502,28 +3712,17 @@ paths: tags: - PTZ - Configuration summary: GetConfigurations - description: >- + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3539,6 +3738,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3605,31 +3808,19 @@ paths: tags: - PTZ - Configuration summary: GetConfiguration - description: >- - Get a specific PTZconfiguration from the device, identified by its - reference token or name. - + 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 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -3672,6 +3863,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3737,7 +3932,15 @@ paths: tags: - PTZ - Configuration summary: SetConfiguration - description: Set/update a existing PTZConfiguration on the device. + description: | + Set/update a existing PTZConfiguration on the device.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -3787,15 +3990,15 @@ paths: tags: - PTZ - Configuration summary: GetConfigurationOptions - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -3838,6 +4041,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -3944,7 +4151,15 @@ paths: tags: - PTZ - Configuration summary: AddPTZConfiguration - description: Add a new PTZConfiguration on the device. + description: | + Add a new PTZConfiguration on the device.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -3985,7 +4200,15 @@ paths: tags: - PTZ - Configuration summary: RemovePTZConfiguration - description: Remove a PTZConfiguration on the device. + description: | + Remove a PTZConfiguration on the device.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4025,14 +4248,17 @@ paths: tags: - PTZ - Actuation summary: AbsoluteMove - description: >- + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4076,16 +4302,17 @@ paths: tags: - PTZ - Actuation summary: RelativeMove - 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4129,11 +4356,15 @@ paths: tags: - PTZ - Actuation summary: ContinuousMove - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4177,7 +4408,15 @@ paths: tags: - PTZ - Actuation summary: GetStatus - description: Operation to request PTZ status for the Node in the selected profile. + description: | + Operation to request PTZ status for the Node in the selected profile.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -4220,6 +4459,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -4277,10 +4520,15 @@ paths: tags: - PTZ - Actuation summary: Stop - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4321,18 +4569,15 @@ paths: tags: - PTZ - Preset summary: SetPreset - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4373,10 +4618,15 @@ paths: tags: - PTZ - Preset summary: GetPresets - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -4427,6 +4677,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -4499,10 +4753,15 @@ paths: tags: - PTZ - Preset summary: GotoPreset - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4543,10 +4802,15 @@ paths: tags: - PTZ - Preset summary: RemovePreset - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ✔ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4587,9 +4851,15 @@ paths: tags: - PTZ - Home Position summary: GotoHomePosition - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4629,12 +4899,15 @@ paths: tags: - PTZ - Home Position summary: SetHomePosition - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4674,44 +4947,29 @@ paths: tags: - PTZ - Auxiliary summary: SendAuxiliaryCommand - 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. + 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. - + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -4774,6 +5032,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -5077,12 +5339,15 @@ paths: tags: - Analytics - Profile Configuration summary: GetProfiles - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -5122,6 +5387,10 @@ paths: '500': description: Internal Server Error headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -5174,11 +5443,15 @@ paths: tags: - Analytics - Profile Configuration summary: GetAnalyticsConfigurations - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: EDGEX_DEVICE_NAME in: path @@ -5194,6 +5467,10 @@ paths: '500': description: Internal Server Error headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -5247,15 +5524,17 @@ paths: tags: - Analytics - Profile Configuration summary: AddConfiguration - 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. + 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.
- Note that OSD elements must be added via the CreateOSD command. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -5298,10 +5577,15 @@ paths: tags: - Analytics - Profile Configuration summary: RemoveConfiguration - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -5344,9 +5628,15 @@ paths: tags: - Analytics - Modules summary: GetSupportedAnalyticsModules - description: >- - List all analytics modules that are supported by the given - VideoAnalyticsConfiguration. + description: | + List all analytics modules that are supported by the given VideoAnalyticsConfiguration.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -5414,9 +5704,15 @@ paths: tags: - Analytics - Modules summary: GetAnalyticsModules - description: >- - List the currently assigned set of analytics modules of a - VideoAnalyticsConfiguration. + description: | + List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -5454,6 +5750,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -5507,10 +5807,15 @@ paths: tags: - Analytics - Modules summary: ModifyAnalyticsModules - 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. + 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.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -5557,35 +5862,21 @@ paths: tags: - Analytics - Modules summary: CreateAnalyticsModules - 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. + 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -5632,9 +5923,15 @@ paths: tags: - Analytics - Modules summary: DeleteAnalyticsModules - description: >- - Remove one or more analytics modules from a VideoAnalyticsConfiguration - referenced by their names. + description: | + Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ❌ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -5676,9 +5973,15 @@ paths: tags: - Analytics - Modules summary: GetAnalyticsModuleOptions - description: >- - Return the options for the supported analytics modules that specify an - Option attribute. + description: | + Return the options for the supported analytics modules that specify an Option attribute.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -5719,6 +6022,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -5772,9 +6079,15 @@ paths: tags: - Analytics - Rules summary: GetSupportedRules - description: >- - List all rules that are supported by the given - VideoAnalyticsConfiguration. + description: | + List all rules that are supported by the given VideoAnalyticsConfiguration.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -5813,6 +6126,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -6012,9 +6329,15 @@ paths: tags: - Analytics - Rules summary: GetRules - description: >- - List the currently assigned set of rules of a - VideoAnalyticsConfiguration. + description: | + List the currently assigned set of rules of a VideoAnalyticsConfiguration.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -6052,6 +6375,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -6111,9 +6438,15 @@ paths: tags: - Analytics - Rules summary: ModifyRules - description: >- - Modify one or more rules of a VideoAnalyticsConfiguration. The rules are - referenced by their names. + description: | + Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -6160,9 +6493,15 @@ paths: tags: - Analytics - Rules summary: GetRuleOptions - description: >- - Return the options for the supported rules that specify an Option - attribute. + description: | + Return the options for the supported rules that specify an Option attribute.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | parameters: - name: jsonObject in: query @@ -6203,6 +6542,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -6259,22 +6602,19 @@ paths: tags: - Analytics - Rules summary: CreateRules - 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. - + 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. + 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.
- 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. + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -6329,7 +6669,15 @@ paths: tags: - Analytics - Rules summary: DeleteRules - description: Remove one or more rules from a VideoAnalyticsConfiguration. + description: | + Remove one or more rules from a VideoAnalyticsConfiguration.
+ + | Camera | Supported? | + |-------|-------| + | Hikvision DFI6256TE | ❌ | + | Tapo C200 | ❌ | + | BOSCH DINION IP starlight 6000 HD | ✔ | + | GeoVision GV-BX8700 | ❌ | requestBody: content: application/json: @@ -6387,6 +6735,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -6489,6 +6841,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -6633,6 +6989,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -6706,6 +7066,8 @@ paths: properties: CustomMetadata: type: object + additionalProperties: + type: string required: - CustomMetadata type: object From 3cb33cdf5438b92aa5f3efd3ec84d2543962f520 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Tue, 18 Oct 2022 13:59:33 -0700 Subject: [PATCH 04/15] docs: cleanup swagger generation code Signed-off-by: Anthony Casagrande --- doc/ONVIF-protocol.md | 14 +- doc/openapi/python/matrix.py | 28 +- doc/openapi/python/postprocess.py | 84 +- doc/openapi/python/xmlstrip.py | 2 +- doc/openapi/v2/device-onvif-camera.yaml | 1717 ++++++++++++++--------- 5 files changed, 1161 insertions(+), 684 deletions(-) diff --git a/doc/ONVIF-protocol.md b/doc/ONVIF-protocol.md index 362c7ca5..acbdac14 100644 --- a/doc/ONVIF-protocol.md +++ b/doc/ONVIF-protocol.md @@ -251,13 +251,13 @@ The following table shows the Onvif functions tested for various Onvif cameras: | | SetNetworkDefaultGateway | ✔ | ❌ | ✔ | ✔ | | ### System Function -| Onvif Web Service | Onvif Function | Hikvision DFI6256TE | Tapo C200 | BOSCH DINION IP starlight 6000 HD | GeoVision GV-BX8700 | Happytime Simulator | -|-------------------|-------------------------|---------------------|-----------|-----------------------------------|---------------------|---------------------| -| **Device** | GetDeviceInformation | ✔ | ✔ | ✔ | ✔ | | -| | GetSystemDateAndTime | ✔ | ✔ | ✔ | ✔ | | -| | SetSystemDateAndTime | ✔ | ✔ [ⓘ](onvif-footnotes.md#tapo-c200---setsystemdateandtime) | ✔ | ✔ | | -| | SetSystemFactoryDefault | ✔ | ✔ | ✔ | ✔ | | -| | Reboot | ✔ | ✔ | ✔ | ✔ | | +| Onvif Web Service | Onvif Function | Hikvision DFI6256TE | Tapo C200 | BOSCH DINION IP starlight 6000 HD | GeoVision GV-BX8700 | Happytime Simulator | +|-------------------|-------------------------|---------------------|------------------------------------------------------------|-----------------------------------|---------------------|---------------------| +| **Device** | GetDeviceInformation | ✔ | ✔ | ✔ | ✔ | | +| | GetSystemDateAndTime | ✔ | ✔ | ✔ | ✔ | | +| | SetSystemDateAndTime | ✔ | ✔ [ⓘ](onvif-footnotes.md#tapo-c200---setsystemdateandtime) | ✔ | ✔ | | +| | SetSystemFactoryDefault | ✔ | ✔ | ✔ | ✔ | | +| | Reboot | ✔ | ✔ | ✔ | ✔ | | ### User Handling | Onvif Web Service | Onvif Function | Hikvision DFI6256TE | Tapo C200 | BOSCH DINION IP starlight 6000 HD | GeoVision GV-BX8700 | Happytime Simulator | diff --git a/doc/openapi/python/matrix.py b/doc/openapi/python/matrix.py index 24e323e0..c68ec3fe 100644 --- a/doc/openapi/python/matrix.py +++ b/doc/openapi/python/matrix.py @@ -23,14 +23,20 @@ class State(Enum): class CameraSupport: camera: str support: str + notes: str = '' @dataclass class Command: section: str + service: str func: str cameras: dict = field(default_factory=dict) + @property + def qualified_name(self): + return f'{self.service}_{self.func}' + @dataclass class Section: @@ -43,6 +49,7 @@ class MarkdownMatrix: tested_file: str footnotes_file: str section: Section = None + service: str = '' state: State = State.NotStarted validated: dict = field(default_factory=dict) footnotes: dict = field(default_factory=dict) @@ -95,16 +102,27 @@ def parse(self): continue fields = [x.strip() for x in line.split('|')][1:] if fields[0].startswith('----'): - continue - command = Command(self.section.name, fields[1]) + continue # skip post-header line + + if fields[0].startswith('**'): + # the service name is only placed on lines where it changes. cache the + # service name and only change it when a new one is found. Format: **ServiceName** + self.service = fields[0].strip('*') + + command = Command(self.section.name, self.service, fields[1]) for i in range(len(self.section.cameras)): camera = self.section.cameras[i] data = fields[i+2].strip() + notes = '' if data == '': continue # skip empty results + + # replace footnotes link with actual footnotes data if '[ⓘ](' in data: key = data[data.rfind('[ⓘ](')+4:-1] if key in self.footnotes: - data = data[:data.rfind('[ⓘ]')] + self.footnotes[key] - command.cameras[camera] = data.strip() - self.validated[command.func] = command + data = data[:data.rfind('[ⓘ]')] + notes = self.footnotes[key] + + command.cameras[camera] = CameraSupport(camera, data.replace('✔', '✔️').strip(), notes) + self.validated[command.qualified_name] = command diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 41acea1f..7c425b83 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -2,7 +2,6 @@ # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 - from dataclasses import dataclass, field import sys import copy @@ -10,10 +9,11 @@ from ruamel.yaml import YAML from ruamel.yaml.scalarstring import LiteralScalarString -yaml = YAML() from matrix import MarkdownMatrix +yaml = YAML() + EDGEX = 'EdgeX' EDGEX_DEVICE_NAME = 'Camera001' API_PREFIX = '/api/v2/device/name/{EDGEX_DEVICE_NAME}' @@ -111,6 +111,7 @@ def _process_apis(self): attrs = self.resources[cmd]['attributes'] fn = attrs[f'{prefix}Function'] service = attrs['service'] + service_fn = f'{service}_{fn}' # add all responses for code, resp_obj in self.sidecar['responses']['canned'].items(): @@ -122,7 +123,7 @@ def _process_apis(self): len(content['application/json']) == 0 or \ ('example' in content['application/json'] and len( content['application/json']['example']) == 2): - print(f'Overriding empty 200 response for {service}_{fn}') + print(f'Overriding empty 200 response for {service_fn}') method_obj['responses'][code] = resp_obj if service == EDGEX: @@ -136,7 +137,7 @@ def _process_apis(self): # override with cloned one method_obj['responses']['200'] = resp_200 else: - print(f'\033[33m[WARNING] \t -- Missing schema response definition for EdgeX command {method.upper()} {cmd}\033[0m') + print(f'\033[33m[WARNING] *** Missing schema response definition for EdgeX command {method.upper()} {cmd} ***\033[0m') elif method == 'put': if cmd in self.sidecar['requests']['edgex']: # look for the json response object, so we can modify it @@ -155,38 +156,53 @@ def _process_apis(self): 'type': 'object' } else: - print(f'\033[33m[WARNING] \t -- Missing schema request definition for EdgeX command {method.upper()} {cmd}\033[0m') + print(f'\033[33m[WARNING] *** Missing schema request definition for EdgeX command {method.upper()} {cmd} ***\033[0m') # override the response schema with default 200 response method_obj['responses']['200'] = self.sidecar['responses']['canned']['200'] + else: + # --- ONVIF function patching --- + method_obj = path_obj[method] + method_obj['externalDocs'] = { + 'description': 'Onvif Specification', + 'url': f'{SERVICE_WSDL[service]}#op.{fn}' + } + + # patch description for endpoints missing it + paths = self.wsdl_files[service]['paths'] + if f'/{fn}' in paths: + # note: all SOAP calls are POST + api = paths[f'/{fn}']['post'] + if 'description' in api and \ + ('description' not in method_obj or method_obj['description'].strip() == ''): + print(f'Copying description for {service_fn}') + method_obj['description'] = api['description'] + + if service_fn in self.matrix.validated: + print(f'Adding validated camera list in description for {service_fn}') + val_desc = f''' + +
+Tested Camera Models + +Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + +| Camera | Supported?    | Notes | +|--------|:------------|-------| +''' + for camera, support in self.matrix.validated[service_fn].cameras.items(): + val_desc += f'| **{camera}** | {support.support} | {support.notes} |\n' + method_obj['description'] = multiline_string(method_obj['description'] + val_desc + '
') + elif service != EDGEX: + # only print warning for non-EdgeX functions + print(f'\033[33m[WARNING] *** Missing camera validation entry for command {service_fn} ***\033[0m') + + if service == EDGEX: # nothing left to patch for custom edgex functions, as they do not exist in onvif spec continue - # --- ONVIF function patching --- - - method_obj = path_obj[method] - method_obj['externalDocs'] = { - 'description': 'Onvif Specification', - 'url': f'{SERVICE_WSDL[service]}#op.{fn}' - } - - # patch description for endpoints missing it - paths = self.wsdl_files[service]['paths'] - if f'/{fn}' in paths: - # note: all SOAP calls are POST - api = paths[f'/{fn}']['post'] - if 'description' in api and \ - ('description' not in method_obj or method_obj['description'].strip() == ''): - print(f'Copying description for {service}_{fn}') - method_obj['description'] = api['description'] - - if fn in self.matrix.validated: - print(f'Patching validated camera list for {fn}') - val_desc = f'
\n\n| Camera | Supported? |\n|-------|-------|\n' - for camera, result in self.matrix.validated[fn].cameras.items(): - val_desc += f'| {camera} | {result} |\n' - method_obj['description'] = multiline_string(method_obj['description'] + val_desc) + # --- More ONVIF function patching --- # Special handling for PUT calls: # - Move example out of schema into json object itself @@ -240,7 +256,7 @@ def _process_apis(self): if req_schema in self.yml['components']['schemas']: schema = self.yml['components']['schemas'][req_schema] if 'type' in schema and schema['type'] == 'object' and len(schema) == 1: - print(f'Skipping empty request schema for {service}_{fn}') + print(f'Skipping empty request schema for {service_fn}') else: found = False for param in method_obj['parameters']: @@ -249,7 +265,7 @@ def _process_apis(self): self._set_json_object(param, service, fn) break if not found: - print(f'\033[33m[WARNING] \t -- Expected jsonObject parameter for command {cmd}! Creating one.\033[0m') + print(f'\033[33m[WARNING] *** Expected jsonObject parameter for command {cmd}! Creating one. ***\033[0m') param = { 'name': 'jsonObject', 'in': 'query', @@ -423,14 +439,14 @@ def _verify_complete(self): api = f'{API_PREFIX}/{cmd}' path_obj = None if api not in self.yml['paths']: - print(f'\033[33m[WARNING] API "{api}" is missing from input collection!\033[0m') + print(f'\033[33m[WARNING] API "{api}" is missing from input collection! ***\033[0m') else: path_obj = self.yml['paths'][api] if 'getFunction' in cmd_obj['attributes'] and (path_obj is None or 'get' not in path_obj): - print(f'\033[33m[WARNING] \t -- Expected call GET "{cmd}" was not found in input yaml!\033[0m') + print(f'\033[33m[WARNING] *** Expected call GET "{cmd}" was not found in input yaml! ***\033[0m') if 'setFunction' in cmd_obj['attributes'] and (path_obj is None or 'put' not in path_obj): - print(f'\033[33m[WARNING] \t -- Expected call PUT "{cmd}" was not found in input yaml!\033[0m') + print(f'\033[33m[WARNING] *** Expected call PUT "{cmd}" was not found in input yaml! ***\033[0m') def _add_example_vars(self): """ diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py index 118a27aa..e3a25a8f 100755 --- a/doc/openapi/python/xmlstrip.py +++ b/doc/openapi/python/xmlstrip.py @@ -32,7 +32,7 @@ def main(): service = sys.argv[1] with open(sys.argv[3], 'w') as w: - # todo: this can be optimized better using streams. Right now it Dumps the yaml to a string + # todo: this can be optimized better using streams. Right now it dumps the yaml to a string # and then processes each raw line before actually writing it to the output file. lines = yaml.dump(yml).split('\n') for line in lines: diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index d7f61a86..8e1e6f66 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -35,15 +35,21 @@ paths: tags: - Network Configuration summary: Hostname - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -167,16 +173,22 @@ paths: tags: - Network Configuration summary: SetHostname - description: | + 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 formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + A device shall accept string formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -227,15 +239,21 @@ paths: tags: - Network Configuration summary: DNS - description: | - This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -302,15 +320,21 @@ paths: tags: - Network Configuration summary: SetDNS - description: | - This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -353,15 +377,21 @@ paths: tags: - Network Configuration summary: NetworkInterfaces - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -441,17 +471,23 @@ paths: tags: - Network Configuration summary: SetNetworkInterfaces - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -495,15 +531,21 @@ paths: tags: - Network Configuration summary: NetworkProtocols - description: | - This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -576,15 +618,21 @@ paths: tags: - Network Configuration summary: SetNetworkProtocols - description: | - This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -633,15 +681,21 @@ paths: tags: - Network Configuration summary: NetworkDefaultGateway - description: | - This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es).
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es). + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -708,15 +762,21 @@ paths: tags: - Network Configuration summary: SetNetworkDefaultGateway - description: | - This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -927,15 +987,21 @@ paths: tags: - System Function summary: DeviceInformation - description: | - This operation gets basic device information from the device.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation gets basic device information from the device. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -1007,17 +1073,23 @@ paths: tags: - System Function summary: SystemDateAndTime - description: | + 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.
+ A device shall provide the UTCDateTime information. + +
+ Tested Camera Models - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -1108,21 +1180,27 @@ paths: tags: - System Function summary: SetSystemDateAndTime - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ Tapo does not support setting the `DaylightSavings` field to `false`. Regardless of the setting, the camera will always use daylight savings time. | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | Tapo does not support setting the `DaylightSavings` field to `false`. Regardless of the setting, the camera will always use daylight savings time. | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -1172,15 +1250,21 @@ paths: tags: - System Function summary: SetSystemFactoryDefault - description: | - This operation reloads the parameters on the device to their factory default values.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation reloads the parameters on the device to their factory default values. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -1315,15 +1399,21 @@ paths: tags: - Metadata Configuration summary: MetadataConfigurations - description: | - This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -1391,15 +1481,21 @@ paths: tags: - Metadata Configuration summary: MetadataConfiguration - description: | - The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: jsonObject in: query @@ -1488,15 +1584,21 @@ paths: tags: - Metadata Configuration summary: SetMetadataConfiguration - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -1539,15 +1641,21 @@ paths: tags: - Metadata Configuration summary: CompatibleMetadataConfigurations - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: jsonObject in: query @@ -1637,15 +1745,21 @@ paths: tags: - Metadata Configuration summary: MetadataConfigurationOptions - description: | - This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: jsonObject in: query @@ -1738,15 +1852,21 @@ paths: tags: - Metadata Configuration summary: AddMetadataConfiguration - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -1787,15 +1907,21 @@ paths: tags: - Metadata Configuration summary: RemoveMetadataConfiguration - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -1835,15 +1961,21 @@ paths: tags: - Video Streaming summary: Profiles - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -2143,7 +2275,7 @@ paths: tags: - Video Streaming summary: StreamUri - description: | + 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: @@ -2153,14 +2285,20 @@ paths: 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.
+ For full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: jsonObject in: query @@ -2277,12 +2415,23 @@ paths: tags: - Video Streaming summary: Snapshot - description: >- - This request returns a snapshot of the video stream at the time the - command is given. - + description: |- + This request returns a snapshot of the video stream at the time the command is given. It is returned in a binary format. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | You must use `Digest Auth` or `Both` as the Auth-Mode in order for this to work. | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -2434,15 +2583,21 @@ paths: tags: - Video Encoder Configuration summary: VideoEncoderConfiguration - description: | - If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + description: |- + If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: jsonObject in: query @@ -2554,17 +2709,23 @@ paths: tags: - Video Encoder Configuration summary: SetVideoEncoderConfiguration - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -2643,19 +2804,25 @@ paths: tags: - Video Encoder Configuration summary: VideoEncoderConfigurationOptions - description: | + 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.
+ 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. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: jsonObject in: query @@ -2793,15 +2960,21 @@ paths: tags: - User Handling summary: Get users - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -2872,17 +3045,23 @@ paths: tags: - User Handling summary: Set users - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -2928,17 +3107,23 @@ paths: tags: - User Handling summary: Create Users - description: | + 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.
+ 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. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -2984,15 +3169,21 @@ paths: tags: - User Handling summary: Delete users - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -3034,15 +3225,21 @@ paths: tags: - Auto Discovery summary: GetDiscoveryMode - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3109,15 +3306,21 @@ paths: tags: - Auto Discovery summary: Set DiscoveryMode - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -3157,15 +3360,21 @@ paths: tags: - Auto Discovery summary: Add Scopes - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -3206,18 +3415,24 @@ paths: tags: - Auto Discovery summary: Get Scopes - description: | + 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3294,15 +3509,21 @@ paths: tags: - Auto Discovery summary: Put Scopes - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -3343,15 +3564,21 @@ paths: tags: - Auto Discovery summary: Remove Scopes - 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
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ✔ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ✔ | + 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 + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
requestBody: content: application/json: @@ -3417,17 +3644,23 @@ paths: tags: - PTZ - Capabilities summary: GetNodes - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3553,15 +3786,21 @@ paths: tags: - PTZ - Capabilities summary: GetNode - description: | - Get a specific PTZ Node identified by a reference token or a name.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Get a specific PTZ Node identified by a reference token or a name. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -3714,17 +3953,23 @@ paths: tags: - PTZ - Configuration summary: GetConfigurations - description: | + 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -3810,19 +4055,25 @@ paths: tags: - PTZ - Configuration summary: GetConfiguration - description: | + 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.
+ 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. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -3934,15 +4185,21 @@ paths: tags: - PTZ - Configuration summary: SetConfiguration - description: | - Set/update a existing PTZConfiguration on the device.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Set/update a existing PTZConfiguration on the device. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -3992,15 +4249,21 @@ paths: tags: - PTZ - Configuration summary: GetConfigurationOptions - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -4153,15 +4416,21 @@ paths: tags: - PTZ - Configuration summary: AddPTZConfiguration - description: | - Add a new PTZConfiguration on the device.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Add a new PTZConfiguration on the device. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4202,15 +4471,21 @@ paths: tags: - PTZ - Configuration summary: RemovePTZConfiguration - description: | - Remove a PTZConfiguration on the device.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Remove a PTZConfiguration on the device. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4250,17 +4525,23 @@ paths: tags: - PTZ - Actuation summary: AbsoluteMove - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4304,17 +4585,23 @@ paths: tags: - PTZ - Actuation summary: RelativeMove - description: | + 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.
+ 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. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4358,15 +4645,21 @@ paths: tags: - PTZ - Actuation summary: ContinuousMove - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4410,15 +4703,21 @@ paths: tags: - PTZ - Actuation summary: GetStatus - description: | - Operation to request PTZ status for the Node in the selected profile.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Operation to request PTZ status for the Node in the selected profile. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -4522,15 +4821,21 @@ paths: tags: - PTZ - Actuation summary: Stop - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4571,15 +4876,21 @@ paths: tags: - PTZ - Preset summary: SetPreset - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4620,15 +4931,21 @@ paths: tags: - PTZ - Preset summary: GetPresets - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -4755,15 +5072,21 @@ paths: tags: - PTZ - Preset summary: GotoPreset - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4804,15 +5127,21 @@ paths: tags: - PTZ - Preset summary: RemovePreset - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ✔ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4853,15 +5182,21 @@ paths: tags: - PTZ - Home Position summary: GotoHomePosition - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4901,15 +5236,21 @@ paths: tags: - PTZ - Home Position summary: SetHomePosition - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -4949,7 +5290,7 @@ paths: tags: - PTZ - Auxiliary summary: SendAuxiliaryCommand - description: | + 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. @@ -4964,14 +5305,20 @@ paths: 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + A device that indicates auxiliary service capability shall support this command. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -5341,15 +5688,21 @@ paths: tags: - Analytics - Profile Configuration summary: GetProfiles - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -5445,15 +5798,21 @@ paths: tags: - Analytics - Profile Configuration summary: GetAnalyticsConfigurations - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: EDGEX_DEVICE_NAME in: path @@ -5526,17 +5885,23 @@ paths: tags: - Analytics - Profile Configuration summary: AddConfiguration - description: | + 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.
+ Note that OSD elements must be added via the CreateOSD command. + +
+ Tested Camera Models - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -5579,15 +5944,21 @@ paths: tags: - Analytics - Profile Configuration summary: RemoveConfiguration - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -5630,15 +6001,21 @@ paths: tags: - Analytics - Modules summary: GetSupportedAnalyticsModules - description: | - List all analytics modules that are supported by the given VideoAnalyticsConfiguration.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + List all analytics modules that are supported by the given VideoAnalyticsConfiguration. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -5706,15 +6083,21 @@ paths: tags: - Analytics - Modules summary: GetAnalyticsModules - description: | - List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -5809,15 +6192,21 @@ paths: tags: - Analytics - Modules summary: ModifyAnalyticsModules - 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.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -5864,21 +6253,27 @@ paths: tags: - Analytics - Modules summary: CreateAnalyticsModules - description: | + 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.
+ 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. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -5925,15 +6320,21 @@ paths: tags: - Analytics - Modules summary: DeleteAnalyticsModules - description: | - Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ❌ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ❌ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -5975,15 +6376,21 @@ paths: tags: - Analytics - Modules summary: GetAnalyticsModuleOptions - description: | - Return the options for the supported analytics modules that specify an Option attribute.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Return the options for the supported analytics modules that specify an Option attribute. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -6081,15 +6488,21 @@ paths: tags: - Analytics - Rules summary: GetSupportedRules - description: | - List all rules that are supported by the given VideoAnalyticsConfiguration.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + List all rules that are supported by the given VideoAnalyticsConfiguration. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -6331,15 +6744,21 @@ paths: tags: - Analytics - Rules summary: GetRules - description: | - List the currently assigned set of rules of a VideoAnalyticsConfiguration.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + List the currently assigned set of rules of a VideoAnalyticsConfiguration. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -6440,15 +6859,21 @@ paths: tags: - Analytics - Rules summary: ModifyRules - description: | - Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -6495,15 +6920,21 @@ paths: tags: - Analytics - Rules summary: GetRuleOptions - description: | - Return the options for the supported rules that specify an Option attribute.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Return the options for the supported rules that specify an Option attribute. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
parameters: - name: jsonObject in: query @@ -6604,19 +7035,25 @@ paths: tags: - Analytics - Rules summary: CreateRules - description: | + 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.
+ 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: @@ -6671,15 +7108,21 @@ paths: tags: - Analytics - Rules summary: DeleteRules - description: | - Remove one or more rules from a VideoAnalyticsConfiguration.
- - | Camera | Supported? | - |-------|-------| - | Hikvision DFI6256TE | ❌ | - | Tapo C200 | ❌ | - | BOSCH DINION IP starlight 6000 HD | ✔ | - | GeoVision GV-BX8700 | ❌ | + description: |- + Remove one or more rules from a VideoAnalyticsConfiguration. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ❌ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ❌ | | +
requestBody: content: application/json: From 4f315f802bf19a2e4c1d2b75a07498d8796cf70c Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Wed, 19 Oct 2022 17:09:25 -0700 Subject: [PATCH 05/15] docs: remove unused onvif schemas from swagger file Signed-off-by: Anthony Casagrande --- doc/openapi/Makefile | 2 +- doc/openapi/python/cleaner.py | 95 + doc/openapi/python/postprocess.py | 6 + doc/openapi/python/xmlstrip.py | 8 +- doc/openapi/v2/device-onvif-camera.yaml | 15892 ++++------------------ 5 files changed, 2715 insertions(+), 13288 deletions(-) create mode 100644 doc/openapi/python/cleaner.py diff --git a/doc/openapi/Makefile b/doc/openapi/Makefile index c6b35179..2d5146fc 100644 --- a/doc/openapi/Makefile +++ b/doc/openapi/Makefile @@ -19,7 +19,7 @@ SERVICES = analytics device event imaging media media2 ptz # todo: replace the API version number based on the actual source code version -$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) python/postprocess.py python/matrix.py Makefile +$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) python/postprocess.py python/matrix.py python/cleaner.py Makefile python3 python/postprocess.py $(OPENAPI_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) $(OPENAPI_TEMP_FILE): $(POSTMAN_COLLECTION) $(POSTMAN_2_OPENAPI_OPTIONS) | ./tmp diff --git a/doc/openapi/python/cleaner.py b/doc/openapi/python/cleaner.py new file mode 100644 index 00000000..2fad1d2f --- /dev/null +++ b/doc/openapi/python/cleaner.py @@ -0,0 +1,95 @@ +#!/usr/bin/env python3 + +# Copyright (C) 2022 Intel Corporation +# SPDX-License-Identifier: Apache-2.0 +from collections import defaultdict +from dataclasses import dataclass, field +from ruamel.yaml import YAML + +yaml = YAML() + + +@dataclass +class Schema: + uses: set = field(default_factory=set) + used_by: set = field(default_factory=set) + + +@dataclass +class SchemaCleaner: + """ + Implementation of a schema cleaner to remove unused schema definitions. + + Note: This is a one time use object, do not re-use it! + """ + yml: any + schemas: dict[str, Schema] = field(default_factory=lambda: defaultdict(Schema)) + unused: set[str] = field(default_factory=set) + + def _inner_parse(self, current, obj): + """Inner recursive portion of _parse_schemas""" + if isinstance(obj, dict): + if '$ref' in obj: + name = obj['$ref'].split('/')[-1] + self.schemas[current].uses.add(name) + self.schemas[name].used_by.add(current) + for _, x_obj in obj.items(): + self._inner_parse(current, x_obj) + elif isinstance(obj, list): + for x_obj in obj: + self._inner_parse(current, x_obj) + + def _parse_schemas(self): + """Parse the yml for all schemas and recursively detect what they are used by, and who uses them""" + for path, path_obj in self.yml['paths'].items(): + for method, method_obj in path_obj.items(): + name = f'{path.split("/")[-1]}_{method}' + # this is a top level path, so add a used_by to prevent it from being detected as unused + self.schemas[name].used_by.add('TOP_LEVEL') + self._inner_parse(name, method_obj) + + for name, schema in self.yml['components']['schemas'].items(): + self._inner_parse(name, schema) + + def _inner_find_unused(self, ref, name): + """Inner recursive part of _find_unused""" + if ref is not None and ref in self.schemas[name].used_by: + self.schemas[name].used_by.remove(ref) + if len(self.schemas[name].used_by) == 0: + for use in self.schemas[name].uses: + self._inner_find_unused(name, use) + + def _find_unused(self): + """ + Recursively find the schemas that are unused by removing references to a schema which itself is unused + + For Example: If Schema A is unused, and it refers to Schema B, remove the usage from Schema B. Now if Schema B has no + more usages, it is considered unused as well. + """ + for name in self.schemas.keys(): + self._inner_find_unused(None, name) + + # note: we need to loop through the original yml schema list (and NOT self.schemas) to find schemas that are + # unused which do not have any usages themselves + for name in self.yml['components']['schemas'].keys(): + if len(self.schemas[name].used_by) == 0: + self.unused.add(name) + + def _remove_unused(self): + """Remove all unused items from the schema portion of the yaml""" + for name in self.unused: + self.yml["components"]["schemas"].pop(name) + + def remove_unused_schemas(self) -> any: + """ + Recursively parses the schemas to determine which ones are used and which ones are not. The unused + ones are subsequently deleted from the input yaml data. + """ + print('Removing unused schemas') + total = len(self.yml["components"]["schemas"]) # cache the total number as it will be modified by the end + self._parse_schemas() + self._find_unused() + self._remove_unused() + print(f'Removed {len(self.unused)} unused schemas of {total} total schemas!') + print(f'{len(self.yml["components"]["schemas"])} total schemas remain') + diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 7c425b83..7f826e4d 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -10,6 +10,7 @@ from ruamel.yaml import YAML from ruamel.yaml.scalarstring import LiteralScalarString +from cleaner import SchemaCleaner from matrix import MarkdownMatrix yaml = YAML() @@ -479,6 +480,10 @@ def _clean_response_headers(self): '$ref': '#/components/headers/correlatedResponseHeader' } + def _clean_schemas(self): + cleaner = SchemaCleaner(self.yml) + cleaner.remove_unused_schemas() + def process(self): """Process the input yaml files, and create the final output yaml file""" self._load() @@ -488,6 +493,7 @@ def process(self): self._add_example_vars() self._clean_response_headers() self._verify_complete() + self._clean_schemas() self._write() diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py index e3a25a8f..91f6a456 100755 --- a/doc/openapi/python/xmlstrip.py +++ b/doc/openapi/python/xmlstrip.py @@ -80,7 +80,7 @@ def fix_refs(name, obj): PullMessagesFaultResponse: $ref: '#/components/schemas/event_PullMessagesFaultResponse' """ - if type(obj) is dict: + if isinstance(obj, dict): if 'allOf' in obj and len(obj) == 1: if len(obj['allOf']) == 1 and '$ref' in obj['allOf'][0]: print(f'fixing schema ref for {name}') @@ -90,7 +90,7 @@ def fix_refs(name, obj): for n2, o2 in obj.items(): fix_refs(f'{name}.{n2}', o2) - elif type(obj) is list: + elif isinstance(obj, list): for o2 in obj: fix_refs(f'{name}[]', o2) @@ -102,7 +102,7 @@ def strip_xml(name, obj): - Redefine application/xml mime types to application/json - Remove empty values from arrays """ - if type(obj) is dict: + if isinstance(obj, dict): if 'xml' in obj: print(f'Stripping xml field from {name}') del obj['xml'] @@ -118,7 +118,7 @@ def strip_xml(name, obj): for n2, o2 in obj.items(): strip_xml(f'{name}.{n2}', o2) - elif type(obj) is list: + elif isinstance(obj, list): for o2 in obj: strip_xml(f'{name}[]', o2) if len(obj) == 2 and obj[1] == {}: diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 8e1e6f66..740c5707 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -7583,36 +7583,6 @@ paths: '503': *id005 components: schemas: - analytics_Capabilities: - properties: - AnalyticsModuleOptionsSupported: - description: Indication that the device supports the GetAnalyticsModuleOptions - operation on the analytics interface - type: boolean - AnalyticsModuleSupport: - description: Indication that the device supports the scene analytics module - interface. - type: boolean - CellBasedSceneDescriptionSupported: - description: Indication that the device produces the cell based scene description - type: boolean - ImageSendingType: - description: Indication what kinds of method that the device support for - sending image, acceptable values are defined in tt:ImageSendingType. - type: string - RuleOptionsSupported: - description: Indication that the device supports the GetRuleOptions operation - on the rules interface - type: boolean - RuleSupport: - description: Indication that the device supports the rules interface and - the rules syntax. - type: boolean - SupportedMetadata: - description: Indication that the device supports the GetSupportedMetadata - operation. - type: boolean - type: object analytics_ConfigOptions: properties: AnalyticsModule: @@ -7659,8 +7629,6 @@ components: - ConfigurationToken - AnalyticsModule type: object - analytics_CreateAnalyticsModulesResponse: - type: object analytics_CreateRules: properties: ConfigurationToken: @@ -7675,8 +7643,6 @@ components: - ConfigurationToken - Rule type: object - analytics_CreateRulesResponse: - type: object analytics_DeleteAnalyticsModules: properties: AnalyticsModuleName: @@ -7692,8 +7658,6 @@ components: - ConfigurationToken - AnalyticsModuleName type: object - analytics_DeleteAnalyticsModulesResponse: - type: object analytics_DeleteRules: properties: ConfigurationToken: @@ -7709,21 +7673,6 @@ components: - ConfigurationToken - RuleName type: object - analytics_DeleteRulesResponse: - type: object - analytics_GetAnalyticsModuleOptions: - properties: - ConfigurationToken: - description: Reference to an existing AnalyticsConfiguration. - maxLength: 64 - type: string - Type: - description: Reference to an SupportedAnalyticsModule Type returned from - GetSupportedAnalyticsModules. - type: string - required: - - ConfigurationToken - type: object analytics_GetAnalyticsModuleOptionsResponse: properties: Options: @@ -7733,15 +7682,6 @@ components: $ref: '#/components/schemas/analytics_ConfigOptions' type: array type: object - analytics_GetAnalyticsModules: - properties: - ConfigurationToken: - description: Reference to an existing VideoAnalyticsConfiguration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object analytics_GetAnalyticsModulesResponse: properties: AnalyticsModule: @@ -7749,18 +7689,6 @@ components: $ref: '#/components/schemas/onvif_Config' type: array type: object - analytics_GetRuleOptions: - properties: - ConfigurationToken: - description: Reference to an existing analytics configuration. - maxLength: 64 - type: string - RuleType: - description: Reference to an SupportedRule Type returned from GetSupportedRules. - type: string - required: - - ConfigurationToken - type: object analytics_GetRuleOptionsResponse: properties: RuleOptions: @@ -7771,15 +7699,6 @@ components: $ref: '#/components/schemas/analytics_ConfigOptions' type: array type: object - analytics_GetRules: - properties: - ConfigurationToken: - description: Reference to an existing VideoAnalyticsConfiguration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object analytics_GetRulesResponse: properties: Rule: @@ -7787,27 +7706,6 @@ components: $ref: '#/components/schemas/onvif_Config' type: array type: object - analytics_GetServiceCapabilities: - type: object - analytics_GetServiceCapabilitiesResponse: - properties: - Capabilities: - allOf: - - $ref: '#/components/schemas/analytics_Capabilities' - - description: The capabilities for the analytics service is returned in - the Capabilities element. - required: - - Capabilities - type: object - analytics_GetSupportedAnalyticsModules: - properties: - ConfigurationToken: - description: Reference to an existing VideoAnalyticsConfiguration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object analytics_GetSupportedAnalyticsModulesResponse: properties: SupportedAnalyticsModules: @@ -7815,31 +7713,6 @@ components: required: - SupportedAnalyticsModules type: object - analytics_GetSupportedMetadata: - properties: - Type: - description: Optional reference to an AnalyticsModule Type returned from - GetSupportedAnalyticsModules. - type: string - type: object - analytics_GetSupportedMetadataResponse: - properties: - AnalyticsModule: - items: - $ref: '#/components/schemas/analytics_MetadataInfo' - type: array - type: object - analytics_GetSupportedRules: - properties: - ConfigurationToken: - 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." - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object analytics_GetSupportedRulesResponse: properties: SupportedRules: @@ -7847,19 +7720,6 @@ components: required: - SupportedRules type: object - analytics_MetadataInfo: - properties: - SampleFrame: - allOf: - - $ref: '#/components/schemas/onvif_Frame' - - description: Sample frame content starting with the tt:Frame node. - Type: - description: Reference to an AnalyticsModule Type. - type: string - required: - - Type - - SampleFrame - type: object analytics_ModifyAnalyticsModules: properties: AnalyticsModule: @@ -7874,8 +7734,6 @@ components: - ConfigurationToken - AnalyticsModule type: object - analytics_ModifyAnalyticsModulesResponse: - type: object analytics_ModifyRules: properties: ConfigurationToken: @@ -7890,13448 +7748,3228 @@ components: - ConfigurationToken - Rule type: object - analytics_ModifyRulesResponse: - type: object - bd_Bag: - properties: - Category: - description: Describe the Category of the Bag, acceptable values are defined - in bd:KnapsackCategory. - type: string - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Colour of the Bag, acceptable values are defined - in tt:ColorDescriptor. - type: object - bd_Behaviour: - properties: - Activity: - description: Describe the activity of the body, Acceptable values are defined - in bd:HumanActivity. - type: string - Smoking: - description: Acceptable values are defined in bd:Smoking. - type: string - UsingMobile: - description: Acceptable values are defined in bd:UsingMobile. - type: string - type: object - bd_Belonging: + onvif_AnalyticsEngineConfiguration: properties: - Bag: - allOf: - - $ref: '#/components/schemas/bd_Bag' - - description: Describe the Bag of the body,acceptable values are defined - in bd:Bag - Box: - allOf: - - $ref: '#/components/schemas/bd_Box' - - description: Describe the Box luffed by the body,acceptable values are - defined in bd:Box. - Cart: - allOf: - - $ref: '#/components/schemas/bd_Cart' - - description: Describe the Cart pushed by the body,acceptable values are - defined in bd:Cart. - LiftSomething: - description: Describe if the body Lifts something. - type: boolean - Umbrella: - allOf: - - $ref: '#/components/schemas/bd_Umbrella' - - description: Describe the Umbrella carried by the body,acceptable values - are defined in bd:Umbrella. - Weapon: - description: Describe if the body carries the Weapon. - type: boolean + AnalyticsModule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array + Extension: + $ref: '#/components/schemas/onvif_AnalyticsEngineConfigurationExtension' type: object - bd_BodyMetric: - properties: - BodyShape: - description: Describle the Shape of the body, acceptable values are defined - in bd:BodyShape. - type: string - Height: - description: Describe the Stature of the body, the unit is centimeter. - format: int32 - type: integer + onvif_AnalyticsEngineConfigurationExtension: type: object - bd_BodyShape: + onvif_AudioDecoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - type: object + 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)." + onvif_AudioEncoder2Configuration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Bitrate: + description: The output bitrate in kbps. + format: int32 + type: integer + Encoding: + description: Audio Media Subtype for the audio format. For definitions + see tt:AudioEncodingMimeNames and + type: string + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Optional multicast configuration of the audio stream. + SampleRate: + description: The output sample rate in kHz. + format: int32 + type: integer + required: + - Encoding + - Bitrate + - SampleRate + type: object + onvif_AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Bitrate: + description: The output bitrate in kbps. + format: int32 + type: integer + Encoding: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoding' + - description: Audio codec used for encoding the audio input (either G.711, + G.726 or AAC) + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + SampleRate: + description: The output sample rate in kHz. + format: int32 + type: integer + SessionTimeout: + description: The rtsp session timeout for the related audio stream + format: date-time + type: string + required: + - Encoding + - Bitrate + - SampleRate + - Multicast + - SessionTimeout + type: object + onvif_AudioEncoding: enum: - - Fat - - Thin - - Other + - G711 + - G726 + - AAC type: string - bd_Bottoms: + onvif_AudioOutputConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + OutputLevel: + description: Volume setting of the output. The applicable range is defined + via the option AudioOutputOptions.OutputLevelRange. + format: int32 + type: integer + OutputToken: + description: Token of the phsycial Audio output. + maxLength: 64 + type: string + SendPrimacy: + 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." + type: string + required: + - OutputToken + - OutputLevel + type: object + onvif_AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + SourceToken: + description: Token of the Audio Source the configuration applies to + maxLength: 64 + type: string + required: + - SourceToken + type: object + onvif_Config: properties: - Category: - description: Describe the Category of the Bottoms, acceptable values are - defined in bd:BottomsCategory. - type: string - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Bottoms, acceptable values are - defined in tt:ColorDescriptor. - Grain: - description: Describe the Grain of the Bottoms, acceptable values are defined - in bd:Grain. - type: string - Style: - description: Describe the Style of the Bottoms, acceptable values are defined - in bd:BottomsStyle. + Name: + description: Name of the configuration. type: string - type: object - bd_BottomsCategory: - enum: - - Trousers - - Shorts - - Skirt - - Other - type: string - bd_BottomsStyle: - enum: - - FornalPants - - Jeans - - Other - type: string - bd_Box: - properties: - Color: + Parameters: allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Box, acceptable values are defined - in tt:ColorDescriptor. - Lug: - description: Describe if the body Lugs the Box. - type: boolean - type: object - bd_Cart: - properties: - Category: - description: Describe the Category of the Cart, acceptable values are defined - in bd:CartCategory. + - $ref: '#/components/schemas/onvif_ItemList' + - description: List of configuration parameters as defined in the corresponding + description. + Type: + 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. type: string - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Cart, acceptable values are defined - in tt:ColorDescriptor. + required: + - Name + - Type + - Parameters type: object - bd_CartCategory: - enum: - - BabyCarriage - - TwoWheelVehicle - - Tricyle - - Other - type: string - bd_Clothing: + onvif_ConfigDescription: properties: - Bottoms: - allOf: - - $ref: '#/components/schemas/bd_Bottoms' - - description: Describe the Bottoms of the body,acceptable values are defined - in bd:Bottoms. - Gloves: - allOf: - - $ref: '#/components/schemas/bd_Gloves' - - description: Describe Gloves of the body,acceptable values are defined - in bd:Gloves. - Scarf: - allOf: - - $ref: '#/components/schemas/bd_Scarf' - - description: Describe the Scarf of the body,acceptable values are defined - in bd:Scarf. - Shoes: - allOf: - - $ref: '#/components/schemas/bd_Shoes' - - description: Describe the Shoes of the body,acceptable values are defined - in bd:Shoes. - Tops: - allOf: - - $ref: '#/components/schemas/bd_Tops' - - description: Describe the Tops of the body,acceptable values are defined - in bd:Tops. - type: object - bd_Gloves: - properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of Gloves, acceptable values are defined - in tt:ColorDescriptor. - Wear: - description: Describe if the body wears Gloves. - type: boolean - type: object - bd_Grain: - enum: - - Stria - - Plaid - - PureColour - - Decal - - Other - type: string - bd_HumanActivity: - enum: - - Walking - - Running - - Fallen - - Squatting - - Sitting - - Standing - - Driving - - Other - type: string - bd_HumanBody: - properties: - Behaviour: - allOf: - - $ref: '#/components/schemas/bd_Behaviour' - - description: Describe the Behaviour of the body. - Belonging: - allOf: - - $ref: '#/components/schemas/bd_Belonging' - - description: Describe the Belonging of the body. - BodyMetric: - allOf: - - $ref: '#/components/schemas/bd_BodyMetric' - - description: Describe the body metric of the body. - Clothing: - allOf: - - $ref: '#/components/schemas/bd_Clothing' - - description: Describe the Clothing of the body. - type: object - bd_KnapsackCategory: - enum: - - SingleShoulderBag - - Backpack - - Other - type: string - bd_Scarf: - properties: - Color: + Extension: + $ref: '#/components/schemas/onvif_ConfigDescriptionExtension' + Messages: + 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." + items: + $ref: '#/components/schemas/onvif_Messages' + type: array + Name: + description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies + the type of rule, not a type definition in a schema. + type: string + Parameters: allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Scarf, acceptable values are defined - in ColorDescriptor. - Wear: - description: Describe if the body wears the Scarf. + - $ref: '#/components/schemas/onvif_ItemListDescription' + - 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." + fixed: + description: The fixed attribute signals that it is not allowed to add or + remove this type of configuration. type: boolean + maxInstances: + description: The maxInstances attribute signals the maximum number of instances + per configuration. + format: int32 + type: integer + required: + - Name + - Parameters type: object - bd_Shoes: - properties: - Category: - description: Describe the Category of the Shoes, acceptable values are defined - in bd:ShoesCategory. - type: string - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Shoes, acceptable values are defined - in tt:ColorDescriptor. + onvif_ConfigDescriptionExtension: type: object - bd_ShoesCategory: - enum: - - LeatherShoes - - Sneakers - - Sandal - - Slipper - - Other - type: string - bd_Smoking: - enum: - - NoSmoking - - Cigar - - ElectronicCigarettes - - Other - type: string - bd_Tops: + onvif_ConfigurationEntity: + description: Base type defining the common properties of a configuration. properties: - Category: - description: Describe the Category of the Tops, acceptable values are defined - in bd:TopsCategory. - type: string - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Tops, acceptable values are defined - in tt:ColorDescriptor. - Grain: - description: Describe the Grain of the Tops, acceptable values are defined - in bd:Grain. + Name: + description: User readable name. Length up to 64 characters. + maxLength: 64 type: string - Style: - description: Describe the Style of the Tops, acceptable values are defined - in bd:TopsStyle. + UseCount: + description: Number of internal references currently using this configuration. + format: int32 + type: integer + token: + description: Token that uniquely references this configuration. Length up + to 64 characters. + maxLength: 64 type: string + required: + - token + - Name + - UseCount type: object - bd_TopsCategory: - enum: - - LongSleeve - - ShortSleeve - - Other - type: string - bd_TopsStyle: - enum: - - Tailor - - Jacket - - Sweater - - Overcoat - - Dress - - Other - type: string - bd_Umbrella: + onvif_DNSInformation: properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the Bag, acceptable values are defined - in tt:ColorDescriptor. - Open: - description: Describe if the body Opens the Umbrella. + DNSFromDHCP: + description: List of DNS addresses received from DHCP. + items: + $ref: '#/components/schemas/onvif_IPAddress' + type: array + DNSManual: + description: List of manually entered DNS addresses. + items: + $ref: '#/components/schemas/onvif_IPAddress' + type: array + Extension: + $ref: '#/components/schemas/onvif_DNSInformationExtension' + FromDHCP: + description: Indicates whether or not DNS information is retrieved from + DHCP. type: boolean + SearchDomain: + description: Search domain. + items: + type: string + type: array + required: + - FromDHCP type: object - bd_UsingMobile: - enum: - - ByLeftHand - - ByRightHand - - Other - type: string - fc_Accessory: + onvif_DNSInformationExtension: + type: object + onvif_Date: properties: - Hat: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if the object wear hat. - Helmet: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if the object wear Helmet. - Hijab: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if the object wear hijab. - Kerchief: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if the object wear Kerchief. - LeftEyePatch: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if there is a patch on the left eye. - Mask: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if the object wear mask. - Opticals: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if the object wear opticals. - RightEyePatch: - allOf: - - $ref: '#/components/schemas/fc_AccessoryDescription' - - description: Describe if there is a patch on the right eye. + Day: + description: Range is 1 to 31. + format: int32 + type: integer + Month: + description: Range is 1 to 12. + format: int32 + type: integer + Year: + format: int32 + type: integer + required: + - Year + - Month + - Day type: object - fc_AccessoryDescription: + onvif_DateTime: properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the accessory. - Wear: - description: Describe if the object wear a accessory . - type: boolean + Date: + $ref: '#/components/schemas/onvif_Date' + Time: + $ref: '#/components/schemas/onvif_Time' + required: + - Time + - Date type: object - fc_AdditionalFeatures: + onvif_DeviceEntity: + description: Base class for physical entities like inputs and outputs. properties: - Freckles: - description: Describe freckles on the face, acceptable values are defined - in fc:FrecklesType. + token: + description: Unique identifier referencing the physical entity. + maxLength: 64 type: string - Mole: - description: Is there mole on the face. - type: boolean - Scar: - description: Is there scar on the face. - type: boolean - Tattoo: - description: Is there Tattoo on the face. - type: boolean + required: + - token type: object - fc_Chin: - enum: - - Double - - Pointed - - Round - type: string - fc_Complexion: - enum: - - White - - Black - - Asian - - Other - type: string - fc_Ear: + onvif_DiscoveryMode: enum: - - Round - - Pointed - - Narrow - - BroadLobe - - Other + - Discoverable + - NonDiscoverable type: string - fc_Expression: + onvif_Dot11Cipher: enum: - - Natural - - Smile - - RaisedEyebrows - - Squint - - Frown - - Other + - CCMP + - TKIP + - Any + - Extended type: string - fc_Eye: + onvif_Dot11Configuration: properties: - Eyeball: - description: Describe the eyeball of the eye, acceptable values are defined - in fc:Eyeball. - type: string - Eyelid: - description: Describe the eyelid of the eye, acceptable values are defined - in fc:Eyelid. + Alias: + maxLength: 64 type: string - Shape: - description: Describe the shape of the eye, acceptable values are defined - in fc:EyeBrowShape. + Mode: + $ref: '#/components/schemas/onvif_Dot11StationMode' + Priority: + format: int32 + maximum: 31 + minimum: 0 + type: integer + SSID: + format: binary type: string + Security: + $ref: '#/components/schemas/onvif_Dot11SecurityConfiguration' + required: + - SSID + - Mode + - Alias + - Priority + - Security type: object - fc_EyeShape: - enum: - - Almond - - Slitty - - Round - - Other - type: string - fc_Eyeball: - enum: - - Black - - Blue - - Brown - - Gray - - Green - - Pink - - Other - type: string - fc_Eyebrow: + onvif_Dot11PSKSet: properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the Color of the eyebrow. - Space: - description: Describe the space of two eyebrows, acceptable values are defined - in fc:EyebrowSpace. + Extension: + $ref: '#/components/schemas/onvif_Dot11PSKSetExtension' + Key: + description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of + 256 bits, or 64 octets when represented in hex + format: binary type: string - Width: - description: "Describe the shape of the eyebrow, Short usually means that\ - \ the width of eye brow is shorter than the length of eye.\n\n\t\t\t\t\ - Long usually means that the width of eye brow is equal to or longer than\ - \ the length of eye.acceptable values are defined in fc:EyebrowWidth." + Passphrase: + 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." + pattern: '[ -~]{8,63}' type: string type: object - fc_EyebrowSpace: - enum: - - Joint - - Separate - type: string - fc_EyebrowWidth: - enum: - - Long - - Short - type: string - fc_Eyelid: - enum: - - Single - - Double - - Other - type: string - fc_FacialHair: + onvif_Dot11PSKSetExtension: + type: object + onvif_Dot11SecurityConfiguration: properties: - Beard: - description: Describe if there are Beard on the face. - type: boolean - Mustache: - description: Describe if there is mustache on the face. - type: boolean - Sideburn: - description: Describe if there are sideburns on the face. - type: boolean + Algorithm: + $ref: '#/components/schemas/onvif_Dot11Cipher' + Dot1X: + maxLength: 64 + type: string + Extension: + $ref: '#/components/schemas/onvif_Dot11SecurityConfigurationExtension' + Mode: + $ref: '#/components/schemas/onvif_Dot11SecurityMode' + PSK: + $ref: '#/components/schemas/onvif_Dot11PSKSet' + required: + - Mode + type: object + onvif_Dot11SecurityConfigurationExtension: type: object - fc_FacialShape: + onvif_Dot11SecurityMode: enum: - - Long - - Round - - Square - - Oval - - Other + - None + - WEP + - PSK + - Dot1X + - Extended type: string - fc_FrecklesType: + onvif_Dot11StationMode: enum: - - AroundCheek - - Nose - - forehead - - Other + - Ad-hoc + - Infrastructure + - Extended type: string - fc_Gender: + onvif_Dot3Configuration: + type: object + onvif_Duplex: enum: - - Male - - Female + - Full + - Half type: string - fc_Hair: + onvif_DurationRange: + description: Range of duration greater equal Min duration and less equal Max + duration. properties: - Bangs: - description: Describe the bangs of the Hair - type: boolean - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorDescriptor' - - description: Describe the color of the Hair. - Length: - 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. \r\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." - type: string - Style: - description: Describe the style of the Hair, acceptable values are defined - in fc:HairStyle. + Max: + format: date-time type: string + Min: + format: date-time + type: string + required: + - Min + - Max type: object - fc_HairStyle: - enum: - - Straight - - Wave - - Curly - - CrewCut - - Bald - - Ponytail - - Pigtail - - Other - type: string - fc_HumanFace: + onvif_EFlip: properties: - Accessory: - allOf: - - $ref: '#/components/schemas/fc_Accessory' - - description: Describe the Accessory of the face. - AdditionalFeatures: - allOf: - - $ref: '#/components/schemas/fc_AdditionalFeatures' - - description: Describe the other features, eg scar, mole etc of the face. - Age: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Describe the age of the face. - Chin: - description: Describe the Chin of the face, acceptable values are defined - in fc:Chin. - type: string - Complexion: - description: Describe the complexion of the face, acceptable values are - defined in fc:Complexion. - type: string - Ear: - allOf: - - $ref: '#/components/schemas/fc_Ear' - - description: Describe the Ear of the face. - Expression: - description: Describe the expression on the face, acceptable values are - defined in fc:Expression. - type: string - Eye: - allOf: - - $ref: '#/components/schemas/fc_Eye' - - description: Describe the eye of the face. - Eyebrow: - allOf: - - $ref: '#/components/schemas/fc_Eyebrow' - - description: Describe the eyebrow of the face. - FacialHair: - allOf: - - $ref: '#/components/schemas/fc_FacialHair' - - description: Describe the facial hair of the face. - FacialShape: - description: Describe the FacialShape, acceptable values are defined fc:FacialShape. - type: string - Gender: - description: Describe the gender of the face, acceptable values are defined - in fc:Gender. - type: string - Hair: - allOf: - - $ref: '#/components/schemas/fc_Hair' - - description: Describe the hair of the face. - Lip: - description: Describe the lip of the face, acceptable values are defined - in fc:Lip. - type: string - Nose: - allOf: - - $ref: '#/components/schemas/fc_Nose' - - description: Describe the nose of the face. - PoseAngle: + Mode: allOf: - - $ref: '#/components/schemas/fc_PoseAngle' - - description: Describe the pose angle of the face. - Temperature: - description: Describe the temperature of the face, in Kelvin. - type: number + - $ref: '#/components/schemas/onvif_EFlipMode' + - description: Parameter to enable/disable E-Flip feature. + required: + - Mode type: object - fc_Length: - enum: - - Long - - Medium - - Short - type: string - fc_Lip: + onvif_EFlipMode: enum: - - Full - - Medium - - Thin + - false + - true + - Extended type: string - fc_Nose: + onvif_EFlipOptions: properties: - Length: - description: "Describe the length of the nose, acceptable values are defined\ - \ in fc:NoseLength. \r\n\t\t\t\tLong usually means that the length of\ - \ the nose is longer than 1/3 of the length of the face.\r\n\t\t\t\tshort\ - \ usually means that the length of the nose is shorter than 1/3 of the\ - \ length of the face." - type: string - NoseBridge: - description: Describe the bridge of the nose, acceptable values are defined - in fc:NoseBridge. - type: string - NoseEnd: - description: Describe the end of the nose, acceptable values are defined - in fc:NoseEnd. - type: string - NoseWing: - description: Describe the wing of the nose, acceptable values are defined - in fc:NoseWing. - type: string + Extension: + $ref: '#/components/schemas/onvif_EFlipOptionsExtension' + Mode: + description: Options of EFlip mode parameter. + items: + $ref: '#/components/schemas/onvif_EFlipMode' + type: array type: object - fc_NoseBridge: - enum: - - Straight - - Arch - type: string - fc_NoseEnd: - enum: - - Snub - - Turnedup - - Flat - - Hooked - - Other - type: string - fc_NoseLength: - enum: - - Short - - Long - type: string - fc_NoseWing: - enum: - - Narrow - - Broad - type: string - fc_PoseAngle: + onvif_EFlipOptionsExtension: + type: object + onvif_ElementItem: + description: Complex value structure. properties: - PoseAngles: - allOf: - - $ref: '#/components/schemas/onvif_GeoOrientation' - - description: Describe the pose angle of the face. - Uncertainty: - allOf: - - $ref: '#/components/schemas/onvif_GeoOrientation' - - description: Describe the expected degree of uncertainty of the pose angle - yaw, pitch, and roll. + Name: + description: Item name. + type: string + required: + - Name type: object - onvif_AACDecOptions: + onvif_ElementItemDescription: + description: Description of a complex type. The Type must reference a defined + type. properties: - Bitrate: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported bitrates in kbps - SampleRateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported sample rates in kHz + Name: + description: Item name. Must be unique within a list. + type: string + Type: + description: The type of the item. The Type must reference a defined type. + type: string required: - - Bitrate - - SampleRateRange + - Name + - Type + type: object + onvif_EventSubscription: + description: Subcription handling in the same way as base notification subscription. + properties: + Filter: + $ref: '#/components/schemas/wsnt_FilterType' + SubscriptionPolicy: + $ref: '#/components/schemas/onvif_SubscriptionPolicy' type: object - onvif_AFModes: + onvif_FactoryDefaultType: + description: Enumeration describing the available factory default modes. enum: - - OnceAfterMove + - Hard + - Soft type: string - onvif_AbsoluteFocus: + onvif_FloatRange: + description: Range of values greater equal Min value and less equal Max value. properties: - Position: - description: Position parameter for the absolute focus control. + Max: type: number - Speed: - description: Speed parameter for the absolute focus control. + Min: type: number required: - - Position + - Min + - Max type: object - onvif_AbsoluteFocusOptions: + onvif_H264Configuration: properties: - Position: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the position. - Speed: + GovLength: + 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. + format: int32 + type: integer + H264Profile: allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the speed. + - $ref: '#/components/schemas/onvif_H264Profile' + - description: the H.264 profile, either baseline, main, extended or high required: - - Position + - GovLength + - H264Profile type: object - onvif_ActionEngineEventPayload: - description: Action Engine Event Payload data structure contains the information - about the ONVIF command invocations. Since this event could be generated by - other or proprietary actions, the command invocation specific fields are defined - as optional and additional extension mechanism is provided for future or additional - action definitions. + onvif_H264Options: properties: - Extension: - $ref: '#/components/schemas/onvif_ActionEngineEventPayloadExtension' - Fault: + EncodingIntervalRange: allOf: - - $ref: '#/components/schemas/soapenv_Fault' - - description: Fault Message - RequestInfo: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + FrameRateRange: allOf: - - $ref: '#/components/schemas/soapenv_Envelope' - - description: Request Message - ResponseInfo: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported frame rate in fps (frames per second). + GovLengthRange: allOf: - - $ref: '#/components/schemas/soapenv_Envelope' - - description: Response Message - type: object - onvif_ActionEngineEventPayloadExtension: - type: object - onvif_ActiveConnection: - properties: - CurrentBitrate: - type: number - CurrentFps: - type: number + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported group of Video frames length. This value typically + corresponds to the I-Frame distance. + H264ProfilesSupported: + description: List of supported H.264 profiles. + items: + $ref: '#/components/schemas/onvif_H264Profile' + type: array + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array required: - - CurrentBitrate - - CurrentFps + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - H264ProfilesSupported type: object - onvif_AnalyticsCapabilities: + onvif_H264Options2: + allOf: + - $ref: '#/components/schemas/onvif_H264Options' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. + required: + - BitrateRange + type: object + onvif_H264Profile: + enum: + - Baseline + - Main + - Extended + - High + type: string + onvif_HostnameInformation: properties: - AnalyticsModuleSupport: - description: Indicates whether or not modules are supported. - type: boolean - RuleSupport: - description: Indicates whether or not rules are supported. + Extension: + $ref: '#/components/schemas/onvif_HostnameInformationExtension' + FromDHCP: + description: Indicates whether the hostname is obtained from DHCP or not. type: boolean - XAddr: - description: Analytics service URI. + Name: + description: Indicates the hostname. type: string required: - - XAddr - - RuleSupport - - AnalyticsModuleSupport + - FromDHCP type: object - onvif_AnalyticsDeviceCapabilities: + onvif_HostnameInformationExtension: + type: object + onvif_IPAddress: properties: - Extension: - $ref: '#/components/schemas/onvif_AnalyticsDeviceExtension' - RuleSupport: - description: Obsolete property. - type: boolean - XAddr: + IPv4Address: + description: IPv4 address. + type: string + IPv6Address: + description: IPv6 address type: string + Type: + allOf: + - $ref: '#/components/schemas/onvif_IPType' + - description: Indicates if the address is an IPv4 or IPv6 address. required: - - XAddr + - Type type: object - onvif_AnalyticsDeviceEngineConfiguration: + onvif_IPType: + enum: + - IPv4 + - IPv6 + type: string + onvif_IPv4Configuration: properties: - EngineConfiguration: + DHCP: + description: Indicates whether or not DHCP is used. + type: boolean + FromDHCP: + allOf: + - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + - description: IPv4 address configured by using DHCP. + LinkLocal: + allOf: + - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' + - description: Link local address. + Manual: + description: List of manually added IPv4 addresses. items: - $ref: '#/components/schemas/onvif_EngineConfiguration' + $ref: '#/components/schemas/onvif_PrefixedIPv4Address' type: array - Extension: - $ref: '#/components/schemas/onvif_AnalyticsDeviceEngineConfigurationExtension' required: - - EngineConfiguration - type: object - onvif_AnalyticsDeviceEngineConfigurationExtension: + - DHCP type: object - onvif_AnalyticsDeviceExtension: + onvif_IPv4NetworkInterface: + properties: + Config: + allOf: + - $ref: '#/components/schemas/onvif_IPv4Configuration' + - description: IPv4 configuration. + Enabled: + description: Indicates whether or not IPv4 is enabled. + type: boolean + required: + - Enabled + - Config type: object - onvif_AnalyticsEngine: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - AnalyticsEngineConfiguration: - $ref: '#/components/schemas/onvif_AnalyticsDeviceEngineConfiguration' - required: - - AnalyticsEngineConfiguration - type: object - onvif_AnalyticsEngineConfiguration: + onvif_IPv4NetworkInterfaceSetConfiguration: properties: - AnalyticsModule: + DHCP: + description: Indicates whether or not DHCP is used. + type: boolean + Enabled: + description: Indicates whether or not IPv4 is enabled. + type: boolean + Manual: + description: List of manually added IPv4 addresses. items: - $ref: '#/components/schemas/onvif_Config' + $ref: '#/components/schemas/onvif_PrefixedIPv4Address' type: array - Extension: - $ref: '#/components/schemas/onvif_AnalyticsEngineConfigurationExtension' type: object - onvif_AnalyticsEngineConfigurationExtension: - type: object - onvif_AnalyticsEngineControl: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - EngineConfigToken: - description: Token of the analytics engine configuration (VideoAnalyticsConfiguration) - in effect. - maxLength: 64 - type: string - EngineToken: - description: Token of the analytics engine (AnalyticsEngine) being controlled. - maxLength: 64 - type: string - InputToken: - description: Tokens of the input (AnalyticsEngineInput) configuration - applied. - items: - maxLength: 64 - type: string - type: array - Mode: - $ref: '#/components/schemas/onvif_ModeOfOperation' - Multicast: - $ref: '#/components/schemas/onvif_MulticastConfiguration' - ReceiverToken: - description: Tokens of the receiver providing media input data. The order - of ReceiverToken shall exactly match the order of InputToken. - items: - maxLength: 64 - type: string - type: array - Subscription: - $ref: '#/components/schemas/onvif_Config' - required: - - EngineToken - - EngineConfigToken - - InputToken - - ReceiverToken - - Subscription - - Mode - type: object - onvif_AnalyticsEngineInput: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - MetadataInput: - $ref: '#/components/schemas/onvif_MetadataInput' - SourceIdentification: - $ref: '#/components/schemas/onvif_SourceIdentification' - VideoInput: - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' - required: - - SourceIdentification - - VideoInput - - MetadataInput - type: object - onvif_AnalyticsEngineInputInfo: - properties: - Extension: - $ref: '#/components/schemas/onvif_AnalyticsEngineInputInfoExtension' - InputInfo: - $ref: '#/components/schemas/onvif_Config' - type: object - onvif_AnalyticsEngineInputInfoExtension: - type: object - onvif_AnalyticsState: - properties: - Error: - type: string - State: - type: string - required: - - State - type: object - onvif_AnalyticsStateInformation: - properties: - AnalyticsEngineControlToken: - description: Token of the control object whose status is requested. - maxLength: 64 - type: string - State: - $ref: '#/components/schemas/onvif_AnalyticsState' - required: - - AnalyticsEngineControlToken - - State - type: object - onvif_AnyHolder: - type: object - onvif_Appearance: + onvif_IPv6Configuration: properties: - Class: - $ref: '#/components/schemas/onvif_ClassDescriptor' - Color: - $ref: '#/components/schemas/onvif_ColorDescriptor' + AcceptRouterAdvert: + description: Indicates whether router advertisment is used. + type: boolean + DHCP: + allOf: + - $ref: '#/components/schemas/onvif_IPv6DHCPConfiguration' + - description: DHCP configuration. Extension: - $ref: '#/components/schemas/onvif_AppearanceExtension' - GeoLocation: - $ref: '#/components/schemas/onvif_GeoLocation' - HumanBody: - $ref: '#/components/schemas/bd_HumanBody' - HumanFace: - $ref: '#/components/schemas/fc_HumanFace' - Image: - format: binary - type: string - ImageRef: - type: string - LicensePlateInfo: - $ref: '#/components/schemas/onvif_LicensePlateInfo' - Shape: - $ref: '#/components/schemas/onvif_ShapeDescriptor' - Transformation: - $ref: '#/components/schemas/onvif_Transformation' - VehicleInfo: + $ref: '#/components/schemas/onvif_IPv6ConfigurationExtension' + FromDHCP: + description: List of IPv6 addresses configured by using DHCP. items: - $ref: '#/components/schemas/onvif_VehicleInfo' + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' type: array - type: object - onvif_AppearanceExtension: - type: object - onvif_ArrayOfFileProgress: - properties: - Extension: - $ref: '#/components/schemas/onvif_ArrayOfFileProgressExtension' - FileProgress: - description: Exported file name and export progress information + FromRA: + description: List of IPv6 addresses configured by using router advertisment. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + LinkLocal: + description: List of link local IPv6 addresses. + items: + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' + type: array + Manual: + description: List of manually entered IPv6 addresses. items: - $ref: '#/components/schemas/onvif_FileProgress' + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' type: array + required: + - DHCP type: object - onvif_ArrayOfFileProgressExtension: + onvif_IPv6ConfigurationExtension: type: object - onvif_AttachmentData: + onvif_IPv6DHCPConfiguration: + enum: + - Auto + - Stateful + - Stateless + - false + type: string + onvif_IPv6NetworkInterface: properties: - Include: - $ref: '#/components/schemas/xop_Include' - contentType: - minLength: 3 - type: string + Config: + allOf: + - $ref: '#/components/schemas/onvif_IPv6Configuration' + - description: IPv6 configuration. + Enabled: + description: Indicates whether or not IPv6 is enabled. + type: boolean required: - - Include + - Enabled type: object - onvif_AudioAnalyticsStream: + onvif_IPv6NetworkInterfaceSetConfiguration: properties: - AudioDescriptor: + AcceptRouterAdvert: + description: Indicates whether router advertisment is used. + type: boolean + DHCP: + allOf: + - $ref: '#/components/schemas/onvif_IPv6DHCPConfiguration' + - description: DHCP configuration. + Enabled: + description: Indicates whether or not IPv6 is enabled. + type: boolean + Manual: + description: List of manually added IPv6 addresses. items: - $ref: '#/components/schemas/onvif_AudioDescriptor' + $ref: '#/components/schemas/onvif_PrefixedIPv6Address' type: array - Extension: - $ref: '#/components/schemas/onvif_AudioAnalyticsStreamExtension' - type: object - onvif_AudioAnalyticsStreamExtension: type: object - onvif_AudioAttributes: + onvif_IntRange: + description: Range of values greater equal Min value and less equal Max value. properties: - Bitrate: - description: The bitrate in kbps. + Max: format: int32 type: integer - Encoding: - description: Audio encoding of the track. Use values from tt:AudioEncoding - for G711 and AAC. Otherwise use values from tt:AudioEncodingMimeNames - and - type: string - Samplerate: - description: The sample rate in kHz. + Min: format: int32 type: integer required: - - Encoding - - Samplerate + - Min + - Max type: object - onvif_AudioClassCandidate: + onvif_IntRectangle: + description: Rectangle defined by lower left corner position and size. Units + are pixel. properties: - Likelihood: - description: A likelihood/probability that the corresponding audio event - belongs to this class. The sum of the likelihoods shall NOT exceed 1 - type: number - Type: - allOf: - - $ref: '#/components/schemas/onvif_AudioClassType' - - description: Indicates audio class label + height: + format: int32 + type: integer + width: + format: int32 + type: integer + x: + format: int32 + type: integer + y: + format: int32 + type: integer required: - - Type - - Likelihood + - x + - y + - width + - height type: object - onvif_AudioClassDescriptor: + onvif_ItemList: properties: - ClassCandidate: - description: Array of audio class label and class probability + ElementItem: + description: Complex value structure. items: - $ref: '#/components/schemas/onvif_AudioClassCandidate' + $ref: '#/components/schemas/onvif_ElementItem' type: array Extension: - $ref: '#/components/schemas/onvif_AudioClassDescriptorExtension' - type: object - onvif_AudioClassDescriptorExtension: + $ref: '#/components/schemas/onvif_ItemListExtension' + SimpleItem: + description: Value name pair as defined by the corresponding description. + items: + $ref: '#/components/schemas/onvif_SimpleItem' + type: array type: object - onvif_AudioClassType: - description: "AudioClassType acceptable values are;\n\t\t gun_shot, scream,\ - \ glass_breaking, tire_screech" - enum: - - gun_shot - - scream - - glass_breaking - - tire_screech - type: string - onvif_AudioDecoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - type: object - 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)." - onvif_AudioDecoderConfigurationOptions: + onvif_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." properties: - AACDecOptions: - allOf: - - $ref: '#/components/schemas/onvif_AACDecOptions' - - description: If the device is able to decode AAC encoded audio this section - describes the supported configurations + ElementItemDescription: + description: Description of a complex type. The Type must reference a defined + type. + items: + $ref: '#/components/schemas/onvif_ElementItemDescription' + type: array Extension: - $ref: '#/components/schemas/onvif_AudioDecoderConfigurationOptionsExtension' - G711DecOptions: - allOf: - - $ref: '#/components/schemas/onvif_G711DecOptions' - - description: If the device is able to decode G711 encoded audio this section - describes the supported configurations - G726DecOptions: - allOf: - - $ref: '#/components/schemas/onvif_G726DecOptions' - - description: If the device is able to decode G726 encoded audio this section - describes the supported configurations + $ref: '#/components/schemas/onvif_ItemListDescriptionExtension' + SimpleItemDescription: + description: Description of a simple item. The type must be of cathegory + simpleType (xs:string, xs:integer, xs:float, ...). + items: + $ref: '#/components/schemas/onvif_SimpleItemDescription' + type: array + type: object + onvif_ItemListDescriptionExtension: type: object - onvif_AudioDecoderConfigurationOptionsExtension: + onvif_ItemListExtension: type: object - onvif_AudioDescriptor: + onvif_JpegOptions: properties: - UtcTime: - format: date-time - type: string + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + FrameRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported frame rate in fps (frames per second). + ResolutionsAvailable: + description: List of supported image sizes. + items: + $ref: '#/components/schemas/onvif_VideoResolution' + type: array required: - - UtcTime + - ResolutionsAvailable + - FrameRateRange + - EncodingIntervalRange type: object - onvif_AudioEncoder2Configuration: + onvif_JpegOptions2: allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - $ref: '#/components/schemas/onvif_JpegOptions' - properties: - Bitrate: - description: The output bitrate in kbps. - format: int32 - type: integer - Encoding: - description: Audio Media Subtype for the audio format. For definitions - see tt:AudioEncodingMimeNames and - type: string - Multicast: + BitrateRange: allOf: - - $ref: '#/components/schemas/onvif_MulticastConfiguration' - - description: Optional multicast configuration of the audio stream. - SampleRate: - description: The output sample rate in kHz. - format: int32 - type: integer + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. required: - - Encoding - - Bitrate - - SampleRate + - BitrateRange type: object - onvif_AudioEncoder2ConfigurationOptions: + onvif_LensDescription: properties: - BitrateList: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported bitrates in kbps for the specified Encoding - Encoding: - description: Audio Media Subtype for the audio format. For definitions see - tt:AudioEncodingMimeNames and - type: string - SampleRateList: + FocalLength: + description: Optional focal length of the optical system. + type: number + Offset: allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported Sample Rates in kHz for the specified Encoding - required: - - Encoding - - BitrateList - - SampleRateList - type: object - onvif_AudioEncoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - Bitrate: - description: The output bitrate in kbps. - format: int32 - type: integer - Encoding: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoding' - - description: Audio codec used for encoding the audio input (either G.711, - G.726 or AAC) - Multicast: - allOf: - - $ref: '#/components/schemas/onvif_MulticastConfiguration' - - description: Defines the multicast settings that could be used for video - streaming. - SampleRate: - description: The output sample rate in kHz. - format: int32 - type: integer - SessionTimeout: - description: The rtsp session timeout for the related audio stream - format: date-time - type: string - required: - - Encoding - - Bitrate - - SampleRate - - Multicast - - SessionTimeout - type: object - onvif_AudioEncoderConfigurationOption: - properties: - BitrateList: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported bitrates in kbps for the specified Encoding - Encoding: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoding' - - description: The enoding used for audio data (either G.711, G.726 or AAC) - SampleRateList: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported Sample Rates in kHz for the specified Encoding - required: - - Encoding - - BitrateList - - SampleRateList - type: object - onvif_AudioEncoderConfigurationOptions: - properties: - Options: - description: list of supported AudioEncoderConfigurations - items: - $ref: '#/components/schemas/onvif_AudioEncoderConfigurationOption' - type: array - type: object - onvif_AudioEncoding: - enum: - - G711 - - G726 - - AAC - type: string - onvif_AudioEncodingMimeNames: - description: Audio Media Subtypes as referenced by IANA (without the leading - "audio/" Audio Media Type and except for the audio types defined in the restriction). See - also - enum: - - PCMU - - G726 - - MP4A-LATM - - mpeg4-generic - type: string - onvif_AudioOutput: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - type: object - description: Representation of a physical audio outputs. - onvif_AudioOutputConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - OutputLevel: - description: Volume setting of the output. The applicable range is defined - via the option AudioOutputOptions.OutputLevelRange. - format: int32 - type: integer - OutputToken: - description: Token of the phsycial Audio output. - maxLength: 64 - type: string - SendPrimacy: - 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." - type: string - required: - - OutputToken - - OutputLevel - type: object - onvif_AudioOutputConfigurationOptions: - properties: - OutputLevelRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Minimum and maximum level range supported for this Output. - OutputTokensAvailable: - description: Tokens of the physical Audio outputs (typically one). - items: - maxLength: 64 - type: string - type: array - SendPrimacyOptions: - description: An - items: - type: string - type: array - required: - - OutputTokensAvailable - - OutputLevelRange - type: object - onvif_AudioSource: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - Channels: - description: 'number of available audio channels. (1: mono, 2: stereo)' - format: int32 - type: integer - required: - - Channels - type: object - description: Representation of a physical audio input. - onvif_AudioSourceConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - SourceToken: - description: Token of the Audio Source the configuration applies to - maxLength: 64 - type: string - required: - - SourceToken - type: object - onvif_AudioSourceConfigurationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_AudioSourceOptionsExtension' - InputTokensAvailable: - description: Tokens of the audio source the configuration can be used for. + - $ref: '#/components/schemas/onvif_LensOffset' + - description: Offset of the lens center to the imager center in normalized + coordinates. + Projection: + description: "Radial description of the projection characteristics. The\ + \ resulting curve is defined by the B-Spline interpolation \n\t\t\t\t\t\ + over 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)." items: - maxLength: 64 - type: string + $ref: '#/components/schemas/onvif_LensProjection' type: array - required: - - InputTokensAvailable - type: object - onvif_AudioSourceOptionsExtension: - type: object - onvif_AutoFocusMode: - enum: - - AUTO - - MANUAL - type: string - onvif_BacklightCompensation: - properties: - Level: - description: Optional level parameter (unit unspecified). + XFactor: + description: Compensation of the x coordinate needed for the ONVIF normalized + coordinate system. type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_BacklightCompensationMode' - - description: Backlight compensation mode (on/off). required: - - Mode - - Level + - Offset + - Projection + - XFactor type: object - onvif_BacklightCompensation20: - description: Type describing whether BLC mode is enabled or disabled (on/off). + onvif_LensOffset: properties: - Level: - description: Optional level parameter (unit unspecified). + x: + description: Optional horizontal offset of the lens center in normalized + coordinates. + type: number + y: + description: Optional vertical offset of the lens center in normalized coordinates. type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_BacklightCompensationMode' - - description: Backlight compensation mode (on/off). - required: - - Mode - type: object - onvif_BacklightCompensationMode: - description: Enumeration describing the available backlight compenstation modes. - enum: - - false - - true - type: string - onvif_BacklightCompensationOptions: - properties: - Level: - $ref: '#/components/schemas/onvif_FloatRange' - Mode: - items: - $ref: '#/components/schemas/onvif_WideDynamicMode' - type: array - required: - - Mode - - Level - type: object - onvif_BacklightCompensationOptions20: - properties: - Level: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Level range of BacklightCompensation. - Mode: - description: "'ON' or 'OFF'" - items: - $ref: '#/components/schemas/onvif_BacklightCompensationMode' - type: array - required: - - Mode - type: object - onvif_BackupFile: - properties: - Data: - $ref: '#/components/schemas/onvif_AttachmentData' - Name: - type: string - required: - - Name - - Data type: object - onvif_Behaviour: + onvif_LensProjection: properties: - Extension: - $ref: '#/components/schemas/onvif_BehaviourExtension' - Idle: - $ref: '#/components/schemas/onvif_Idle' - Removed: - $ref: '#/components/schemas/onvif_Removed' - Speed: + Angle: + description: Angle of incidence. type: number + Radius: + description: Mapping radius as a consequence of the emergent angle. + type: number + Transmittance: + description: Optional ray absorption at the given angle due to vignetting. + A value of one means no absorption. + type: number + required: + - Angle + - Radius type: object - onvif_BehaviourExtension: - type: object - onvif_BinaryData: + onvif_MediaUri: properties: - Data: - description: base64 encoded binary data. - format: binary + InvalidAfterConnect: + description: Indicates if the Uri is only valid until the connection is + established. The value shall be set to "false". + type: boolean + InvalidAfterReboot: + description: Indicates if the Uri is invalid after a reboot of the device. + The value shall be set to "false". + type: boolean + Timeout: + 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 + format: date-time type: string - contentType: - minLength: 3 + Uri: + description: Stable Uri to be used for requesting the media stream type: string required: - - Data + - Uri + - InvalidAfterConnect + - InvalidAfterReboot + - Timeout type: object - onvif_Capabilities: + onvif_MessageDescription: properties: - Analytics: - allOf: - - $ref: '#/components/schemas/onvif_AnalyticsCapabilities' - - description: Analytics capabilities - Device: - allOf: - - $ref: '#/components/schemas/onvif_DeviceCapabilities' - - description: Device capabilities - Events: + Data: allOf: - - $ref: '#/components/schemas/onvif_EventCapabilities' - - description: Event capabilities + - $ref: '#/components/schemas/onvif_ItemListDescription' + - description: Describes the payload of the message. Extension: - $ref: '#/components/schemas/onvif_CapabilitiesExtension' - Imaging: - allOf: - - $ref: '#/components/schemas/onvif_ImagingCapabilities' - - description: Imaging capabilities - Media: - allOf: - - $ref: '#/components/schemas/onvif_MediaCapabilities' - - description: Media capabilities - PTZ: + $ref: '#/components/schemas/onvif_MessageDescriptionExtension' + IsProperty: + 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. + type: boolean + Key: allOf: - - $ref: '#/components/schemas/onvif_PTZCapabilities' - - description: PTZ capabilities - type: object - onvif_CapabilitiesExtension: - properties: - AnalyticsDevice: - $ref: '#/components/schemas/onvif_AnalyticsDeviceCapabilities' - DeviceIO: - $ref: '#/components/schemas/onvif_DeviceIOCapabilities' - Display: - $ref: '#/components/schemas/onvif_DisplayCapabilities' - Extensions: - $ref: '#/components/schemas/onvif_CapabilitiesExtension2' - Receiver: - $ref: '#/components/schemas/onvif_ReceiverCapabilities' - Recording: - $ref: '#/components/schemas/onvif_RecordingCapabilities' - Replay: - $ref: '#/components/schemas/onvif_ReplayCapabilities' - Search: - $ref: '#/components/schemas/onvif_SearchCapabilities' - type: object - onvif_CapabilitiesExtension2: - type: object - onvif_CapabilityCategory: - enum: - - All - - Analytics - - Device - - Events - - Imaging - - Media - - PTZ - type: string - onvif_CellLayout: - properties: - Columns: - description: Number of columns of the cell grid (x dimension) - format: int32 - type: integer - Rows: - description: Number of rows of the cell grid (y dimension) - format: int32 - type: integer - Transformation: + - $ref: '#/components/schemas/onvif_ItemListDescription' + - description: Describes optional message payload parameters that may be + used as key. E.g. object IDs of tracked objects are conveyed as key. + Source: allOf: - - $ref: '#/components/schemas/onvif_Transformation' - - description: Mapping of the cell grid to the Video frame. The cell grid - is starting from the upper left corner and x dimension is going from - left to right and the y dimension from up to down. - required: - - Columns - - Rows - - Transformation + - $ref: '#/components/schemas/onvif_ItemListDescription' + - 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." type: object - onvif_Certificate: - properties: - Certificate: - allOf: - - $ref: '#/components/schemas/onvif_BinaryData' - - description: base64 encoded DER representation of certificate. - CertificateID: - description: Certificate id. - type: string - required: - - CertificateID - - Certificate + onvif_MessageDescriptionExtension: type: object - onvif_CertificateGenerationParameters: - properties: - CertificateID: - type: string - Extension: - $ref: '#/components/schemas/onvif_CertificateGenerationParametersExtension' - Subject: - type: string - ValidNotAfter: - type: string - ValidNotBefore: - type: string - type: object - onvif_CertificateGenerationParametersExtension: - type: object - onvif_CertificateInformation: - properties: - CertificateID: - type: string - ExtendedKeyUsage: - $ref: '#/components/schemas/onvif_CertificateUsage' - Extension: - $ref: '#/components/schemas/onvif_CertificateInformationExtension' - IssuerDN: - type: string - KeyLength: - format: int32 - type: integer - KeyUsage: - $ref: '#/components/schemas/onvif_CertificateUsage' - SerialNum: - type: string - SignatureAlgorithm: - description: Validity Range is from "NotBefore" to "NotAfter"; the corresponding - DateTimeRange is from "From" to "Until" - type: string - SubjectDN: - type: string - Validity: - $ref: '#/components/schemas/onvif_DateTimeRange' - Version: - type: string - required: - - CertificateID - type: object - onvif_CertificateInformationExtension: - type: object - onvif_CertificateStatus: - properties: - CertificateID: - description: Certificate id. - type: string - Status: - description: Indicates whether or not a certificate is used in a HTTPS configuration. - type: boolean - required: - - CertificateID - - Status - type: object - onvif_CertificateUsage: - properties: - Critical: - type: boolean - required: - - Critical - type: object - onvif_CertificateWithPrivateKey: - properties: - Certificate: - $ref: '#/components/schemas/onvif_BinaryData' - CertificateID: - type: string - PrivateKey: - $ref: '#/components/schemas/onvif_BinaryData' - required: - - Certificate - - PrivateKey - type: object - onvif_ClassCandidate: - properties: - Likelihood: - type: number - Type: - $ref: '#/components/schemas/onvif_ClassType' - required: - - Type - - Likelihood - type: object - onvif_ClassDescriptor: - properties: - ClassCandidate: - items: - $ref: '#/components/schemas/onvif_ClassCandidate' - type: array - Extension: - $ref: '#/components/schemas/onvif_ClassDescriptorExtension' - Type: - description: ONVIF recommends to use this 'Type' element instead of 'ClassCandidate' - and 'Extension' above for new design. Acceptable values are defined in - tt:ObjectType. - items: - $ref: '#/components/schemas/onvif_StringLikelihood' - type: array - type: object - onvif_ClassDescriptorExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_ClassDescriptorExtension2' - OtherTypes: - items: - $ref: '#/components/schemas/onvif_OtherType' - type: array - required: - - OtherTypes - type: object - onvif_ClassDescriptorExtension2: - type: object - onvif_ClassType: - enum: - - Animal - - Face - - Human - - Vehical - - Other - type: string - onvif_CodingCapabilities: - description: This type contains the Audio and Video coding capabilities of a - display service. - properties: - AudioDecodingCapabilities: - allOf: - - $ref: '#/components/schemas/onvif_AudioDecoderConfigurationOptions' - - description: If the device supports audio decoding this section describes - the supported codecs and their settings. - AudioEncodingCapabilities: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoderConfigurationOptions' - - description: If the device supports audio encoding this section describes - the supported codecs and their configuration. - VideoDecodingCapabilities: - allOf: - - $ref: '#/components/schemas/onvif_VideoDecoderConfigurationOptions' - - description: This section describes the supported video codesc and their - configuration. - required: - - VideoDecodingCapabilities - type: object - onvif_Color: - properties: - Colorspace: - description: 'Acceptable values:' - type: string - X: - type: number - Y: - type: number - Z: - type: number - required: - - X - - Y - - Z - type: object - onvif_ColorCluster: - properties: - Color: - $ref: '#/components/schemas/onvif_Color' - Covariance: - $ref: '#/components/schemas/onvif_ColorCovariance' - Weight: - type: number - required: - - Color - type: object - onvif_ColorCovariance: - properties: - Colorspace: - description: Acceptable values are the same as in tt:Color. - type: string - XX: - type: number - XY: - type: number - XZ: - type: number - YY: - type: number - YZ: - type: number - ZZ: - type: number - required: - - XX - - YY - - ZZ - type: object - onvif_ColorDescriptor: - properties: - ColorCluster: - items: - $ref: '#/components/schemas/onvif_ColorCluster' - type: array - Extension: {} - type: object - onvif_ColorOptions: - description: Describe the colors supported. Either list each color or define - the range of color values. - properties: - ColorList: - description: List the supported color. - items: - $ref: '#/components/schemas/onvif_Color' - type: array - ColorspaceRange: - description: Define the range of color supported. - items: - $ref: '#/components/schemas/onvif_ColorspaceRange' - type: array - type: object - onvif_ColorOptionsChoice0: - properties: - ColorList: - description: List the supported color. - items: - $ref: '#/components/schemas/onvif_Color' - type: array - type: object - onvif_ColorOptionsChoice1: - properties: - ColorspaceRange: - description: Define the range of color supported. - items: - $ref: '#/components/schemas/onvif_ColorspaceRange' - type: array - type: object - onvif_ColorspaceRange: - properties: - Colorspace: - description: Acceptable values are the same as in tt:Color. - type: string - X: - $ref: '#/components/schemas/onvif_FloatRange' - Y: - $ref: '#/components/schemas/onvif_FloatRange' - Z: - $ref: '#/components/schemas/onvif_FloatRange' - required: - - X - - Y - - Z - - Colorspace - type: object - onvif_Config: - properties: - Name: - description: Name of the configuration. - type: string - Parameters: - allOf: - - $ref: '#/components/schemas/onvif_ItemList' - - description: List of configuration parameters as defined in the corresponding - description. - Type: - 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. - type: string - required: - - Name - - Type - - Parameters - type: object - onvif_ConfigDescription: - properties: - Extension: - $ref: '#/components/schemas/onvif_ConfigDescriptionExtension' - Messages: - 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." - items: - $ref: '#/components/schemas/onvif_Messages' - type: array - Name: - description: The Name attribute (e.g. "tt::LineDetector") uniquely identifies - the type of rule, not a type definition in a schema. - type: string - Parameters: - allOf: - - $ref: '#/components/schemas/onvif_ItemListDescription' - - 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." - fixed: - description: The fixed attribute signals that it is not allowed to add or - remove this type of configuration. - type: boolean - maxInstances: - description: The maxInstances attribute signals the maximum number of instances - per configuration. - format: int32 - type: integer - required: - - Name - - Parameters - type: object - onvif_ConfigDescriptionExtension: - type: object - onvif_ConfigurationEntity: - description: Base type defining the common properties of a configuration. - properties: - Name: - description: User readable name. Length up to 64 characters. - maxLength: 64 - type: string - UseCount: - description: Number of internal references currently using this configuration. - format: int32 - type: integer - token: - description: Token that uniquely references this configuration. Length up - to 64 characters. - maxLength: 64 - type: string - required: - - token - - Name - - UseCount - type: object - onvif_ContinuousFocus: - properties: - Speed: - description: Speed parameter for the Continuous focus control. - type: number - required: - - Speed - type: object - onvif_ContinuousFocusOptions: - properties: - Speed: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the speed. - required: - - Speed - type: object - onvif_DNSInformation: - properties: - DNSFromDHCP: - description: List of DNS addresses received from DHCP. - items: - $ref: '#/components/schemas/onvif_IPAddress' - type: array - DNSManual: - description: List of manually entered DNS addresses. - items: - $ref: '#/components/schemas/onvif_IPAddress' - type: array - Extension: - $ref: '#/components/schemas/onvif_DNSInformationExtension' - FromDHCP: - description: Indicates whether or not DNS information is retrieved from - DHCP. - type: boolean - SearchDomain: - description: Search domain. - items: + onvif_Messages: + allOf: + - $ref: '#/components/schemas/onvif_MessageDescription' + - properties: + ParentTopic: + description: The topic of the message. For historical reason the element + is named ParentTopic, but the full topic is expected. type: string - type: array - required: - - FromDHCP - type: object - onvif_DNSInformationExtension: - type: object - onvif_Date: - properties: - Day: - description: Range is 1 to 31. - format: int32 - type: integer - Month: - description: Range is 1 to 12. - format: int32 - type: integer - Year: - format: int32 - type: integer - required: - - Year - - Month - - Day - type: object - onvif_DateTime: - properties: - Date: - $ref: '#/components/schemas/onvif_Date' - Time: - $ref: '#/components/schemas/onvif_Time' - required: - - Time - - Date - type: object - onvif_DateTimeRange: - properties: - From: - format: date-time - type: string - Until: - format: date-time - type: string - required: - - From - - Until - type: object - onvif_Defogging: - properties: - Extension: - $ref: '#/components/schemas/onvif_DefoggingExtension' - Level: - description: Optional level parameter specified with unitless normalized - value from 0.0 to +1.0. - type: number - Mode: - description: Parameter to enable/disable or automatic Defogging feature. - Its options shall be chosen from tt:DefoggingMode Type. - type: string - required: - - Mode - type: object - onvif_DefoggingExtension: - type: object - onvif_DefoggingMode: - enum: - - false - - true - - AUTO - type: string - onvif_DefoggingOptions: - properties: - Level: - description: Indicates whether or not support Level parameter for Defogging. - type: boolean - Mode: - description: Supported options for Defogging mode. Its options shall be - chosen from tt:DefoggingMode Type. - items: - type: string - type: array - required: - - Mode - - Level - type: object - onvif_DeviceCapabilities: - properties: - Extension: - $ref: '#/components/schemas/onvif_DeviceCapabilitiesExtension' - IO: - allOf: - - $ref: '#/components/schemas/onvif_IOCapabilities' - - description: I/O capabilities. - Network: - allOf: - - $ref: '#/components/schemas/onvif_NetworkCapabilities' - - description: Network capabilities. - Security: - allOf: - - $ref: '#/components/schemas/onvif_SecurityCapabilities' - - description: Security capabilities. - System: - allOf: - - $ref: '#/components/schemas/onvif_SystemCapabilities' - - description: System capabilities. - XAddr: - description: Device service URI. - type: string - required: - - XAddr - type: object - onvif_DeviceCapabilitiesExtension: - type: object - onvif_DeviceEntity: - description: Base class for physical entities like inputs and outputs. - properties: - token: - description: Unique identifier referencing the physical entity. - maxLength: 64 - type: string - required: - - token - type: object - onvif_DeviceIOCapabilities: - properties: - AudioOutputs: - format: int32 - type: integer - AudioSources: - format: int32 - type: integer - RelayOutputs: - format: int32 - type: integer - VideoOutputs: - format: int32 - type: integer - VideoSources: - format: int32 - type: integer - XAddr: - type: string - required: - - XAddr - - VideoSources - - VideoOutputs - - AudioSources - - AudioOutputs - - RelayOutputs - type: object - onvif_DigitalIdleState: - enum: - - closed - - open - type: string - onvif_DigitalInput: + required: + - ParentTopic + type: object + 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." + onvif_MetadataConfiguration: allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' + - $ref: '#/components/schemas/onvif_ConfigurationEntity' - properties: - IdleState: + Analytics: + description: Defines whether the streamed metadata will include metadata + from the analytics engines (video, cell motion, audio etc.) + type: boolean + AnalyticsEngineConfiguration: allOf: - - $ref: '#/components/schemas/onvif_DigitalIdleState' - - description: Indicate the Digital IdleState status. - type: object - onvif_Direction: - enum: - - Left - - Right - - Any - type: string - onvif_DiscoveryMode: - enum: - - Discoverable - - NonDiscoverable - type: string - onvif_DisplayCapabilities: - properties: - FixedLayout: - description: Indication that the SetLayout command supports only predefined - layouts. - type: boolean - XAddr: - type: string - required: - - XAddr - - FixedLayout - type: object - onvif_Dot11AuthAndMangementSuite: - enum: - - None - - Dot1X - - PSK - - Extended - type: string - onvif_Dot11AvailableNetworks: - properties: - AuthAndMangementSuite: - description: See IEEE802.11 7.3.2.25.2 for details. - items: - $ref: '#/components/schemas/onvif_Dot11AuthAndMangementSuite' - type: array - BSSID: - type: string - Extension: - $ref: '#/components/schemas/onvif_Dot11AvailableNetworksExtension' - GroupCipher: - items: - $ref: '#/components/schemas/onvif_Dot11Cipher' - type: array - PairCipher: - items: - $ref: '#/components/schemas/onvif_Dot11Cipher' - type: array - SSID: - format: binary - type: string - SignalStrength: - $ref: '#/components/schemas/onvif_Dot11SignalStrength' - required: - - SSID - type: object - onvif_Dot11AvailableNetworksExtension: - type: object - onvif_Dot11Capabilities: - properties: - AdHocStationMode: - type: boolean - MultipleConfiguration: - type: boolean - ScanAvailableNetworks: - type: boolean - TKIP: - type: boolean - WEP: - type: boolean - required: - - TKIP - - ScanAvailableNetworks - - MultipleConfiguration - - AdHocStationMode - - WEP - type: object - onvif_Dot11Cipher: - enum: - - CCMP - - TKIP - - Any - - Extended - type: string - onvif_Dot11Configuration: - properties: - Alias: - maxLength: 64 - type: string - Mode: - $ref: '#/components/schemas/onvif_Dot11StationMode' - Priority: - format: int32 - maximum: 31 - minimum: 0 - type: integer - SSID: - format: binary - type: string - Security: - $ref: '#/components/schemas/onvif_Dot11SecurityConfiguration' - required: - - SSID - - Mode - - Alias - - Priority - - Security - type: object - onvif_Dot11PSKSet: - properties: - Extension: - $ref: '#/components/schemas/onvif_Dot11PSKSetExtension' - Key: - description: According to IEEE802.11-2007 H.4.1 the RSNA PSK consists of - 256 bits, or 64 octets when represented in hex - format: binary - type: string - Passphrase: - 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." - pattern: '[ -~]{8,63}' - type: string - type: object - onvif_Dot11PSKSetExtension: - type: object - onvif_Dot11SecurityConfiguration: - properties: - Algorithm: - $ref: '#/components/schemas/onvif_Dot11Cipher' - Dot1X: - maxLength: 64 - type: string - Extension: - $ref: '#/components/schemas/onvif_Dot11SecurityConfigurationExtension' - Mode: - $ref: '#/components/schemas/onvif_Dot11SecurityMode' - PSK: - $ref: '#/components/schemas/onvif_Dot11PSKSet' - required: - - Mode - type: object - onvif_Dot11SecurityConfigurationExtension: - type: object - onvif_Dot11SecurityMode: - enum: - - None - - WEP - - PSK - - Dot1X - - Extended - type: string - onvif_Dot11SignalStrength: - enum: - - None - - Very Bad - - Bad - - Good - - Very Good - - Extended - type: string - onvif_Dot11StationMode: - enum: - - Ad-hoc - - Infrastructure - - Extended - type: string - onvif_Dot11Status: - properties: - ActiveConfigAlias: - maxLength: 64 - type: string - BSSID: - type: string - GroupCipher: - $ref: '#/components/schemas/onvif_Dot11Cipher' - PairCipher: - $ref: '#/components/schemas/onvif_Dot11Cipher' - SSID: - format: binary - type: string - SignalStrength: - $ref: '#/components/schemas/onvif_Dot11SignalStrength' - required: - - SSID - - ActiveConfigAlias - type: object - onvif_Dot1XConfiguration: - properties: - AnonymousID: - type: string - CACertificateID: - items: + - $ref: '#/components/schemas/onvif_AnalyticsEngineConfiguration' + - 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." + CompressionType: + description: Optional parameter to configure compression type of Metadata + payload. Use values from enumeration MetadataCompressionType. type: string - type: array - Dot1XConfigurationToken: - maxLength: 64 - type: string - EAPMethod: - description: EAP Method type as defined in - format: int32 - type: integer - EAPMethodConfiguration: - $ref: '#/components/schemas/onvif_EAPMethodConfiguration' - Extension: - $ref: '#/components/schemas/onvif_Dot1XConfigurationExtension' - Identity: - type: string - required: - - Dot1XConfigurationToken - - Identity - - EAPMethod - type: object - onvif_Dot1XConfigurationExtension: - type: object - onvif_Dot3Configuration: - type: object - onvif_Duplex: - enum: - - Full - - Half - type: string - onvif_DurationRange: - description: Range of duration greater equal Min duration and less equal Max - duration. - properties: - Max: - format: date-time - type: string - Min: - format: date-time - type: string - required: - - Min - - Max - type: object - onvif_DynamicDNSInformation: - properties: - Extension: - $ref: '#/components/schemas/onvif_DynamicDNSInformationExtension' - Name: - description: DNS name. - type: string - TTL: - description: Time to live. - format: date-time - type: string - Type: - allOf: - - $ref: '#/components/schemas/onvif_DynamicDNSType' - - description: Dynamic DNS type. - required: - - Type - type: object - onvif_DynamicDNSInformationExtension: - type: object - onvif_DynamicDNSType: - enum: - - NoUpdate - - ClientUpdates - - ServerUpdates - type: string - onvif_EAPMethodConfiguration: - properties: - Extension: - $ref: '#/components/schemas/onvif_EapMethodExtension' - Password: - description: Password for those EAP Methods that require a password. The - password shall never be returned on a get method. - type: string - TLSConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_TLSConfiguration' - - description: Confgiuration information for TLS Method. - type: object - onvif_EFlip: - properties: - Mode: - allOf: - - $ref: '#/components/schemas/onvif_EFlipMode' - - description: Parameter to enable/disable E-Flip feature. - required: - - Mode - type: object - onvif_EFlipMode: - enum: - - false - - true - - Extended - type: string - onvif_EFlipOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_EFlipOptionsExtension' - Mode: - description: Options of EFlip mode parameter. - items: - $ref: '#/components/schemas/onvif_EFlipMode' - type: array - type: object - onvif_EFlipOptionsExtension: - type: object - onvif_EapMethodExtension: - type: object - onvif_ElementItem: - description: Complex value structure. - properties: - Name: - description: Item name. - type: string - required: - - Name - type: object - onvif_ElementItemDescription: - description: Description of a complex type. The Type must reference a defined - type. - properties: - Name: - description: Item name. Must be unique within a list. - type: string - Type: - description: The type of the item. The Type must reference a defined type. - type: string - required: - - Name - - Type - type: object - onvif_Enabled: - enum: - - ENABLED - - DISABLED - type: string - onvif_EngineConfiguration: - properties: - AnalyticsEngineInputInfo: - $ref: '#/components/schemas/onvif_AnalyticsEngineInputInfo' - VideoAnalyticsConfiguration: - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - required: - - VideoAnalyticsConfiguration - - AnalyticsEngineInputInfo - type: object - onvif_Entity: - enum: - - Device - - VideoSource - - AudioSource - type: string - onvif_EventCapabilities: - properties: - WSPausableSubscriptionManagerInterfaceSupport: - description: Indicates whether or not WS Pausable Subscription Manager Interface - is supported. - type: boolean - WSPullPointSupport: - description: Indicates whether or not WS Pull Point is supported. - type: boolean - WSSubscriptionPolicySupport: - description: Indicates whether or not WS Subscription policy is supported. - type: boolean - XAddr: - description: Event service URI. - type: string - required: - - XAddr - - WSSubscriptionPolicySupport - - WSPullPointSupport - - WSPausableSubscriptionManagerInterfaceSupport - type: object - onvif_EventFilter: - allOf: - - $ref: '#/components/schemas/wsnt_FilterType' - - type: object - onvif_EventStream: - properties: - Extension: - items: - $ref: '#/components/schemas/onvif_EventStreamExtension' - type: array - NotificationMessage: - items: - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' - type: array - type: object - onvif_EventStreamChoice0: - properties: - NotificationMessage: - items: - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' - type: array - type: object - onvif_EventStreamChoice1: - properties: - Extension: - items: - $ref: '#/components/schemas/onvif_EventStreamExtension' - type: array - type: object - onvif_EventStreamChoice2: - type: object - onvif_EventStreamExtension: - type: object - onvif_EventSubscription: - description: Subcription handling in the same way as base notification subscription. - properties: - Filter: - $ref: '#/components/schemas/wsnt_FilterType' - SubscriptionPolicy: - $ref: '#/components/schemas/onvif_SubscriptionPolicy' - type: object - onvif_Exposure: - properties: - ExposureTime: - description: The fixed exposure time used by the image sensor (μs). - type: number - Gain: - description: The fixed gain used by the image sensor (dB). - type: number - Iris: - description: The fixed attenuation of input light affected by the iris (dB). - 0dB maps to a fully opened iris. - type: number - MaxExposureTime: - description: Maximum value of exposure time range allowed to be used by - the algorithm. - type: number - MaxGain: - description: Maximum value of the sensor gain range that is allowed to be - used by the algorithm. - type: number - MaxIris: - description: Maximum value of the iris range allowed to be used by the algorithm. - type: number - MinExposureTime: - description: Minimum value of exposure time range allowed to be used by - the algorithm. - type: number - MinGain: - description: Minimum value of the sensor gain range that is allowed to be - used by the algorithm. - type: number - MinIris: - description: Minimum value of the iris range allowed to be used by the algorithm. - type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_ExposureMode' - - description: Exposure Mode - Priority: - allOf: - - $ref: '#/components/schemas/onvif_ExposurePriority' - - description: The exposure priority mode (low noise/framerate). - Window: - allOf: - - $ref: '#/components/schemas/onvif_Rectangle' - - description: Rectangular exposure mask. - required: - - Mode - - Priority - - Window - - MinExposureTime - - MaxExposureTime - - MinGain - - MaxGain - - MinIris - - MaxIris - - ExposureTime - - Gain - - Iris - type: object - onvif_Exposure20: - description: Type describing the exposure settings. - properties: - ExposureTime: - description: The fixed exposure time used by the image sensor (μs). - type: number - Gain: - description: The fixed gain used by the image sensor (dB). - type: number - Iris: - 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. - type: number - MaxExposureTime: - description: Maximum value of exposure time range allowed to be used by - the algorithm. - type: number - MaxGain: - description: Maximum value of the sensor gain range that is allowed to be - used by the algorithm. - type: number - MaxIris: - 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. - type: number - MinExposureTime: - description: Minimum value of exposure time range allowed to be used by - the algorithm. - type: number - MinGain: - description: Minimum value of the sensor gain range that is allowed to be - used by the algorithm. - type: number - MinIris: - 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. - type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_ExposureMode' - - description: Exposure Mode - Priority: - allOf: - - $ref: '#/components/schemas/onvif_ExposurePriority' - - description: The exposure priority mode (low noise/framerate). - Window: - allOf: - - $ref: '#/components/schemas/onvif_Rectangle' - - description: Rectangular exposure mask. - required: - - Mode - type: object - onvif_ExposureMode: - enum: - - AUTO - - MANUAL - type: string - onvif_ExposureOptions: - properties: - ExposureTime: - $ref: '#/components/schemas/onvif_FloatRange' - Gain: - $ref: '#/components/schemas/onvif_FloatRange' - Iris: - $ref: '#/components/schemas/onvif_FloatRange' - MaxExposureTime: - $ref: '#/components/schemas/onvif_FloatRange' - MaxGain: - $ref: '#/components/schemas/onvif_FloatRange' - MaxIris: - $ref: '#/components/schemas/onvif_FloatRange' - MinExposureTime: - $ref: '#/components/schemas/onvif_FloatRange' - MinGain: - $ref: '#/components/schemas/onvif_FloatRange' - MinIris: - $ref: '#/components/schemas/onvif_FloatRange' - Mode: - items: - $ref: '#/components/schemas/onvif_ExposureMode' - type: array - Priority: - items: - $ref: '#/components/schemas/onvif_ExposurePriority' - type: array - required: - - Mode - - Priority - - MinExposureTime - - MaxExposureTime - - MinGain - - MaxGain - - MinIris - - MaxIris - - ExposureTime - - Gain - - Iris - type: object - onvif_ExposureOptions20: - properties: - ExposureTime: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the ExposureTime. - Gain: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Gain. - Iris: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Iris. - MaxExposureTime: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Maximum ExposureTime. - MaxGain: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Maximum Gain. - MaxIris: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Maximum Iris. - MinExposureTime: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Minimum ExposureTime. - MinGain: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Minimum Gain. - MinIris: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Minimum Iris. - Mode: - description: Exposure Mode - items: - $ref: '#/components/schemas/onvif_ExposureMode' - type: array - Priority: - description: The exposure priority mode (low noise/framerate). - items: - $ref: '#/components/schemas/onvif_ExposurePriority' - type: array - required: - - Mode - type: object - onvif_ExposurePriority: - enum: - - LowNoise - - FrameRate - type: string - onvif_FactoryDefaultType: - description: Enumeration describing the available factory default modes. - enum: - - Hard - - Soft - type: string - onvif_FileProgress: - properties: - FileName: - description: Exported file name - type: string - Progress: - description: Normalized percentage completion for uploading the exported - file - type: number - required: - - FileName - - Progress - type: object - onvif_FindEventResult: - properties: - Event: - allOf: - - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' - - description: The description of the event. - RecordingToken: - description: The recording where this event was found. Empty string if no - recording is associated with this event. - maxLength: 64 - type: string - StartStateEvent: - 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. - type: boolean - Time: - description: The time when the event occured. - format: date-time - type: string - TrackToken: - description: A reference to the track where this event was found. Empty - string if no track is associated with this event. - maxLength: 64 - type: string - required: - - RecordingToken - - TrackToken - - Time - - Event - - StartStateEvent - type: object - onvif_FindEventResultList: - properties: - Result: - description: A FindEventResult structure for each found event matching the - search. - items: - $ref: '#/components/schemas/onvif_FindEventResult' - type: array - SearchState: - allOf: - - $ref: '#/components/schemas/onvif_SearchState' - - description: The state of the search when the result is returned. Indicates - if there can be more results, or if the search is completed. - required: - - SearchState - type: object - onvif_FindMetadataResult: - properties: - RecordingToken: - description: A reference to the recording containing the metadata. - maxLength: 64 - type: string - Time: - description: The point in time when the matching metadata occurs in the - metadata track. - format: date-time - type: string - TrackToken: - description: A reference to the metadata track containing the matching metadata. - maxLength: 64 - type: string - required: - - RecordingToken - - TrackToken - - Time - type: object - onvif_FindMetadataResultList: - properties: - Result: - description: A FindMetadataResult structure for each found set of Metadata - matching the search. - items: - $ref: '#/components/schemas/onvif_FindMetadataResult' - type: array - SearchState: - allOf: - - $ref: '#/components/schemas/onvif_SearchState' - - description: The state of the search when the result is returned. Indicates - if there can be more results, or if the search is completed. - required: - - SearchState - type: object - onvif_FindPTZPositionResult: - properties: - Position: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - description: The PTZ position. - RecordingToken: - description: A reference to the recording containing the PTZ position. - maxLength: 64 - type: string - Time: - description: The time when the PTZ position was valid. - format: date-time - type: string - TrackToken: - description: A reference to the metadata track containing the PTZ position. - maxLength: 64 - type: string - required: - - RecordingToken - - TrackToken - - Time - - Position - type: object - onvif_FindPTZPositionResultList: - properties: - Result: - description: A FindPTZPositionResult structure for each found PTZ position - matching the search. - items: - $ref: '#/components/schemas/onvif_FindPTZPositionResult' - type: array - SearchState: - allOf: - - $ref: '#/components/schemas/onvif_SearchState' - - description: The state of the search when the result is returned. Indicates - if there can be more results, or if the search is completed. - required: - - SearchState - type: object - onvif_FindRecordingResultList: - properties: - RecordingInformation: - description: A RecordingInformation structure for each found recording matching - the search. - items: - $ref: '#/components/schemas/onvif_RecordingInformation' - type: array - SearchState: - allOf: - - $ref: '#/components/schemas/onvif_SearchState' - - description: The state of the search when the result is returned. Indicates - if there can be more results, or if the search is completed. - required: - - SearchState - type: object - onvif_FloatItems: - properties: - Items: - items: - type: number - type: array - type: object - onvif_FloatRange: - description: Range of values greater equal Min value and less equal Max value. - properties: - Max: - type: number - Min: - type: number - required: - - Min - - Max - type: object - onvif_FocusConfiguration: - properties: - AutoFocusMode: - $ref: '#/components/schemas/onvif_AutoFocusMode' - DefaultSpeed: - type: number - FarLimit: - description: "Parameter to set autofocus far limit (unit: meter).\nIf set\ - \ to 0.0, infinity will be used." - type: number - NearLimit: - description: 'Parameter to set autofocus near limit (unit: meter).' - type: number - required: - - AutoFocusMode - - DefaultSpeed - - NearLimit - - FarLimit - type: object - onvif_FocusConfiguration20: - properties: - AFMode: - description: Zero or more modes as defined in enumeration tt:AFModes. - type: string - AutoFocusMode: - allOf: - - $ref: '#/components/schemas/onvif_AutoFocusMode' - - description: Mode of auto focus. - DefaultSpeed: - type: number - Extension: - $ref: '#/components/schemas/onvif_FocusConfiguration20Extension' - FarLimit: - description: 'Parameter to set autofocus far limit (unit: meter).' - type: number - NearLimit: - description: 'Parameter to set autofocus near limit (unit: meter).' - type: number - required: - - AutoFocusMode - type: object - onvif_FocusConfiguration20Extension: - type: object - onvif_FocusMove: - properties: - Absolute: - allOf: - - $ref: '#/components/schemas/onvif_AbsoluteFocus' - - description: Parameters for the absolute focus control. - Continuous: - allOf: - - $ref: '#/components/schemas/onvif_ContinuousFocus' - - description: Parameter for the continuous focus control. - Relative: - allOf: - - $ref: '#/components/schemas/onvif_RelativeFocus' - - description: Parameters for the relative focus control. - type: object - onvif_FocusOptions: - properties: - AutoFocusModes: - items: - $ref: '#/components/schemas/onvif_AutoFocusMode' - type: array - DefaultSpeed: - $ref: '#/components/schemas/onvif_FloatRange' - FarLimit: - $ref: '#/components/schemas/onvif_FloatRange' - NearLimit: - $ref: '#/components/schemas/onvif_FloatRange' - required: - - DefaultSpeed - - NearLimit - - FarLimit - type: object - onvif_FocusOptions20: - properties: - AutoFocusModes: - description: Supported modes for auto focus. - items: - $ref: '#/components/schemas/onvif_AutoFocusMode' - type: array - DefaultSpeed: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of DefaultSpeed. - Extension: - $ref: '#/components/schemas/onvif_FocusOptions20Extension' - FarLimit: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of FarLimit. - NearLimit: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of NearLimit. - type: object - onvif_FocusOptions20Extension: - properties: - AFModes: - description: Supported options for auto focus. Options shall be chosen from - tt:AFModes. - items: - type: string - type: array - type: object - onvif_FocusStatus: - properties: - Error: - description: Error status of focus. - type: string - MoveStatus: - allOf: - - $ref: '#/components/schemas/onvif_MoveStatus' - - description: Status of focus MoveStatus. - Position: - description: Status of focus position. - type: number - required: - - Position - - MoveStatus - - Error - type: object - onvif_FocusStatus20: - properties: - Error: - description: Error status of focus. - type: string - Extension: - $ref: '#/components/schemas/onvif_FocusStatus20Extension' - MoveStatus: - allOf: - - $ref: '#/components/schemas/onvif_MoveStatus' - - description: Status of focus MoveStatus. - Position: - description: Status of focus position. - type: number - required: - - Position - - MoveStatus - type: object - onvif_FocusStatus20Extension: - type: object - onvif_Frame: - properties: - Colorspace: - description: Default color space of Color definitions in frame. Valid values - are "RGB" and "YCbCr". Defaults to "YCbCr". - type: string - Extension: - $ref: '#/components/schemas/onvif_FrameExtension' - Object: - items: - $ref: '#/components/schemas/onvif_Object' - type: array - ObjectTree: - $ref: '#/components/schemas/onvif_ObjectTree' - PTZStatus: - $ref: '#/components/schemas/onvif_PTZStatus' - SceneImage: - format: binary - type: string - SceneImageRef: - type: string - Source: - description: Optional name of the analytics module that generated this frame. - type: string - Transformation: - $ref: '#/components/schemas/onvif_Transformation' - UtcTime: - format: date-time - type: string - required: - - UtcTime - type: object - onvif_FrameExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_FrameExtension2' - MotionInCells: - $ref: '#/components/schemas/onvif_MotionInCells' - type: object - onvif_FrameExtension2: - type: object - onvif_G711DecOptions: - properties: - Bitrate: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported bitrates in kbps - SampleRateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported sample rates in kHz - required: - - Bitrate - - SampleRateRange - type: object - onvif_G726DecOptions: - properties: - Bitrate: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported bitrates in kbps - SampleRateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported sample rates in kHz - required: - - Bitrate - - SampleRateRange - type: object - onvif_GenericEapPwdConfigurationExtension: - type: object - onvif_GeoLocation: - properties: - elevation: - description: Hight in meters above sea level. - type: number - lat: - description: North south location as angle. - type: number - lon: - description: East west location as angle. - type: number - type: object - onvif_GeoOrientation: - properties: - pitch: - description: Rotation around the y axis. - type: number - roll: - description: Rotation around the x axis. - type: number - yaw: - description: Rotation around the z axis. - type: number - type: object - onvif_GetRecordingJobsResponseItem: - properties: - JobConfiguration: - $ref: '#/components/schemas/onvif_RecordingJobConfiguration' - JobToken: - maxLength: 64 - type: string - required: - - JobToken - - JobConfiguration - type: object - onvif_GetRecordingsResponseItem: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_RecordingConfiguration' - - description: Configuration of the recording. - RecordingToken: - description: Token of the recording. - maxLength: 64 - type: string - Tracks: - allOf: - - $ref: '#/components/schemas/onvif_GetTracksResponseList' - - description: List of tracks. - required: - - RecordingToken - - Configuration - - Tracks - type: object - onvif_GetTracksResponseItem: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_TrackConfiguration' - - description: Configuration of the track. - TrackToken: - description: Token of the track. - maxLength: 64 - type: string - required: - - TrackToken - - Configuration - type: object - onvif_GetTracksResponseList: - properties: - Track: - description: Configuration of a track. - items: - $ref: '#/components/schemas/onvif_GetTracksResponseItem' - type: array - type: object - onvif_H264Configuration: - properties: - GovLength: - 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. - format: int32 - type: integer - H264Profile: - allOf: - - $ref: '#/components/schemas/onvif_H264Profile' - - description: the H.264 profile, either baseline, main, extended or high - required: - - GovLength - - H264Profile - type: object - onvif_H264DecOptions: - properties: - ResolutionsAvailable: - description: List of supported H.264 Video Resolutions - items: - $ref: '#/components/schemas/onvif_VideoResolution' - type: array - SupportedFrameRate: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported H.264 framerate range in fps - SupportedH264Profiles: - description: List of supported H264 Profiles (either baseline, main, extended - or high) - items: - $ref: '#/components/schemas/onvif_H264Profile' - type: array - SupportedInputBitrate: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported H.264 bitrate range in kbps - required: - - ResolutionsAvailable - - SupportedH264Profiles - - SupportedInputBitrate - - SupportedFrameRate - type: object - onvif_H264Options: - properties: - EncodingIntervalRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported encoding interval range. The encoding interval - corresponds to the number of frames devided by the encoded frames. An - encoding interval value of "1" means that all frames are encoded. - FrameRateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported frame rate in fps (frames per second). - GovLengthRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported group of Video frames length. This value typically - corresponds to the I-Frame distance. - H264ProfilesSupported: - description: List of supported H.264 profiles. - items: - $ref: '#/components/schemas/onvif_H264Profile' - type: array - ResolutionsAvailable: - description: List of supported image sizes. - items: - $ref: '#/components/schemas/onvif_VideoResolution' - type: array - required: - - ResolutionsAvailable - - GovLengthRange - - FrameRateRange - - EncodingIntervalRange - - H264ProfilesSupported - type: object - onvif_H264Options2: - allOf: - - $ref: '#/components/schemas/onvif_H264Options' - - properties: - BitrateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported range of encoded bitrate in kbps. - required: - - BitrateRange - type: object - onvif_H264Profile: - enum: - - Baseline - - Main - - Extended - - High - type: string - onvif_HostnameInformation: - properties: - Extension: - $ref: '#/components/schemas/onvif_HostnameInformationExtension' - FromDHCP: - description: Indicates whether the hostname is obtained from DHCP or not. - type: boolean - Name: - description: Indicates the hostname. - type: string - required: - - FromDHCP - type: object - onvif_HostnameInformationExtension: - type: object - onvif_IOCapabilities: - properties: - Extension: - $ref: '#/components/schemas/onvif_IOCapabilitiesExtension' - InputConnectors: - description: Number of input connectors. - format: int32 - type: integer - RelayOutputs: - description: Number of relay outputs. - format: int32 - type: integer - type: object - onvif_IOCapabilitiesExtension: - properties: - Auxiliary: - type: boolean - AuxiliaryCommands: - items: - maxLength: 128 - type: string - type: array - Extension: - $ref: '#/components/schemas/onvif_IOCapabilitiesExtension2' - required: - - Extension - type: object - onvif_IOCapabilitiesExtension2: - type: object - onvif_IPAddress: - properties: - IPv4Address: - description: IPv4 address. - type: string - IPv6Address: - description: IPv6 address - type: string - Type: - allOf: - - $ref: '#/components/schemas/onvif_IPType' - - description: Indicates if the address is an IPv4 or IPv6 address. - required: - - Type - type: object - onvif_IPAddressFilter: - properties: - Extension: - $ref: '#/components/schemas/onvif_IPAddressFilterExtension' - IPv4Address: - items: - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' - type: array - IPv6Address: - items: - $ref: '#/components/schemas/onvif_PrefixedIPv6Address' - type: array - Type: - $ref: '#/components/schemas/onvif_IPAddressFilterType' - required: - - Type - type: object - onvif_IPAddressFilterExtension: - type: object - onvif_IPAddressFilterType: - enum: - - Allow - - Deny - type: string - onvif_IPType: - enum: - - IPv4 - - IPv6 - type: string - onvif_IPv4Configuration: - properties: - DHCP: - description: Indicates whether or not DHCP is used. - type: boolean - FromDHCP: - allOf: - - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' - - description: IPv4 address configured by using DHCP. - LinkLocal: - allOf: - - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' - - description: Link local address. - Manual: - description: List of manually added IPv4 addresses. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' - type: array - required: - - DHCP - type: object - onvif_IPv4NetworkInterface: - properties: - Config: - allOf: - - $ref: '#/components/schemas/onvif_IPv4Configuration' - - description: IPv4 configuration. - Enabled: - description: Indicates whether or not IPv4 is enabled. - type: boolean - required: - - Enabled - - Config - type: object - onvif_IPv4NetworkInterfaceSetConfiguration: - properties: - DHCP: - description: Indicates whether or not DHCP is used. - type: boolean - Enabled: - description: Indicates whether or not IPv4 is enabled. - type: boolean - Manual: - description: List of manually added IPv4 addresses. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv4Address' - type: array - type: object - onvif_IPv6Configuration: - properties: - AcceptRouterAdvert: - description: Indicates whether router advertisment is used. - type: boolean - DHCP: - allOf: - - $ref: '#/components/schemas/onvif_IPv6DHCPConfiguration' - - description: DHCP configuration. - Extension: - $ref: '#/components/schemas/onvif_IPv6ConfigurationExtension' - FromDHCP: - description: List of IPv6 addresses configured by using DHCP. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv6Address' - type: array - FromRA: - description: List of IPv6 addresses configured by using router advertisment. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv6Address' - type: array - LinkLocal: - description: List of link local IPv6 addresses. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv6Address' - type: array - Manual: - description: List of manually entered IPv6 addresses. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv6Address' - type: array - required: - - DHCP - type: object - onvif_IPv6ConfigurationExtension: - type: object - onvif_IPv6DHCPConfiguration: - enum: - - Auto - - Stateful - - Stateless - - false - type: string - onvif_IPv6NetworkInterface: - properties: - Config: - allOf: - - $ref: '#/components/schemas/onvif_IPv6Configuration' - - description: IPv6 configuration. - Enabled: - description: Indicates whether or not IPv6 is enabled. - type: boolean - required: - - Enabled - type: object - onvif_IPv6NetworkInterfaceSetConfiguration: - properties: - AcceptRouterAdvert: - description: Indicates whether router advertisment is used. - type: boolean - DHCP: - allOf: - - $ref: '#/components/schemas/onvif_IPv6DHCPConfiguration' - - description: DHCP configuration. - Enabled: - description: Indicates whether or not IPv6 is enabled. - type: boolean - Manual: - description: List of manually added IPv6 addresses. - items: - $ref: '#/components/schemas/onvif_PrefixedIPv6Address' - type: array - type: object - onvif_Idle: - type: object - onvif_ImageSendingType: - enum: - - Embedded - - LocalStorage - - RemoteStorage - type: string - onvif_ImageStabilization: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImageStabilizationExtension' - Level: - description: Optional level parameter (unit unspecified) - type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_ImageStabilizationMode' - - description: Parameter to enable/disable Image Stabilization feature. - required: - - Mode - type: object - onvif_ImageStabilizationExtension: - type: object - onvif_ImageStabilizationMode: - enum: - - false - - true - - AUTO - - Extended - type: string - onvif_ImageStabilizationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImageStabilizationOptionsExtension' - Level: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of the Image Stabilization. - Mode: - description: Supported options of Image Stabilization mode parameter. - items: - $ref: '#/components/schemas/onvif_ImageStabilizationMode' - type: array - required: - - Mode - type: object - onvif_ImageStabilizationOptionsExtension: - type: object - onvif_ImagingCapabilities: - properties: - XAddr: - description: Imaging service URI. - type: string - required: - - XAddr - type: object - onvif_ImagingOptions: - properties: - BacklightCompensation: - $ref: '#/components/schemas/onvif_BacklightCompensationOptions' - Brightness: - $ref: '#/components/schemas/onvif_FloatRange' - ColorSaturation: - $ref: '#/components/schemas/onvif_FloatRange' - Contrast: - $ref: '#/components/schemas/onvif_FloatRange' - Exposure: - $ref: '#/components/schemas/onvif_ExposureOptions' - Focus: - $ref: '#/components/schemas/onvif_FocusOptions' - IrCutFilterModes: - items: - $ref: '#/components/schemas/onvif_IrCutFilterMode' - type: array - Sharpness: - $ref: '#/components/schemas/onvif_FloatRange' - WhiteBalance: - $ref: '#/components/schemas/onvif_WhiteBalanceOptions' - WideDynamicRange: - $ref: '#/components/schemas/onvif_WideDynamicRangeOptions' - required: - - BacklightCompensation - - Brightness - - ColorSaturation - - Contrast - - Exposure - - Focus - - IrCutFilterModes - - Sharpness - - WideDynamicRange - - WhiteBalance - type: object - onvif_ImagingOptions20: - properties: - BacklightCompensation: - allOf: - - $ref: '#/components/schemas/onvif_BacklightCompensationOptions20' - - description: Valid range of Backlight Compensation. - Brightness: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of Brightness. - ColorSaturation: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of Color Saturation. - Contrast: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of Contrast. - Exposure: - allOf: - - $ref: '#/components/schemas/onvif_ExposureOptions20' - - description: Valid range of Exposure. - Extension: - $ref: '#/components/schemas/onvif_ImagingOptions20Extension' - Focus: - allOf: - - $ref: '#/components/schemas/onvif_FocusOptions20' - - description: Valid range of Focus. - IrCutFilterModes: - description: Valid range of IrCutFilterModes. - items: - $ref: '#/components/schemas/onvif_IrCutFilterMode' - type: array - Sharpness: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid range of Sharpness. - WhiteBalance: - allOf: - - $ref: '#/components/schemas/onvif_WhiteBalanceOptions20' - - description: Valid range of WhiteBalance. - WideDynamicRange: - allOf: - - $ref: '#/components/schemas/onvif_WideDynamicRangeOptions20' - - description: Valid range of WideDynamicRange. - type: object - onvif_ImagingOptions20Extension: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImagingOptions20Extension2' - ImageStabilization: - allOf: - - $ref: '#/components/schemas/onvif_ImageStabilizationOptions' - - description: Options of parameters for Image Stabilization feature. - type: object - onvif_ImagingOptions20Extension2: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImagingOptions20Extension3' - IrCutFilterAutoAdjustment: - allOf: - - $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustmentOptions' - - description: Options of parameters for adjustment of Ir cut filter auto - mode. - type: object - onvif_ImagingOptions20Extension3: - properties: - DefoggingOptions: - allOf: - - $ref: '#/components/schemas/onvif_DefoggingOptions' - - description: Options of parameters for Defogging feature. - Extension: - $ref: '#/components/schemas/onvif_ImagingOptions20Extension4' - NoiseReductionOptions: - allOf: - - $ref: '#/components/schemas/onvif_NoiseReductionOptions' - - description: Options of parameter for Noise Reduction feature. - ToneCompensationOptions: - allOf: - - $ref: '#/components/schemas/onvif_ToneCompensationOptions' - - description: Options of parameters for Tone Compensation feature. - type: object - onvif_ImagingOptions20Extension4: - type: object - onvif_ImagingSettings: - properties: - BacklightCompensation: - allOf: - - $ref: '#/components/schemas/onvif_BacklightCompensation' - - description: Enabled/disabled BLC mode (on/off). - Brightness: - description: Image brightness (unit unspecified). - type: number - ColorSaturation: - description: Color saturation of the image (unit unspecified). - type: number - Contrast: - description: Contrast of the image (unit unspecified). - type: number - Exposure: - allOf: - - $ref: '#/components/schemas/onvif_Exposure' - - description: Exposure mode of the device. - Extension: - $ref: '#/components/schemas/onvif_ImagingSettingsExtension' - Focus: - allOf: - - $ref: '#/components/schemas/onvif_FocusConfiguration' - - description: Focus configuration. - IrCutFilter: - allOf: - - $ref: '#/components/schemas/onvif_IrCutFilterMode' - - description: Infrared Cutoff Filter settings. - Sharpness: - description: Sharpness of the Video image. - type: number - WhiteBalance: - allOf: - - $ref: '#/components/schemas/onvif_WhiteBalance' - - description: White balance settings. - WideDynamicRange: - allOf: - - $ref: '#/components/schemas/onvif_WideDynamicRange' - - description: WDR settings. - type: object - onvif_ImagingSettings20: - description: Type describing the ImagingSettings of a VideoSource. The supported - options and ranges can be obtained via the GetOptions command. - properties: - BacklightCompensation: - allOf: - - $ref: '#/components/schemas/onvif_BacklightCompensation20' - - description: Enabled/disabled BLC mode (on/off). - Brightness: - description: Image brightness (unit unspecified). - type: number - ColorSaturation: - description: Color saturation of the image (unit unspecified). - type: number - Contrast: - description: Contrast of the image (unit unspecified). - type: number - Exposure: - allOf: - - $ref: '#/components/schemas/onvif_Exposure20' - - description: Exposure mode of the device. - Extension: - $ref: '#/components/schemas/onvif_ImagingSettingsExtension20' - Focus: - allOf: - - $ref: '#/components/schemas/onvif_FocusConfiguration20' - - description: Focus configuration. - IrCutFilter: - allOf: - - $ref: '#/components/schemas/onvif_IrCutFilterMode' - - description: Infrared Cutoff Filter settings. - Sharpness: - description: Sharpness of the Video image. - type: number - WhiteBalance: - allOf: - - $ref: '#/components/schemas/onvif_WhiteBalance20' - - description: White balance settings. - WideDynamicRange: - allOf: - - $ref: '#/components/schemas/onvif_WideDynamicRange20' - - description: WDR settings. - type: object - onvif_ImagingSettingsExtension: - type: object - onvif_ImagingSettingsExtension20: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImagingSettingsExtension202' - ImageStabilization: - allOf: - - $ref: '#/components/schemas/onvif_ImageStabilization' - - description: Optional element to configure Image Stabilization feature. - type: object - onvif_ImagingSettingsExtension202: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImagingSettingsExtension203' - IrCutFilterAutoAdjustment: - description: An optional parameter applied to only auto mode to adjust timing - of toggling Ir cut filter. - items: - $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustment' - type: array - type: object - onvif_ImagingSettingsExtension203: - properties: - Defogging: - allOf: - - $ref: '#/components/schemas/onvif_Defogging' - - description: Optional element to configure Image Defogging. - Extension: - $ref: '#/components/schemas/onvif_ImagingSettingsExtension204' - NoiseReduction: - allOf: - - $ref: '#/components/schemas/onvif_NoiseReduction' - - description: Optional element to configure Image Noise Reduction. - ToneCompensation: - allOf: - - $ref: '#/components/schemas/onvif_ToneCompensation' - - description: Optional element to configure Image Contrast Compensation. - type: object - onvif_ImagingSettingsExtension204: - type: object - onvif_ImagingStatus: - properties: - FocusStatus: - $ref: '#/components/schemas/onvif_FocusStatus' - required: - - FocusStatus - type: object - onvif_ImagingStatus20: - properties: - Extension: - $ref: '#/components/schemas/onvif_ImagingStatus20Extension' - FocusStatus20: - allOf: - - $ref: '#/components/schemas/onvif_FocusStatus20' - - description: Status of focus. - type: object - onvif_ImagingStatus20Extension: - type: object - onvif_IntItems: - description: List of values. - properties: - Items: - items: - format: int32 - type: integer - type: array - type: object - onvif_IntRange: - description: Range of values greater equal Min value and less equal Max value. - properties: - Max: - format: int32 - type: integer - Min: - format: int32 - type: integer - required: - - Min - - Max - type: object - onvif_IntRectangle: - description: Rectangle defined by lower left corner position and size. Units - are pixel. - properties: - height: - format: int32 - type: integer - width: - format: int32 - type: integer - x: - format: int32 - type: integer - y: - format: int32 - type: integer - required: - - x - - y - - width - - height - type: object - onvif_IntRectangleRange: - description: Range of a rectangle. The rectangle itself is defined by lower - left corner position and size. Units are pixel. - properties: - HeightRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of height. - WidthRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of width. - XRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of X-axis. - YRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of Y-axis. - required: - - XRange - - YRange - - WidthRange - - HeightRange - type: object - onvif_IrCutFilterAutoAdjustment: - properties: - BoundaryOffset: - 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). - type: number - BoundaryType: - description: Specifies which boundaries to automatically toggle Ir cut filter - following parameters are applied to. Its options shall be chosen from - tt:IrCutFilterAutoBoundaryType. - type: string - Extension: - $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustmentExtension' - ResponseTime: - description: Delay time of toggling Ir cut filter to on/off after crossing - of the boundary exposure levels. - format: date-time - type: string - required: - - BoundaryType - type: object - onvif_IrCutFilterAutoAdjustmentExtension: - type: object - onvif_IrCutFilterAutoAdjustmentOptions: - properties: - BoundaryOffset: - description: Indicates whether or not boundary offset for toggling Ir cut - filter is supported. - type: boolean - BoundaryType: - description: Supported options of boundary types for adjustment of Ir cut - filter auto mode. The opptions shall be chosen from tt:IrCutFilterAutoBoundaryType. - items: - type: string - type: array - Extension: - $ref: '#/components/schemas/onvif_IrCutFilterAutoAdjustmentOptionsExtension' - ResponseTimeRange: - allOf: - - $ref: '#/components/schemas/onvif_DurationRange' - - description: Supported range of delay time for toggling Ir cut filter. - required: - - BoundaryType - type: object - onvif_IrCutFilterAutoAdjustmentOptionsExtension: - type: object - onvif_IrCutFilterAutoBoundaryType: - enum: - - Common - - ToOn - - ToOff - - Extended - type: string - onvif_IrCutFilterMode: - enum: - - true - - false - - AUTO - type: string - onvif_ItemList: - properties: - ElementItem: - description: Complex value structure. - items: - $ref: '#/components/schemas/onvif_ElementItem' - type: array - Extension: - $ref: '#/components/schemas/onvif_ItemListExtension' - SimpleItem: - description: Value name pair as defined by the corresponding description. - items: - $ref: '#/components/schemas/onvif_SimpleItem' - type: array - type: object - onvif_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." - properties: - ElementItemDescription: - description: Description of a complex type. The Type must reference a defined - type. - items: - $ref: '#/components/schemas/onvif_ElementItemDescription' - type: array - Extension: - $ref: '#/components/schemas/onvif_ItemListDescriptionExtension' - SimpleItemDescription: - description: Description of a simple item. The type must be of cathegory - simpleType (xs:string, xs:integer, xs:float, ...). - items: - $ref: '#/components/schemas/onvif_SimpleItemDescription' - type: array - type: object - onvif_ItemListDescriptionExtension: - type: object - onvif_ItemListExtension: - type: object - onvif_JpegDecOptions: - properties: - ResolutionsAvailable: - description: List of supported Jpeg Video Resolutions - items: - $ref: '#/components/schemas/onvif_VideoResolution' - type: array - SupportedFrameRate: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported Jpeg framerate range in fps - SupportedInputBitrate: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported Jpeg bitrate range in kbps - required: - - ResolutionsAvailable - - SupportedInputBitrate - - SupportedFrameRate - type: object - onvif_JpegOptions: - properties: - EncodingIntervalRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported encoding interval range. The encoding interval - corresponds to the number of frames devided by the encoded frames. An - encoding interval value of "1" means that all frames are encoded. - FrameRateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported frame rate in fps (frames per second). - ResolutionsAvailable: - description: List of supported image sizes. - items: - $ref: '#/components/schemas/onvif_VideoResolution' - type: array - required: - - ResolutionsAvailable - - FrameRateRange - - EncodingIntervalRange - type: object - onvif_JpegOptions2: - allOf: - - $ref: '#/components/schemas/onvif_JpegOptions' - - properties: - BitrateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported range of encoded bitrate in kbps. - required: - - BitrateRange - type: object - onvif_Layout: - description: A layout describes a set of Video windows that are displayed simultaniously - on a display. - properties: - Extension: - $ref: '#/components/schemas/onvif_LayoutExtension' - PaneLayout: - description: List of panes assembling the display layout. - items: - $ref: '#/components/schemas/onvif_PaneLayout' - type: array - required: - - PaneLayout - type: object - onvif_LayoutExtension: - type: object - onvif_LayoutOptions: - description: The options supported for a display layout. - properties: - Extension: - $ref: '#/components/schemas/onvif_LayoutOptionsExtension' - PaneLayoutOptions: - description: Lists the possible Pane Layouts of the Video Output - items: - $ref: '#/components/schemas/onvif_PaneLayoutOptions' - type: array - required: - - PaneLayoutOptions - type: object - onvif_LayoutOptionsExtension: - type: object - onvif_LensDescription: - properties: - FocalLength: - description: Optional focal length of the optical system. - type: number - Offset: - allOf: - - $ref: '#/components/schemas/onvif_LensOffset' - - description: Offset of the lens center to the imager center in normalized - coordinates. - Projection: - description: "Radial description of the projection characteristics. The\ - \ resulting curve is defined by the B-Spline interpolation \n\t\t\t\t\t\ - over 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)." - items: - $ref: '#/components/schemas/onvif_LensProjection' - type: array - XFactor: - description: Compensation of the x coordinate needed for the ONVIF normalized - coordinate system. - type: number - required: - - Offset - - Projection - - XFactor - type: object - onvif_LensOffset: - properties: - x: - description: Optional horizontal offset of the lens center in normalized - coordinates. - type: number - y: - description: Optional vertical offset of the lens center in normalized coordinates. - type: number - type: object - onvif_LensProjection: - properties: - Angle: - description: Angle of incidence. - type: number - Radius: - description: Mapping radius as a consequence of the emergent angle. - type: number - Transmittance: - description: Optional ray absorption at the given angle due to vignetting. - A value of one means no absorption. - type: number - required: - - Angle - - Radius - type: object - onvif_LicensePlateInfo: - properties: - CountryCode: - allOf: - - $ref: '#/components/schemas/onvif_StringLikelihood' - - description: Describe the country of the license plate, in order to avoid - the same license plate number. - IssuingEntity: - allOf: - - $ref: '#/components/schemas/onvif_StringLikelihood' - - description: State province or authority that issue the license plate. - PlateNumber: - allOf: - - $ref: '#/components/schemas/onvif_StringLikelihood' - - description: A string of vehicle license plate number. - PlateType: - allOf: - - $ref: '#/components/schemas/onvif_StringLikelihood' - - description: A description of the vehicle license plate, e.g., "Normal", - "Police", "Diplomat" - required: - - PlateNumber - type: object - onvif_LocalLocation: - properties: - x: - description: East west location as angle. - type: number - y: - description: North south location as angle. - type: number - z: - description: Offset in meters from the sea level. - type: number - type: object - onvif_LocalOrientation: - properties: - pan: - description: Rotation around the y axis. - type: number - roll: - description: Rotation around the x axis. - type: number - tilt: - description: Rotation around the z axis. - type: number - type: object - onvif_LocationEntity: - properties: - AutoGeo: - description: If set the geo location is obtained internally. - type: boolean - Entity: - description: Entity type the entry refers to, use a value from the tt:Entity - enumeration. - type: string - Fixed: - description: If this value is true the entity cannot be deleted. - type: boolean - GeoLocation: - allOf: - - $ref: '#/components/schemas/onvif_GeoLocation' - - description: Location on earth. - GeoOrientation: - allOf: - - $ref: '#/components/schemas/onvif_GeoOrientation' - - description: Orientation relative to earth. - GeoSource: - description: Optional reference to the XAddr of another devices DeviceManagement - service. - type: string - LocalLocation: - allOf: - - $ref: '#/components/schemas/onvif_LocalLocation' - - description: Indoor location offset. - LocalOrientation: - allOf: - - $ref: '#/components/schemas/onvif_LocalOrientation' - - description: Indoor orientation offset. - Token: - description: Optional entity token. - maxLength: 64 - type: string - type: object - onvif_MaximumNumberOfOSDs: - properties: - Date: - format: int32 - type: integer - DateAndTime: - format: int32 - type: integer - Image: - format: int32 - type: integer - PlainText: - format: int32 - type: integer - Time: - format: int32 - type: integer - Total: - format: int32 - type: integer - required: - - Total - type: object - onvif_MediaAttributes: - description: A set of media attributes valid for a recording at a point in time - or for a time interval. - properties: - From: - description: The attributes are valid from this point in time in the recording. - format: date-time - type: string - RecordingToken: - description: A reference to the recording that has these attributes. - maxLength: 64 - type: string - TrackAttributes: - description: A set of attributes for each track. - items: - $ref: '#/components/schemas/onvif_TrackAttributes' - type: array - Until: - 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. - format: date-time - type: string - required: - - RecordingToken - - From - - Until - type: object - onvif_MediaCapabilities: - properties: - Extension: - $ref: '#/components/schemas/onvif_MediaCapabilitiesExtension' - StreamingCapabilities: - allOf: - - $ref: '#/components/schemas/onvif_RealTimeStreamingCapabilities' - - description: Streaming capabilities. - XAddr: - description: Media service URI. - type: string - required: - - XAddr - - StreamingCapabilities - type: object - onvif_MediaCapabilitiesExtension: - properties: - ProfileCapabilities: - $ref: '#/components/schemas/onvif_ProfileCapabilities' - required: - - ProfileCapabilities - type: object - onvif_MediaUri: - properties: - InvalidAfterConnect: - description: Indicates if the Uri is only valid until the connection is - established. The value shall be set to "false". - type: boolean - InvalidAfterReboot: - description: Indicates if the Uri is invalid after a reboot of the device. - The value shall be set to "false". - type: boolean - Timeout: - 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 - format: date-time - type: string - Uri: - description: Stable Uri to be used for requesting the media stream - type: string - required: - - Uri - - InvalidAfterConnect - - InvalidAfterReboot - - Timeout - type: object - onvif_Merge: - properties: - from: - items: - $ref: '#/components/schemas/onvif_ObjectId' - type: array - to: - $ref: '#/components/schemas/onvif_ObjectId' - required: - - from - - to - type: object - onvif_Message: - properties: - Data: - $ref: '#/components/schemas/onvif_ItemList' - Extension: - $ref: '#/components/schemas/onvif_MessageExtension' - Key: - $ref: '#/components/schemas/onvif_ItemList' - PropertyOperation: - $ref: '#/components/schemas/onvif_PropertyOperation' - Source: - allOf: - - $ref: '#/components/schemas/onvif_ItemList' - - description: Token value pairs that triggered this message. Typically - only one item is present. - UtcTime: - format: date-time - type: string - required: - - UtcTime - type: object - onvif_MessageDescription: - properties: - Data: - allOf: - - $ref: '#/components/schemas/onvif_ItemListDescription' - - description: Describes the payload of the message. - Extension: - $ref: '#/components/schemas/onvif_MessageDescriptionExtension' - IsProperty: - 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. - type: boolean - Key: - allOf: - - $ref: '#/components/schemas/onvif_ItemListDescription' - - description: Describes optional message payload parameters that may be - used as key. E.g. object IDs of tracked objects are conveyed as key. - Source: - allOf: - - $ref: '#/components/schemas/onvif_ItemListDescription' - - 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." - type: object - onvif_MessageDescriptionExtension: - type: object - onvif_MessageExtension: - type: object - onvif_Messages: - allOf: - - $ref: '#/components/schemas/onvif_MessageDescription' - - properties: - ParentTopic: - description: The topic of the message. For historical reason the element - is named ParentTopic, but the full topic is expected. - type: string - required: - - ParentTopic - type: object - 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." - onvif_MetadataAttributes: - properties: - CanContainAnalytics: - description: Indicates that there can be analytics data in the metadata - track in the specified time interval. - type: boolean - CanContainNotifications: - description: Indicates that there can be notifications in the metadata track - in the specified time interval. - type: boolean - CanContainPTZ: - description: Indicates that there can be PTZ data in the metadata track - in the specified time interval. - type: boolean - PtzSpaces: - 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. - type: string - required: - - CanContainPTZ - - CanContainAnalytics - - CanContainNotifications - type: object - onvif_MetadataCompressionType: - enum: - - None - - GZIP - - EXI - type: string - onvif_MetadataConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - Analytics: - description: Defines whether the streamed metadata will include metadata - from the analytics engines (video, cell motion, audio etc.) - type: boolean - AnalyticsEngineConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_AnalyticsEngineConfiguration' - - 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." - CompressionType: - description: Optional parameter to configure compression type of Metadata - payload. Use values from enumeration MetadataCompressionType. - type: string - Events: - allOf: - - $ref: '#/components/schemas/onvif_EventSubscription' - - 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\t\ - none or some of the events produced by the device:" - Extension: - $ref: '#/components/schemas/onvif_MetadataConfigurationExtension' - GeoLocation: - description: Optional parameter to configure if the metadata stream shall - contain the Geo Location coordinates of each target. - type: boolean - Multicast: - allOf: - - $ref: '#/components/schemas/onvif_MulticastConfiguration' - - description: Defines the multicast settings that could be used for video - streaming. - PTZStatus: - allOf: - - $ref: '#/components/schemas/onvif_PTZFilter' - - description: optional element to configure which PTZ related data is - to include in the metadata stream - SessionTimeout: - description: The rtsp session timeout for the related audio stream (when - using Media2 Service, this value is deprecated and ignored) - format: date-time - type: string - ShapePolygon: - description: Optional parameter to configure if the generated metadata - stream should contain shape information as polygon. - type: boolean - required: - - Multicast - - SessionTimeout - type: object - onvif_MetadataConfigurationExtension: - type: object - onvif_MetadataConfigurationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_MetadataConfigurationOptionsExtension' - GeoLocation: - description: True if the device is able to stream the Geo Located positions - of each target. - type: boolean - MaxContentFilterSize: - description: A device signalling support for content filtering shall support - expressions with the provided expression size. - format: int32 - type: integer - PTZStatusFilterOptions: - $ref: '#/components/schemas/onvif_PTZStatusFilterOptions' - required: - - PTZStatusFilterOptions - type: object - onvif_MetadataConfigurationOptionsExtension: - properties: - CompressionType: - description: List of supported metadata compression type. Its options shall - be chosen from tt:MetadataCompressionType. - items: - type: string - type: array - Extension: - $ref: '#/components/schemas/onvif_MetadataConfigurationOptionsExtension2' - type: object - onvif_MetadataConfigurationOptionsExtension2: - type: object - onvif_MetadataFilter: - properties: - MetadataStreamFilter: - type: string - required: - - MetadataStreamFilter - type: object - onvif_MetadataInput: - properties: - Extension: - $ref: '#/components/schemas/onvif_MetadataInputExtension' - MetadataConfig: - items: - $ref: '#/components/schemas/onvif_Config' - type: array - type: object - onvif_MetadataInputExtension: - type: object - onvif_MetadataStream: - properties: - Event: - items: - oneOf: - - $ref: '#/components/schemas/onvif_EventStreamChoice0' - - $ref: '#/components/schemas/onvif_EventStreamChoice1' - - $ref: '#/components/schemas/onvif_EventStreamChoice2' - type: array - Extension: - items: - $ref: '#/components/schemas/onvif_MetadataStreamExtension' - type: array - PTZ: - items: - oneOf: - - $ref: '#/components/schemas/onvif_PTZStreamChoice0' - - $ref: '#/components/schemas/onvif_PTZStreamChoice1' - - $ref: '#/components/schemas/onvif_PTZStreamChoice2' - type: array - VideoAnalytics: - items: - oneOf: - - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamChoice0' - - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamChoice1' - - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamChoice2' - type: array - type: object - onvif_MetadataStreamExtension: - properties: - AudioAnalyticsStream: - $ref: '#/components/schemas/onvif_AudioAnalyticsStream' - Extension: - $ref: '#/components/schemas/onvif_MetadataStreamExtension2' - type: object - onvif_MetadataStreamExtension2: - type: object - onvif_ModeOfOperation: - enum: - - Idle - - Active - - Unknown - type: string - onvif_MotionExpression: - properties: - Expression: - description: Motion Expression data structure contains motion expression - which is based on Scene Descriptor schema with XPATH syntax. The Type - argument could allow introduction of different dialects - type: string - Type: - type: string - required: - - Expression - type: object - onvif_MotionExpressionConfiguration: - properties: - MotionExpression: - allOf: - - $ref: '#/components/schemas/onvif_MotionExpression' - - description: Contains Rule MotionExpression configuration - required: - - MotionExpression - type: object - onvif_MotionInCells: - properties: - Cells: - description: A “1” denotes a cell where motion is detected and a “0” 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 Packbit coding in ISO - 12369 (TIFF, Revision 6.0). - format: binary - type: string - Columns: - description: Number of columns of the cell grid (x dimension) - format: int32 - type: integer - Rows: - description: Number of rows of the cell grid (y dimension) - format: int32 - type: integer - required: - - Columns - - Rows - - Cells - type: object - onvif_MoveAndTrackMethod: - enum: - - PresetToken - - GeoLocation - - PTZVector - - ObjectID - type: string - onvif_MoveOptions: - properties: - Absolute: - $ref: '#/components/schemas/onvif_AbsoluteFocusOptions' - Continuous: - $ref: '#/components/schemas/onvif_ContinuousFocusOptions' - Relative: - $ref: '#/components/schemas/onvif_RelativeFocusOptions' - type: object - onvif_MoveOptions20: - properties: - Absolute: - allOf: - - $ref: '#/components/schemas/onvif_AbsoluteFocusOptions' - - description: Valid ranges for the absolute control. - Continuous: - allOf: - - $ref: '#/components/schemas/onvif_ContinuousFocusOptions' - - description: Valid ranges for the continuous control. - Relative: - allOf: - - $ref: '#/components/schemas/onvif_RelativeFocusOptions20' - - description: Valid ranges for the relative control. - type: object - onvif_MoveStatus: - enum: - - IDLE - - MOVING - - UNKNOWN - type: string - onvif_Mpeg4Configuration: - properties: - GovLength: - 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. - format: int32 - type: integer - Mpeg4Profile: - allOf: - - $ref: '#/components/schemas/onvif_Mpeg4Profile' - - description: the Mpeg4 profile, either simple profile (SP) or advanced - simple profile (ASP) - required: - - GovLength - - Mpeg4Profile - type: object - onvif_Mpeg4DecOptions: - properties: - ResolutionsAvailable: - description: List of supported Mpeg4 Video Resolutions - items: - $ref: '#/components/schemas/onvif_VideoResolution' - type: array - SupportedFrameRate: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported Mpeg4 framerate range in fps - SupportedInputBitrate: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported Mpeg4 bitrate range in kbps - SupportedMpeg4Profiles: - description: List of supported Mpeg4 Profiles (either SP or ASP) - items: - $ref: '#/components/schemas/onvif_Mpeg4Profile' - type: array - required: - - ResolutionsAvailable - - SupportedMpeg4Profiles - - SupportedInputBitrate - - SupportedFrameRate - type: object - onvif_Mpeg4Options: - properties: - EncodingIntervalRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported encoding interval range. The encoding interval - corresponds to the number of frames devided by the encoded frames. An - encoding interval value of "1" means that all frames are encoded. - FrameRateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported frame rate in fps (frames per second). - GovLengthRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported group of Video frames length. This value typically - corresponds to the I-Frame distance. - Mpeg4ProfilesSupported: - description: List of supported MPEG-4 profiles. - items: - $ref: '#/components/schemas/onvif_Mpeg4Profile' - type: array - ResolutionsAvailable: - description: List of supported image sizes. - items: - $ref: '#/components/schemas/onvif_VideoResolution' - type: array - required: - - ResolutionsAvailable - - GovLengthRange - - FrameRateRange - - EncodingIntervalRange - - Mpeg4ProfilesSupported - type: object - onvif_Mpeg4Options2: - allOf: - - $ref: '#/components/schemas/onvif_Mpeg4Options' - - properties: - BitrateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported range of encoded bitrate in kbps. - required: - - BitrateRange - type: object - onvif_Mpeg4Profile: - enum: - - SP - - ASP - type: string - onvif_MulticastConfiguration: - properties: - Address: - allOf: - - $ref: '#/components/schemas/onvif_IPAddress' - - description: The multicast address (if this address is set to 0 no multicast - streaming is enaled) - AutoStart: - description: Read only property signalling that streaming is persistant. - Use the methods StartMulticastStreaming and StopMulticastStreaming to - switch its state. - type: boolean - Port: - description: The RTP mutlicast 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. - format: int32 - type: integer - TTL: - 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. - format: int32 - type: integer - required: - - Address - - Port - - TTL - - AutoStart - type: object - onvif_NTPInformation: - properties: - Extension: - $ref: '#/components/schemas/onvif_NTPInformationExtension' - FromDHCP: - description: Indicates if NTP information is to be retrieved by using DHCP. - type: boolean - NTPFromDHCP: - description: List of NTP addresses retrieved by using DHCP. - items: - $ref: '#/components/schemas/onvif_NetworkHost' - type: array - NTPManual: - description: List of manually entered NTP addresses. - items: - $ref: '#/components/schemas/onvif_NetworkHost' - type: array - required: - - FromDHCP - type: object - onvif_NTPInformationExtension: - type: object - onvif_NetworkCapabilities: - properties: - DynDNS: - description: Indicates whether or not is supported. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_NetworkCapabilitiesExtension' - IPFilter: - description: Indicates whether or not IP filtering is supported. - type: boolean - IPVersion6: - description: Indicates whether or not IPv6 is supported. - type: boolean - ZeroConfiguration: - description: Indicates whether or not zeroconf is supported. - type: boolean - type: object - onvif_NetworkCapabilitiesExtension: - properties: - Dot11Configuration: - type: boolean - Extension: - $ref: '#/components/schemas/onvif_NetworkCapabilitiesExtension2' - type: object - onvif_NetworkCapabilitiesExtension2: - type: object - onvif_NetworkGateway: - properties: - IPv4Address: - description: IPv4 address string. - items: - type: string - type: array - IPv6Address: - description: IPv6 address string. - items: - type: string - type: array - type: object - onvif_NetworkHost: - properties: - DNSname: - description: DNS name. - type: string - Extension: - $ref: '#/components/schemas/onvif_NetworkHostExtension' - IPv4Address: - description: IPv4 address. - type: string - IPv6Address: - description: IPv6 address. - type: string - Type: - allOf: - - $ref: '#/components/schemas/onvif_NetworkHostType' - - description: 'Network host type: IPv4, IPv6 or DNS.' - required: - - Type - type: object - onvif_NetworkHostExtension: - type: object - onvif_NetworkHostType: - enum: - - IPv4 - - IPv6 - - DNS - type: string - onvif_NetworkInterface: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - Enabled: - description: Indicates whether or not an interface is enabled. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_NetworkInterfaceExtension' - IPv4: - allOf: - - $ref: '#/components/schemas/onvif_IPv4NetworkInterface' - - description: IPv4 network interface configuration. - IPv6: - allOf: - - $ref: '#/components/schemas/onvif_IPv6NetworkInterface' - - description: IPv6 network interface configuration. - Info: - allOf: - - $ref: '#/components/schemas/onvif_NetworkInterfaceInfo' - - description: Network interface information - Link: - allOf: - - $ref: '#/components/schemas/onvif_NetworkInterfaceLink' - - description: Link configuration. - required: - - Enabled - type: object - onvif_NetworkInterfaceConnectionSetting: - properties: - AutoNegotiation: - description: Auto negotiation on/off. - type: boolean - Duplex: - allOf: - - $ref: '#/components/schemas/onvif_Duplex' - - description: Duplex type, Half or Full. - Speed: - description: Speed. - format: int32 - type: integer - required: - - AutoNegotiation - - Speed - - Duplex - type: object - onvif_NetworkInterfaceExtension: - properties: - Dot11: - items: - $ref: '#/components/schemas/onvif_Dot11Configuration' - type: array - Dot3: - description: Extension point prepared for future 802.3 configuration. - items: - $ref: '#/components/schemas/onvif_Dot3Configuration' - type: array - Extension: - $ref: '#/components/schemas/onvif_NetworkInterfaceExtension2' - InterfaceType: - format: int32 - type: integer - required: - - InterfaceType - type: object - onvif_NetworkInterfaceExtension2: - type: object - onvif_NetworkInterfaceInfo: - properties: - HwAddress: - description: Network interface MAC address. - type: string - MTU: - description: Maximum transmission unit. - format: int32 - type: integer - Name: - description: Network interface name, for example eth0. - type: string - required: - - HwAddress - type: object - onvif_NetworkInterfaceLink: - properties: - AdminSettings: - allOf: - - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' - - description: Configured link settings. - InterfaceType: - description: 'Integer indicating interface type, for example: 6 is ethernet.' - format: int32 - type: integer - OperSettings: - allOf: - - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' - - description: Current active link settings. - required: - - AdminSettings - - OperSettings - - InterfaceType - type: object - onvif_NetworkInterfaceSetConfiguration: - properties: - Enabled: - description: Indicates whether or not an interface is enabled. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfigurationExtension' - IPv4: - allOf: - - $ref: '#/components/schemas/onvif_IPv4NetworkInterfaceSetConfiguration' - - description: IPv4 network interface configuration. - IPv6: - allOf: - - $ref: '#/components/schemas/onvif_IPv6NetworkInterfaceSetConfiguration' - - description: IPv6 network interface configuration. - Link: - allOf: - - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' - - description: Link configuration. - MTU: - description: Maximum transmission unit. - format: int32 - type: integer - type: object - onvif_NetworkInterfaceSetConfigurationExtension: - properties: - Dot11: - items: - $ref: '#/components/schemas/onvif_Dot11Configuration' - type: array - Dot3: - items: - $ref: '#/components/schemas/onvif_Dot3Configuration' - type: array - Extension: - $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfigurationExtension2' - type: object - onvif_NetworkInterfaceSetConfigurationExtension2: - type: object - onvif_NetworkProtocol: - properties: - Enabled: - description: Indicates if the protocol is enabled or not. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_NetworkProtocolExtension' - Name: - allOf: - - $ref: '#/components/schemas/onvif_NetworkProtocolType' - - description: Network protocol type string. - Port: - description: The port that is used by the protocol. - items: - format: int32 - type: integer - type: array - required: - - Name - - Enabled - - Port - type: object - onvif_NetworkProtocolExtension: - type: object - onvif_NetworkProtocolType: - enum: - - HTTP - - HTTPS - - RTSP - type: string - onvif_NetworkZeroConfiguration: - properties: - Addresses: - description: The zero-configuration IPv4 address(es) - items: - type: string - type: array - Enabled: - description: Indicates whether the zero-configuration is enabled or not. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_NetworkZeroConfigurationExtension' - InterfaceToken: - description: Unique identifier of network interface. - maxLength: 64 - type: string - required: - - InterfaceToken - - Enabled - type: object - onvif_NetworkZeroConfigurationExtension: - properties: - Additional: - description: Optional array holding the configuration for the second and - possibly further interfaces. - items: - $ref: '#/components/schemas/onvif_NetworkZeroConfiguration' - type: array - Extension: - $ref: '#/components/schemas/onvif_NetworkZeroConfigurationExtension2' - type: object - onvif_NetworkZeroConfigurationExtension2: - type: object - onvif_NoiseReduction: - properties: - Level: - description: Level parameter specified with unitless normalized value from - 0.0 to +1.0. Level=0 means no noise reduction or minimal noise reduction. - type: number - required: - - Level - type: object - onvif_NoiseReductionOptions: - properties: - Level: - description: Indicates whether or not support Level parameter for NoiseReduction. - type: boolean - required: - - Level - type: object - onvif_OSDColor: - description: 'The value range of "Transparent" could be defined by vendors only - should follow this rule: the minimum value means non-transparent and the maximum - value maens fully transparent.' - properties: - Color: - $ref: '#/components/schemas/onvif_Color' - Transparent: - format: int32 - type: integer - required: - - Color - type: object - onvif_OSDColorOptions: - description: Describe the option of the color and its transparency. - properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorOptions' - - description: Optional list of supported colors. - Extension: - $ref: '#/components/schemas/onvif_OSDColorOptionsExtension' - Transparent: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of the transparent level. Larger means more tranparent. - type: object - onvif_OSDColorOptionsExtension: - type: object - onvif_OSDConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - Extension: - $ref: '#/components/schemas/onvif_OSDConfigurationExtension' - Image: - allOf: - - $ref: '#/components/schemas/onvif_OSDImgConfiguration' - - description: Image configuration of OSD. It shall be present when the - value of Type field is Image - Position: - allOf: - - $ref: '#/components/schemas/onvif_OSDPosConfiguration' - - description: Position configuration of OSD. - TextString: - allOf: - - $ref: '#/components/schemas/onvif_OSDTextConfiguration' - - description: Text configuration of OSD. It shall be present when the - value of Type field is Text. - Type: - allOf: - - $ref: '#/components/schemas/onvif_OSDType' - - description: Type of OSD. - VideoSourceConfigurationToken: - allOf: - - $ref: '#/components/schemas/onvif_OSDReference' - - description: Reference to the video source configuration. - required: - - VideoSourceConfigurationToken - - Type - - Position - type: object - onvif_OSDConfigurationExtension: - type: object - onvif_OSDConfigurationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_OSDConfigurationOptionsExtension' - ImageOption: - allOf: - - $ref: '#/components/schemas/onvif_OSDImgOptions' - - description: Option of the OSD image configuration. This element shall - be returned if the device is signaling the support for Image. - MaximumNumberOfOSDs: - allOf: - - $ref: '#/components/schemas/onvif_MaximumNumberOfOSDs' - - 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. - PositionOption: - description: 'List available OSD position type. Following are the pre-defined:' - items: - type: string - type: array - TextOption: - allOf: - - $ref: '#/components/schemas/onvif_OSDTextOptions' - - description: Option of the OSD text configuration. This element shall - be returned if the device is signaling the support for Text. - Type: - 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. - items: - $ref: '#/components/schemas/onvif_OSDType' - type: array - required: - - MaximumNumberOfOSDs - - Type - - PositionOption - type: object - onvif_OSDConfigurationOptionsExtension: - type: object - onvif_OSDImgConfiguration: - properties: - Extension: - $ref: '#/components/schemas/onvif_OSDImgConfigurationExtension' - ImgPath: - description: The URI of the image which to be displayed. - type: string - required: - - ImgPath - type: object - onvif_OSDImgConfigurationExtension: - type: object - onvif_OSDImgOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_OSDImgOptionsExtension' - FormatsSupported: - description: List of supported image MIME types, such as "image/png". - type: string - ImagePath: - description: List of available image URIs. - items: - type: string - type: array - MaxHeight: - description: The maximum height (in pixels) of the image that can be uploaded. - format: int32 - type: integer - MaxSize: - description: The maximum size (in bytes) of the image that can be uploaded. - format: int32 - type: integer - MaxWidth: - description: The maximum width (in pixels) of the image that can be uploaded. - format: int32 - type: integer - required: - - ImagePath - type: object - onvif_OSDImgOptionsExtension: - type: object - onvif_OSDPosConfiguration: - properties: - Extension: - $ref: '#/components/schemas/onvif_OSDPosConfigurationExtension' - Pos: - $ref: '#/components/schemas/onvif_Vector' - Type: - description: 'For OSD position type, following are the pre-defined:' - type: string - required: - - Type - type: object - onvif_OSDPosConfigurationExtension: - type: object - onvif_OSDReference: - type: object - onvif_OSDTextConfiguration: - properties: - BackgroundColor: - allOf: - - $ref: '#/components/schemas/onvif_OSDColor' - - description: Background color of the text. - DateFormat: - 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:' - type: string - Extension: - $ref: '#/components/schemas/onvif_OSDTextConfigurationExtension' - FontColor: - allOf: - - $ref: '#/components/schemas/onvif_OSDColor' - - description: Font color of the text. - FontSize: - description: Font size of the text in pt. - format: int32 - type: integer - IsPersistentText: - 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. - type: boolean - PlainText: - description: The content of text to be displayed. - type: string - TimeFormat: - 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:' - type: string - Type: - description: 'The following OSD Text Type are defined:' - type: string - required: - - Type - type: object - onvif_OSDTextConfigurationExtension: - type: object - onvif_OSDTextOptions: - properties: - BackgroundColor: - allOf: - - $ref: '#/components/schemas/onvif_OSDColorOptions' - - description: List of supported background color. - DateFormat: - description: List of supported date format. - items: - type: string - type: array - Extension: - $ref: '#/components/schemas/onvif_OSDTextOptionsExtension' - FontColor: - allOf: - - $ref: '#/components/schemas/onvif_OSDColorOptions' - - description: List of supported font color. - FontSizeRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of the font size value. - TimeFormat: - description: List of supported time format. - items: - type: string - type: array - Type: - 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. - items: - type: string - type: array - required: - - Type - type: object - onvif_OSDTextOptionsExtension: - type: object - onvif_OSDType: - enum: - - Text - - Image - - Extended - type: string - onvif_Object: - allOf: - - $ref: '#/components/schemas/onvif_ObjectId' - - properties: - Appearance: - $ref: '#/components/schemas/onvif_Appearance' - Behaviour: - $ref: '#/components/schemas/onvif_Behaviour' - Extension: - $ref: '#/components/schemas/onvif_ObjectExtension' - Parent: - description: 'Object ID of the parent object. eg: License plate object - has Vehicle object as parent.' - format: int32 - type: integer - type: object - onvif_ObjectExtension: - type: object - onvif_ObjectId: - properties: - ObjectId: - format: int32 - type: integer - type: object - onvif_ObjectTree: - properties: - Delete: - items: - $ref: '#/components/schemas/onvif_ObjectId' - type: array - Extension: - $ref: '#/components/schemas/onvif_ObjectTreeExtension' - Merge: - items: - $ref: '#/components/schemas/onvif_Merge' - type: array - Rename: - items: - $ref: '#/components/schemas/onvif_Rename' - type: array - Split: - items: - $ref: '#/components/schemas/onvif_Split' - type: array - type: object - onvif_ObjectTreeExtension: - type: object - onvif_ObjectType: - enum: - - Animal - - HumanFace - - Human - - Bicycle - - Vehicle - - LicensePlate - - Bike - type: string - onvif_OnvifVersion: - properties: - Major: - description: Major version number. - format: int32 - type: integer - Minor: - 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." - format: int32 - type: integer - required: - - Major - - Minor - type: object - onvif_OtherType: - properties: - Likelihood: - description: A likelihood/probability that the corresponding object belongs - to this class. The sum of the likelihoods shall NOT exceed 1 - type: number - Type: - description: Object Class Type - type: string - required: - - Type - - Likelihood - type: object - onvif_PTControlDirection: - properties: - EFlip: - allOf: - - $ref: '#/components/schemas/onvif_EFlip' - - description: Optional element to configure related parameters for E-Flip. - Extension: - $ref: '#/components/schemas/onvif_PTControlDirectionExtension' - Reverse: - allOf: - - $ref: '#/components/schemas/onvif_Reverse' - - description: Optional element to configure related parameters for reversing - of PT Control Direction. - type: object - onvif_PTControlDirectionExtension: - type: object - onvif_PTControlDirectionOptions: - properties: - EFlip: - allOf: - - $ref: '#/components/schemas/onvif_EFlipOptions' - - description: Supported options for EFlip feature. - Extension: - $ref: '#/components/schemas/onvif_PTControlDirectionOptionsExtension' - Reverse: - allOf: - - $ref: '#/components/schemas/onvif_ReverseOptions' - - description: Supported options for Reverse feature. - type: object - onvif_PTControlDirectionOptionsExtension: - type: object - onvif_PTZCapabilities: - properties: - XAddr: - description: PTZ service URI. - type: string - required: - - XAddr - type: object - onvif_PTZConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - DefaultAbsolutePantTiltPositionSpace: - description: If the PTZ Node supports absolute Pan/Tilt movements, it - shall specify one Absolute Pan/Tilt Position Space as default. - type: string - DefaultAbsoluteZoomPositionSpace: - description: If the PTZ Node supports absolute zoom movements, it shall - specify one Absolute Zoom Position Space as default. - type: string - DefaultContinuousPanTiltVelocitySpace: - description: If the PTZ Node supports continuous Pan/Tilt movements, it - shall specify one Continuous Pan/Tilt Velocity Space as default. - type: string - DefaultContinuousZoomVelocitySpace: - description: If the PTZ Node supports continuous zoom movements, it shall - specify one Continuous Zoom Velocity Space as default. - type: string - DefaultPTZSpeed: - allOf: - - $ref: '#/components/schemas/onvif_PTZSpeed' - - description: If the PTZ Node supports absolute or relative PTZ movements, - it shall specify corresponding default Pan/Tilt and Zoom speeds. - DefaultPTZTimeout: - description: If the PTZ Node supports continuous movements, it shall specify - a default timeout, after which the movement stops. - format: date-time - type: string - DefaultRelativePanTiltTranslationSpace: - description: If the PTZ Node supports relative Pan/Tilt movements, it - shall specify one RelativePan/Tilt Translation Space as default. - type: string - DefaultRelativeZoomTranslationSpace: - description: If the PTZ Node supports relative zoom movements, it shall - specify one Relative Zoom Translation Space as default. - type: string - Extension: - $ref: '#/components/schemas/onvif_PTZConfigurationExtension' - MoveRamp: - description: The optional acceleration ramp used by the device when moving. - format: int32 - type: integer - NodeToken: - description: A mandatory reference to the PTZ Node that the PTZ Configuration - belongs to. - maxLength: 64 - type: string - PanTiltLimits: - allOf: - - $ref: '#/components/schemas/onvif_PanTiltLimits' - - 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. - PresetRamp: - description: The optional acceleration ramp used by the device when recalling - presets. - format: int32 - type: integer - PresetTourRamp: - description: The optional acceleration ramp used by the device when executing - PresetTours. - format: int32 - type: integer - ZoomLimits: - allOf: - - $ref: '#/components/schemas/onvif_ZoomLimits' - - 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. - required: - - NodeToken - type: object - onvif_PTZConfigurationExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZConfigurationExtension2' - PTControlDirection: - allOf: - - $ref: '#/components/schemas/onvif_PTControlDirection' - - description: Optional element to configure PT Control Direction related - features. - type: object - onvif_PTZConfigurationExtension2: - type: object - onvif_PTZConfigurationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZConfigurationOptions2' - PTControlDirection: - allOf: - - $ref: '#/components/schemas/onvif_PTControlDirectionOptions' - - description: Supported options for PT Direction Control. - PTZRamps: - 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." - format: int32 - type: integer - PTZTimeout: - allOf: - - $ref: '#/components/schemas/onvif_DurationRange' - - description: A timeout Range within which Timeouts are accepted by the - PTZ Node. - Spaces: - allOf: - - $ref: '#/components/schemas/onvif_PTZSpaces' - - description: A list of supported coordinate systems including their range - limitations. - required: - - Spaces - - PTZTimeout - type: object - onvif_PTZConfigurationOptions2: - type: object - onvif_PTZFilter: - properties: - Position: - description: True if the metadata stream shall contain the PTZ position - type: boolean - Status: - description: True if the metadata stream shall contain the PTZ status (IDLE, - MOVING or UNKNOWN) - type: boolean - required: - - Status - - Position - type: object - onvif_PTZMoveStatus: - properties: - PanTilt: - $ref: '#/components/schemas/onvif_MoveStatus' - Zoom: - $ref: '#/components/schemas/onvif_MoveStatus' - type: object - onvif_PTZNode: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - AuxiliaryCommands: - description: A list of supported Auxiliary commands. If the list is not - empty, the Auxiliary Operations MUST be available for this PTZ Node. - items: - maxLength: 128 - type: string - type: array - Extension: - $ref: '#/components/schemas/onvif_PTZNodeExtension' - FixedHomePosition: - description: Indication whether the HomePosition of a Node is fixed or - it can be changed via the SetHomePosition command. - type: boolean - GeoMove: - description: Indication whether the Node supports the geo-referenced move - command. - type: boolean - HomeSupported: - 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. - type: boolean - MaximumNumberOfPresets: - description: All preset operations MUST be available for this PTZ Node - if one preset is supported. - format: int32 - type: integer - Name: - description: A unique identifier that is used to reference PTZ Nodes. - maxLength: 64 - type: string - SupportedPTZSpaces: - allOf: - - $ref: '#/components/schemas/onvif_PTZSpaces' - - description: A list of Coordinate Systems available for the PTZ Node. - For each Coordinate System, the PTZ Node MUST specify its allowed - range. - required: - - SupportedPTZSpaces - - MaximumNumberOfPresets - - HomeSupported - type: object - onvif_PTZNodeExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZNodeExtension2' - SupportedPresetTour: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourSupported' - - description: Detail of supported Preset Tour feature. - type: object - onvif_PTZNodeExtension2: - type: object - onvif_PTZPositionFilter: - properties: - EnterOrExit: - description: If true, search for when entering the specified PTZ volume. - type: boolean - MaxPosition: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - description: The upper boundary of the PTZ volume to look for. - MinPosition: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - description: The lower boundary of the PTZ volume to look for. - required: - - MinPosition - - MaxPosition - - EnterOrExit - type: object - onvif_PTZPreset: - properties: - Name: - description: A list of preset position name. - maxLength: 64 - type: string - PTZPosition: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - description: A list of preset position. - token: - maxLength: 64 - type: string - type: object - onvif_PTZPresetTourDirection: - enum: - - Forward - - Backward - - Extended - type: string - onvif_PTZPresetTourExtension: - type: object - onvif_PTZPresetTourOperation: - enum: - - Start - - Stop - - Pause - - Extended - type: string - onvif_PTZPresetTourOptions: - properties: - AutoStart: - description: Indicates whether or not the AutoStart is supported. - type: boolean - StartingCondition: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourStartingConditionOptions' - - description: Supported options for Preset Tour Starting Condition. - TourSpot: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourSpotOptions' - - description: Supported options for Preset Tour Spot. - required: - - AutoStart - - StartingCondition - - TourSpot - type: object - onvif_PTZPresetTourPresetDetail: - properties: - Home: - 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. - type: boolean - PTZPosition: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - description: Option to specify the preset position with vector of PTZ - node directly. - PresetToken: - description: Option to specify the preset position with Preset Token defined - in advance. - maxLength: 64 - type: string - TypeExtension: - $ref: '#/components/schemas/onvif_PTZPresetTourTypeExtension' - type: object - onvif_PTZPresetTourPresetDetailOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourPresetDetailOptionsExtension' - Home: - description: An option to indicate Home postion for tour spots. - type: boolean - PanTiltPositionSpace: - allOf: - - $ref: '#/components/schemas/onvif_Space2DDescription' - - description: Supported range of Pan and Tilt for tour spots. - PresetToken: - description: A list of available Preset Tokens for tour spots. - items: - maxLength: 64 - type: string - type: array - ZoomPositionSpace: - allOf: - - $ref: '#/components/schemas/onvif_Space1DDescription' - - description: Supported range of Zoom for a tour spot. - type: object - onvif_PTZPresetTourPresetDetailOptionsExtension: - type: object - onvif_PTZPresetTourSpot: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourSpotExtension' - PresetDetail: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourPresetDetail' - - description: Detail definition of preset position of the tour spot. - Speed: - allOf: - - $ref: '#/components/schemas/onvif_PTZSpeed' - - description: Optional parameter to specify Pan/Tilt and Zoom speed on - moving toward this tour spot. - StayTime: - description: Optional parameter to specify time duration of staying on this - tour sport. - format: date-time - type: string - required: - - PresetDetail - type: object - onvif_PTZPresetTourSpotExtension: - type: object - onvif_PTZPresetTourSpotOptions: - properties: - PresetDetail: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourPresetDetailOptions' - - description: Supported options for detail definition of preset position - of the tour spot. - StayTime: - allOf: - - $ref: '#/components/schemas/onvif_DurationRange' - - description: Supported range of stay time for a tour spot. - required: - - PresetDetail - - StayTime - type: object - onvif_PTZPresetTourStartingCondition: - properties: - Direction: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourDirection' - - description: Optional parameter to choose which direction the preset tour - goes. Forward shall be chosen in case it is omitted. - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourStartingConditionExtension' - RandomPresetOrder: - 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. - type: boolean - RecurringDuration: - description: Optional parameter to specify how long time duration the preset - tour is recurred. - format: date-time - type: string - RecurringTime: - description: Optional parameter to specify how many times the preset tour - is recurred. - format: int32 - type: integer - type: object - onvif_PTZPresetTourStartingConditionExtension: - type: object - onvif_PTZPresetTourStartingConditionOptions: - properties: - Direction: - description: Supported options for Direction of Preset Tour. - items: - $ref: '#/components/schemas/onvif_PTZPresetTourDirection' - type: array - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourStartingConditionOptionsExtension' - RecurringDuration: - allOf: - - $ref: '#/components/schemas/onvif_DurationRange' - - description: Supported range of Recurring Duration. - RecurringTime: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported range of Recurring Time. - type: object - onvif_PTZPresetTourStartingConditionOptionsExtension: - type: object - onvif_PTZPresetTourState: - enum: - - Idle - - Touring - - Paused - - Extended - type: string - onvif_PTZPresetTourStatus: - properties: - CurrentTourSpot: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourSpot' - - description: Indicates a tour spot currently staying. - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourStatusExtension' - State: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourState' - - description: Indicates state of this preset tour by Idle/Touring/Paused. - required: - - State - type: object - onvif_PTZPresetTourStatusExtension: - type: object - onvif_PTZPresetTourSupported: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourSupportedExtension' - MaximumNumberOfPresetTours: - 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. - format: int32 - type: integer - PTZPresetTourOperation: - description: Indicates which preset tour operations are available for this - PTZ Node. - items: - $ref: '#/components/schemas/onvif_PTZPresetTourOperation' - type: array - required: - - MaximumNumberOfPresetTours - type: object - onvif_PTZPresetTourSupportedExtension: - type: object - onvif_PTZPresetTourTypeExtension: - type: object - onvif_PTZSpaces: - properties: - AbsolutePanTiltPositionSpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space2DDescription' - type: array - AbsoluteZoomPositionSpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space1DDescription' - type: array - ContinuousPanTiltVelocitySpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space2DDescription' - type: array - ContinuousZoomVelocitySpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space1DDescription' - type: array - Extension: - $ref: '#/components/schemas/onvif_PTZSpacesExtension' - PanTiltSpeedSpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space1DDescription' - type: array - RelativePanTiltTranslationSpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space2DDescription' - type: array - RelativeZoomTranslationSpace: - 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." - items: - $ref: '#/components/schemas/onvif_Space1DDescription' - type: array - ZoomSpeedSpace: - 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\t\ - In contrast to the velocity spaces, speed spaces do not contain any directional\ - \ information." - items: - $ref: '#/components/schemas/onvif_Space1DDescription' - type: array - type: object - onvif_PTZSpacesExtension: - type: object - onvif_PTZSpeed: - properties: - PanTilt: - allOf: - - $ref: '#/components/schemas/onvif_Vector2D' - - 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. - Zoom: - allOf: - - $ref: '#/components/schemas/onvif_Vector1D' - - description: A zoom speed. If omitted in a request, the current (if any) - Zoom movement should not be affected. - type: object - onvif_PTZStatus: - properties: - Error: - description: States a current PTZ error. - type: string - MoveStatus: - allOf: - - $ref: '#/components/schemas/onvif_PTZMoveStatus' - - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, - idle or in an unknown state. - Position: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - 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. - UtcTime: - description: Specifies the UTC time when this status was generated. - format: date-time - type: string - required: - - UtcTime - type: object - onvif_PTZStatusFilterOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_PTZStatusFilterOptionsExtension' - PanTiltPositionSupported: - description: True if the device is able to stream the pan or tilt position. - type: boolean - PanTiltStatusSupported: - description: True if the device is able to stream pan or tilt status information. - type: boolean - ZoomPositionSupported: - description: True if the device is able to stream zoom position information. - type: boolean - ZoomStatusSupported: - description: True if the device is able to stream zoom status inforamtion. - type: boolean - required: - - PanTiltStatusSupported - - ZoomStatusSupported - type: object - onvif_PTZStatusFilterOptionsExtension: - type: object - onvif_PTZStream: - properties: - Extension: - items: - $ref: '#/components/schemas/onvif_PTZStreamExtension' - type: array - PTZStatus: - items: - $ref: '#/components/schemas/onvif_PTZStatus' - type: array - type: object - onvif_PTZStreamChoice0: - properties: - PTZStatus: - items: - $ref: '#/components/schemas/onvif_PTZStatus' - type: array - type: object - onvif_PTZStreamChoice1: - properties: - Extension: - items: - $ref: '#/components/schemas/onvif_PTZStreamExtension' - type: array - type: object - onvif_PTZStreamChoice2: - type: object - onvif_PTZStreamExtension: - type: object - onvif_PTZVector: - properties: - PanTilt: - allOf: - - $ref: '#/components/schemas/onvif_Vector2D' - - description: Pan and tilt position. The x component corresponds to pan - and the y component to tilt. - Zoom: - allOf: - - $ref: '#/components/schemas/onvif_Vector1D' - - description: A zoom position. - type: object - onvif_PanTiltLimits: - properties: - Range: - allOf: - - $ref: '#/components/schemas/onvif_Space2DDescription' - - description: A range of pan tilt limits. - required: - - Range - type: object - onvif_PaneConfiguration: - description: Configuration of the streaming and coding settings of a Video window. - properties: - AudioEncoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' - - description: "The configuration of the audio encoder including codec,\ - \ bitrate\nand sample rate." - AudioOutputToken: - 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." - maxLength: 64 - type: string - AudioSourceToken: - 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." - maxLength: 64 - type: string - PaneName: - description: Optional name of the pane configuration. - type: string - ReceiverToken: - 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." - maxLength: 64 - type: string - Token: - description: A unique identifier in the display device. - maxLength: 64 - type: string - required: - - Token - type: object - onvif_PaneLayout: - description: A pane layout describes one Video window of a display. It links - a pane configuration to a region of the screen. - properties: - Area: - allOf: - - $ref: '#/components/schemas/onvif_Rectangle' - - description: Describes the location and size of the area on the monitor. - The area coordinate values are espressed in normalized units [-1.0, - 1.0]. - Pane: - description: Reference to the configuration of the streaming and coding - parameters. - maxLength: 64 - type: string - required: - - Pane - - Area - type: object - onvif_PaneLayoutOptions: - description: Description of a pane layout describing a complete display layout. - properties: - Area: - description: List of areas assembling a layout. Coordinate values are in - the range [-1.0, 1.0]. - items: - $ref: '#/components/schemas/onvif_Rectangle' - type: array - Extension: - $ref: '#/components/schemas/onvif_PaneOptionExtension' - required: - - Area - type: object - onvif_PaneOptionExtension: - type: object - onvif_PlateType: - enum: - - Normal - - Police - - Diplomat - - Temporary - type: string - onvif_Polygon: - properties: - Point: - items: - $ref: '#/components/schemas/onvif_Vector' - type: array - required: - - Point - type: object - onvif_PolygonOptions: - properties: - RectangleOnly: - description: "True if the device supports defining a region only using Rectangle.\n\ - The rectangle points are still passed using a Polygon element if the device\ - \ does not support polygon regions. In this case, the points provided\ - \ in the Polygon element shall represent a rectangle." - type: boolean - VertexLimits: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: "Provides the minimum and maximum number of points that can\ - \ be defined in the Polygon.\nIf RectangleOnly is not set to true, this\ - \ parameter is required." - type: object - onvif_Polyline: - properties: - Point: - items: - $ref: '#/components/schemas/onvif_Vector' - type: array - required: - - Point - type: object - onvif_PolylineArray: - properties: - Extension: - $ref: '#/components/schemas/onvif_PolylineArrayExtension' - Segment: - description: Contains array of Polyline - items: - $ref: '#/components/schemas/onvif_Polyline' - type: array - required: - - Segment - type: object - onvif_PolylineArrayConfiguration: - properties: - PolylineArray: - allOf: - - $ref: '#/components/schemas/onvif_PolylineArray' - - description: Contains PolylineArray configuration data - required: - - PolylineArray - type: object - onvif_PolylineArrayExtension: - type: object - onvif_PrefixedIPv4Address: - properties: - Address: - description: IPv4 address - type: string - PrefixLength: - description: Prefix/submask length - format: int32 - type: integer - required: - - Address - - PrefixLength - type: object - onvif_PrefixedIPv6Address: - properties: - Address: - description: IPv6 address - type: string - PrefixLength: - description: Prefix/submask length - format: int32 - type: integer - required: - - Address - - PrefixLength - type: object - onvif_PresetTour: - properties: - AutoStart: - description: Auto Start flag of the preset tour. True allows the preset - tour to be activated always. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_PTZPresetTourExtension' - Name: - description: Readable name of the preset tour. - maxLength: 64 - type: string - StartingCondition: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourStartingCondition' - - description: Parameters to specify the detail behavior of the preset tour. - Status: - allOf: - - $ref: '#/components/schemas/onvif_PTZPresetTourStatus' - - description: Read only parameters to indicate the status of the preset - tour. - TourSpot: - description: A list of detail of touring spots including preset positions. - items: - $ref: '#/components/schemas/onvif_PTZPresetTourSpot' - type: array - token: - description: Unique identifier of this preset tour. - maxLength: 64 - type: string - required: - - Status - - AutoStart - - StartingCondition - type: object - onvif_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." - properties: - AudioEncoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' - - description: Optional configuration of the Audio encoder. - AudioSourceConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - - description: Optional configuration of the Audio input. - Extension: - allOf: - - $ref: '#/components/schemas/onvif_ProfileExtension' - - description: Extensions defined in ONVIF 2.0 - MetadataConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_MetadataConfiguration' - - description: Optional configuration of the metadata stream. - Name: - description: User readable name of the profile. - maxLength: 64 - type: string - PTZConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_PTZConfiguration' - - description: Optional configuration of the pan tilt zoom unit. - VideoAnalyticsConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - - description: Optional configuration of the video analytics module and - rule engine. - VideoEncoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' - - description: Optional configuration of the Video encoder. - VideoSourceConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - - description: Optional configuration of the Video input. - fixed: - description: A value of true signals that the profile cannot be deleted. - Default is false. - type: boolean - token: - description: Unique identifier of the profile. - maxLength: 64 - type: string - required: - - token - - Name - type: object - onvif_ProfileCapabilities: - properties: - MaximumNumberOfProfiles: - description: Maximum number of profiles. - format: int32 - type: integer - required: - - MaximumNumberOfProfiles - type: object - onvif_ProfileExtension: - properties: - AudioDecoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - - description: Optional configuration of the Audio decoder. - AudioOutputConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' - - description: Optional configuration of the Audio output. - Extension: - $ref: '#/components/schemas/onvif_ProfileExtension2' - type: object - onvif_ProfileExtension2: - type: object - onvif_ProfileStatus: - properties: - ActiveConnections: - items: - $ref: '#/components/schemas/onvif_ActiveConnection' - type: array - Extension: - $ref: '#/components/schemas/onvif_ProfileStatusExtension' - type: object - onvif_ProfileStatusExtension: - type: object - onvif_PropertyOperation: - enum: - - Initialized - - Deleted - - Changed - type: string - onvif_RealTimeStreamingCapabilities: - properties: - Extension: - $ref: '#/components/schemas/onvif_RealTimeStreamingCapabilitiesExtension' - RTPMulticast: - description: Indicates whether or not RTP multicast is supported. - type: boolean - RTP_RTSP_TCP: - description: Indicates whether or not RTP/RTSP/TCP is supported. - type: boolean - RTP_TCP: - description: Indicates whether or not RTP over TCP is supported. - type: boolean - type: object - onvif_RealTimeStreamingCapabilitiesExtension: - type: object - onvif_Receiver: - description: Description of a receiver, including its token and configuration. - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_ReceiverConfiguration' - - description: Describes the configuration of the receiver. - Token: - description: Unique identifier of the receiver. - maxLength: 64 - type: string - required: - - Token - - Configuration - type: object - onvif_ReceiverCapabilities: - properties: - MaximumRTSPURILength: - description: The maximum allowed length for RTSP URIs. - format: int32 - type: integer - RTP_Multicast: - description: Indicates whether the device can receive RTP multicast streams. - type: boolean - RTP_RTSP_TCP: - description: Indicates whether the device can receive RTP/RTSP/TCP streams. - type: boolean - RTP_TCP: - description: Indicates whether the device can receive RTP/TCP streams - type: boolean - SupportedReceivers: - description: The maximum number of receivers supported by the device. - format: int32 - type: integer - XAddr: - description: The address of the receiver service. - type: string - required: - - XAddr - - RTP_Multicast - - RTP_TCP - - RTP_RTSP_TCP - - SupportedReceivers - - MaximumRTSPURILength - type: object - onvif_ReceiverConfiguration: - description: Describes the configuration of a receiver. - properties: - MediaUri: - description: Details of the URI to which the receiver should connect. - type: string - Mode: - allOf: - - $ref: '#/components/schemas/onvif_ReceiverMode' - - description: 'The following connection modes are defined:' - StreamSetup: - allOf: - - $ref: '#/components/schemas/onvif_StreamSetup' - - description: Stream connection parameters. - required: - - Mode - - MediaUri - - StreamSetup - type: object - onvif_ReceiverMode: - description: Specifies a receiver connection mode. - enum: - - AutoConnect - - AlwaysConnect - - NeverConnect - - Unknown - type: string - onvif_ReceiverState: - description: Specifies the current connection state of the receiver. - enum: - - NotConnected - - Connecting - - Connected - - Unknown - type: string - onvif_ReceiverStateInformation: - description: Contains information about a receiver's current state. - properties: - AutoCreated: - description: Indicates whether or not the receiver was created automatically. - type: boolean - State: - allOf: - - $ref: '#/components/schemas/onvif_ReceiverState' - - description: 'The connection state of the receiver may have one of the - following states:' - required: - - State - - AutoCreated - type: object - onvif_RecordingCapabilities: - properties: - DynamicRecordings: - type: boolean - DynamicTracks: - type: boolean - MaxStringLength: - format: int32 - type: integer - MediaProfileSource: - type: boolean - ReceiverSource: - type: boolean - XAddr: - type: string - required: - - XAddr - - ReceiverSource - - MediaProfileSource - - DynamicRecordings - - DynamicTracks - - MaxStringLength - type: object - onvif_RecordingConfiguration: - properties: - Content: - description: Informative description of the source. - type: string - MaximumRetentionTime: - description: "Sspecifies 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." - format: date-time - type: string - Source: - allOf: - - $ref: '#/components/schemas/onvif_RecordingSourceInformation' - - description: Information about the source of the recording. - required: - - Source - - Content - - MaximumRetentionTime - type: object - onvif_RecordingInformation: - properties: - Content: - type: string - EarliestRecording: - format: date-time - type: string - LatestRecording: - format: date-time - type: string - RecordingStatus: - $ref: '#/components/schemas/onvif_RecordingStatus' - RecordingToken: - maxLength: 64 - type: string - Source: - allOf: - - $ref: '#/components/schemas/onvif_RecordingSourceInformation' - - 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." - Track: - description: Basic information about the track. Note that a track may represent - a single contiguous time span or consist of multiple slices. - items: - $ref: '#/components/schemas/onvif_TrackInformation' - type: array - required: - - RecordingToken - - Source - - Content - - RecordingStatus - type: object - onvif_RecordingJobConfiguration: - properties: - Extension: - $ref: '#/components/schemas/onvif_RecordingJobConfigurationExtension' - Mode: - 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." - type: string - Priority: - 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." - format: int32 - type: integer - RecordingToken: - description: Identifies the recording to which this job shall store the - received data. - maxLength: 64 - type: string - Source: - description: Source of the recording. - items: - $ref: '#/components/schemas/onvif_RecordingJobSource' - type: array - required: - - RecordingToken - - Mode - - Priority - type: object - onvif_RecordingJobConfigurationExtension: - type: object - onvif_RecordingJobSource: - properties: - AutoCreateReceiver: - 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." - type: boolean - Extension: - $ref: '#/components/schemas/onvif_RecordingJobSourceExtension' - SourceToken: - allOf: - - $ref: '#/components/schemas/onvif_SourceReference' - - 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, instructing the\n\t\t\t\tdevice\ - \ to obtain data from a profile that exists on the local device." - Tracks: - description: List of tracks associated with the recording. - items: - $ref: '#/components/schemas/onvif_RecordingJobTrack' - type: array - type: object - onvif_RecordingJobSourceExtension: - type: object - onvif_RecordingJobStateInformation: - properties: - Extension: - $ref: '#/components/schemas/onvif_RecordingJobStateInformationExtension' - RecordingToken: - description: Identification of the recording that the recording job records - to. - maxLength: 64 - type: string - Sources: - description: Identifies the data source of the recording job. - items: - $ref: '#/components/schemas/onvif_RecordingJobStateSource' - type: array - State: - description: Holds the aggregated state over the whole RecordingJobInformation - structure. - type: string - required: - - RecordingToken - - State - type: object - onvif_RecordingJobStateInformationExtension: - type: object - onvif_RecordingJobStateSource: - properties: - SourceToken: - allOf: - - $ref: '#/components/schemas/onvif_SourceReference' - - description: Identifies the data source of the recording job. - State: - description: Holds the aggregated state over all substructures of RecordingJobStateSource. - type: string - Tracks: - allOf: - - $ref: '#/components/schemas/onvif_RecordingJobStateTracks' - - description: List of track items. - required: - - SourceToken - - State - - Tracks - type: object - onvif_RecordingJobStateTrack: - properties: - Destination: - description: Indicates the destination track. - maxLength: 64 - type: string - Error: - description: "Optionally holds an implementation defined string value that\ - \ describes the error.\n\t\t\t\tThe string should be in the English language." - type: string - SourceTag: - description: Identifies the track of the data source that provides the data. - type: string - State: - 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." - type: string - required: - - SourceTag - - Destination - - State - type: object - onvif_RecordingJobStateTracks: - properties: - Track: - items: - $ref: '#/components/schemas/onvif_RecordingJobStateTrack' - type: array - type: object - onvif_RecordingJobTrack: - properties: - Destination: - description: "The destination is the tracktoken of the track to which the\ - \ device shall store the\n\t\t\t\treceived data." - maxLength: 64 - type: string - SourceTag: - 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." - type: string - required: - - SourceTag - - Destination - type: object - onvif_RecordingSourceInformation: - description: A set of informative desciptions of a data source. The Search searvice - allows a client to filter on recordings based on information in this structure. - properties: - Address: - description: URI provided by the service supplying data to be recorded. - A device shall support at least 128 characters. - type: string - Description: - description: Informative description of the source. - type: string - Location: - description: Informative description of the physical location of the source, - e.g. the coordinates on a map. - type: string - Name: - description: Informative user readable name of the source, e.g. "Camera23". - A device shall support at least 20 characters. - maxLength: 64 - type: string - SourceId: - 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." - type: string - required: - - SourceId - - Name - - Location - - Description - - Address - type: object - onvif_RecordingStatus: - enum: - - Initiated - - Recording - - Stopped - - Removing - - Removed - - Unknown - type: string - onvif_RecordingSummary: - properties: - DataFrom: - description: The earliest point in time where there is recorded data on - the device. - format: date-time - type: string - DataUntil: - description: The most recent point in time where there is recorded data - on the device. - format: date-time - type: string - NumberRecordings: - description: The device contains this many recordings. - format: int32 - type: integer - required: - - DataFrom - - DataUntil - - NumberRecordings - type: object - onvif_Rectangle: - properties: - bottom: - type: number - left: - type: number - right: - type: number - top: - type: number - type: object - onvif_RelativeFocus: - properties: - Distance: - description: Distance parameter for the relative focus control. - type: number - Speed: - description: Speed parameter for the relative focus control. - type: number - required: - - Distance - type: object - onvif_RelativeFocusOptions: - properties: - Distance: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the distance. - Speed: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the speed. - required: - - Distance - - Speed - type: object - onvif_RelativeFocusOptions20: - properties: - Distance: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the distance. - Speed: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Valid ranges of the speed. - required: - - Distance - type: object - onvif_RelayIdleState: - enum: - - closed - - open - type: string - onvif_RelayLogicalState: - enum: - - active - - inactive - type: string - onvif_RelayMode: - enum: - - Monostable - - Bistable - type: string - onvif_RelayOutput: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - Properties: - $ref: '#/components/schemas/onvif_RelayOutputSettings' - required: - - Properties - type: object - onvif_RelayOutputSettings: - properties: - DelayTime: - 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. - format: date-time - type: string - IdleState: - allOf: - - $ref: '#/components/schemas/onvif_RelayIdleState' - - description: "'open' or 'closed'" - Mode: - allOf: - - $ref: '#/components/schemas/onvif_RelayMode' - - description: "'Bistable' or 'Monostable'" - required: - - Mode - - DelayTime - - IdleState - type: object - onvif_RemoteUser: - properties: - Password: - type: string - UseDerivedPassword: - type: boolean - Username: - type: string - required: - - Username - - UseDerivedPassword - type: object - onvif_Removed: - type: object - onvif_Rename: - properties: - from: - $ref: '#/components/schemas/onvif_ObjectId' - to: - $ref: '#/components/schemas/onvif_ObjectId' - required: - - from - - to - type: object - onvif_ReplayCapabilities: - properties: - XAddr: - description: The address of the replay service. - type: string - required: - - XAddr - type: object - onvif_ReplayConfiguration: - description: Configuration parameters for the replay service. - properties: - SessionTimeout: - description: The RTSP session timeout. - format: date-time - type: string - required: - - SessionTimeout - type: object - onvif_Reverse: - properties: - Mode: - allOf: - - $ref: '#/components/schemas/onvif_ReverseMode' - - description: Parameter to enable/disable Reverse feature. - required: - - Mode - type: object - onvif_ReverseMode: - enum: - - false - - true - - AUTO - - Extended - type: string - onvif_ReverseOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_ReverseOptionsExtension' - Mode: - description: Options of Reverse mode parameter. - items: - $ref: '#/components/schemas/onvif_ReverseMode' - type: array - type: object - onvif_ReverseOptionsExtension: - type: object - onvif_Rotate: - properties: - Degree: - 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. - format: int32 - type: integer - Extension: - $ref: '#/components/schemas/onvif_RotateExtension' - Mode: - allOf: - - $ref: '#/components/schemas/onvif_RotateMode' - - description: Parameter to enable/disable Rotation feature. - required: - - Mode - type: object - onvif_RotateExtension: - type: object - onvif_RotateMode: - enum: - - false - - true - - AUTO - type: string - onvif_RotateOptions: - properties: - DegreeList: - allOf: - - $ref: '#/components/schemas/onvif_IntItems' - - description: List of supported degree value for rotation. - Extension: - $ref: '#/components/schemas/onvif_RotateOptionsExtension' - Mode: - description: Supported options of Rotate mode parameter. - items: - $ref: '#/components/schemas/onvif_RotateMode' - type: array - Reboot: - description: "After setting the rotation, if a device starts to reboot this\ - \ value is true.\n\t\t\t\tIf a device can handle rotation setting without\ - \ rebooting this value is false." - type: boolean - required: - - Mode - type: object - onvif_RotateOptionsExtension: - type: object - onvif_RuleEngineConfiguration: - properties: - Extension: - $ref: '#/components/schemas/onvif_RuleEngineConfigurationExtension' - Rule: - items: - $ref: '#/components/schemas/onvif_Config' - type: array - type: object - onvif_RuleEngineConfigurationExtension: - type: object - onvif_SceneOrientation: - properties: - Mode: - allOf: - - $ref: '#/components/schemas/onvif_SceneOrientationMode' - - description: Parameter to assign the way the camera determines the scene - orientation. - Orientation: - 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." - type: string - required: - - Mode - type: object - onvif_SceneOrientationMode: - enum: - - MANUAL - - AUTO - type: string - onvif_SceneOrientationOption: - description: Defines the acceptable values for the Orientation element of the - SceneOrientation type - enum: - - Below - - Horizon - - Above - type: string - onvif_Scope: - properties: - ScopeDef: - allOf: - - $ref: '#/components/schemas/onvif_ScopeDefinition' - - description: Indicates if the scope is fixed or configurable. - ScopeItem: - description: Scope item URI. - type: string - required: - - ScopeDef - - ScopeItem - type: object - onvif_ScopeDefinition: - enum: - - Fixed - - Configurable - type: string - onvif_SearchCapabilities: - properties: - MetadataSearch: - type: boolean - XAddr: - type: string - required: - - XAddr - - MetadataSearch - type: object - onvif_SearchScope: - description: A structure for defining a limited scope when searching in recorded - data. - properties: - Extension: - allOf: - - $ref: '#/components/schemas/onvif_SearchScopeExtension' - - description: Extension point - IncludedRecordings: - 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. - items: - maxLength: 64 - type: string - type: array - IncludedSources: - 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. - items: - $ref: '#/components/schemas/onvif_SourceReference' - type: array - RecordingInformationFilter: - 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. - type: string - type: object - onvif_SearchScopeExtension: - type: object - onvif_SearchState: - enum: - - Queued - - Searching - - Completed - - Unknown - type: string - onvif_SecurityCapabilities: - properties: - AccessPolicyConfig: - description: Indicates whether or not access policy configuration is supported. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_SecurityCapabilitiesExtension' - KerberosToken: - description: Indicates whether or not WS-Security Kerberos token is supported. - type: boolean - OnboardKeyGeneration: - description: Indicates whether or not onboard key generation is supported. - type: boolean - RELToken: - description: Indicates whether or not WS-Security REL token is supported. - type: boolean - SAMLToken: - description: Indicates whether or not WS-Security SAML token is supported. - type: boolean - TLS1.1: - description: Indicates whether or not TLS 1.1 is supported. - type: boolean - TLS1.2: - description: Indicates whether or not TLS 1.2 is supported. - type: boolean - X.509Token: - description: Indicates whether or not WS-Security X.509 token is supported. - type: boolean - required: - - TLS1.1 - - TLS1.2 - - OnboardKeyGeneration - - AccessPolicyConfig - - X.509Token - - SAMLToken - - KerberosToken - - RELToken - type: object - onvif_SecurityCapabilitiesExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_SecurityCapabilitiesExtension2' - TLS1.0: - type: boolean - required: - - TLS1.0 - type: object - onvif_SecurityCapabilitiesExtension2: - properties: - Dot1X: - type: boolean - RemoteUserHandling: - type: boolean - SupportedEAPMethod: - description: EAP Methods supported by the device. The int values refer to - the - items: - format: int32 - type: integer - type: array - required: - - Dot1X - - RemoteUserHandling - type: object - onvif_SetDateTimeType: - enum: - - Manual - - NTP - type: string - onvif_ShapeDescriptor: - properties: - BoundingBox: - $ref: '#/components/schemas/onvif_Rectangle' - CenterOfGravity: - $ref: '#/components/schemas/onvif_Vector' - Extension: - $ref: '#/components/schemas/onvif_ShapeDescriptorExtension' - Polygon: - items: - $ref: '#/components/schemas/onvif_Polygon' - type: array - required: - - BoundingBox - - CenterOfGravity - type: object - onvif_ShapeDescriptorExtension: - type: object - onvif_SimpleItem: - description: Value name pair as defined by the corresponding description. - properties: - Name: - description: Item name. - type: string - Value: - description: Item value. The type is defined in the corresponding description. - type: string - required: - - Name - - Value - type: object - onvif_SimpleItemDescription: - description: Description of a simple item. The type must be of cathegory simpleType - (xs:string, xs:integer, xs:float, ...). - properties: - Name: - description: Item name. Must be unique within a list. - type: string - Type: - type: string - required: - - Name - - Type - type: object - onvif_SourceIdentification: - properties: - Extension: - $ref: '#/components/schemas/onvif_SourceIdentificationExtension' - Name: - type: string - Token: - items: - maxLength: 64 - type: string - type: array - required: - - Name - - Token - type: object - onvif_SourceIdentificationExtension: - type: object - onvif_SourceReference: - properties: - Token: - maxLength: 64 - type: string - Type: - default: http://www.onvif.org/ver10/schema/Receiver - type: string - required: - - Token - type: object - onvif_Space1DDescription: - properties: - URI: - description: A URI of coordinate systems. - type: string - XRange: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: A range of x-axis. - required: - - URI - - XRange - type: object - onvif_Space2DDescription: - properties: - URI: - description: A URI of coordinate systems. - type: string - XRange: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: A range of x-axis. - YRange: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: A range of y-axis. - required: - - URI - - XRange - - YRange - type: object - onvif_Split: - properties: - from: - $ref: '#/components/schemas/onvif_ObjectId' - to: - items: - $ref: '#/components/schemas/onvif_ObjectId' - type: array - required: - - from - - to - type: object - onvif_StorageReferencePath: - properties: - Extension: - $ref: '#/components/schemas/onvif_StorageReferencePathExtension' - RelativePath: - description: gives the relative directory path on the storage - type: string - StorageToken: - description: identifier of an existing Storage Configuration. - maxLength: 64 - type: string - required: - - StorageToken - type: object - onvif_StorageReferencePathExtension: - type: object - onvif_StreamSetup: - properties: - Stream: - allOf: - - $ref: '#/components/schemas/onvif_StreamType' - - description: Defines if a multicast or unicast stream is requested - Transport: - $ref: '#/components/schemas/onvif_Transport' - required: - - Stream - - Transport - type: object - onvif_StreamType: - enum: - - RTP-Unicast - - RTP-Multicast - type: string - onvif_StringItems: - properties: - Item: - items: - type: string - type: array - required: - - Item - type: object - onvif_StringLikelihood: - properties: - Likelihood: - type: number - type: object - onvif_SubscriptionPolicy: - type: object - onvif_SupportInformation: - properties: - Binary: - allOf: - - $ref: '#/components/schemas/onvif_AttachmentData' - - description: The support information as attachment data. - String: - description: The support information as character data. - type: string - type: object - onvif_SupportedAnalyticsModules: - properties: - AnalyticsModuleContentSchemaLocation: - 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." - items: - type: string - type: array - AnalyticsModuleDescription: - items: - $ref: '#/components/schemas/onvif_ConfigDescription' - type: array - Extension: - $ref: '#/components/schemas/onvif_SupportedAnalyticsModulesExtension' - Limit: - description: Maximum number of concurrent instances. - format: int32 - type: integer - type: object - onvif_SupportedAnalyticsModulesExtension: - type: object - onvif_SupportedRules: - properties: - Extension: - $ref: '#/components/schemas/onvif_SupportedRulesExtension' - Limit: - description: Maximum number of concurrent instances. - format: int32 - type: integer - RuleContentSchemaLocation: - description: Lists the location of all schemas that are referenced in the - rules. - items: - type: string - type: array - RuleDescription: - description: List of rules supported by the Video Analytics configuration.. - items: - $ref: '#/components/schemas/onvif_ConfigDescription' - type: array - type: object - onvif_SupportedRulesExtension: - type: object - onvif_SystemCapabilities: - properties: - DiscoveryBye: - description: Indicates whether or not WS-Discovery Bye is supported. - type: boolean - DiscoveryResolve: - description: Indicates whether or not WS Discovery resolve requests are - supported. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_SystemCapabilitiesExtension' - FirmwareUpgrade: - description: Indicates whether or not firmware upgrade is supported. - type: boolean - RemoteDiscovery: - description: Indicates whether or not remote discovery is supported. - type: boolean - SupportedVersions: - description: Indicates supported ONVIF version(s). - items: - $ref: '#/components/schemas/onvif_OnvifVersion' - type: array - SystemBackup: - description: Indicates whether or not system backup is supported. - type: boolean - SystemLogging: - description: Indicates whether or not system logging is supported. - type: boolean - required: - - DiscoveryResolve - - DiscoveryBye - - RemoteDiscovery - - SystemBackup - - SystemLogging - - FirmwareUpgrade - - SupportedVersions - type: object - onvif_SystemCapabilitiesExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_SystemCapabilitiesExtension2' - HttpFirmwareUpgrade: - type: boolean - HttpSupportInformation: - type: boolean - HttpSystemBackup: - type: boolean - HttpSystemLogging: - type: boolean - type: object - onvif_SystemCapabilitiesExtension2: - type: object - onvif_SystemDateTime: - description: General date time inforamtion returned by the GetSystemDateTime - method. - properties: - DateTimeType: - allOf: - - $ref: '#/components/schemas/onvif_SetDateTimeType' - - description: Indicates if the time is set manully or through NTP. - DaylightSavings: - description: Informative indicator whether daylight savings is currently - on/off. - type: boolean - Extension: - $ref: '#/components/schemas/onvif_SystemDateTimeExtension' - LocalDateTime: - allOf: - - $ref: '#/components/schemas/onvif_DateTime' - - description: Date and time in local format. - TimeZone: - allOf: - - $ref: '#/components/schemas/onvif_TimeZone' - - description: Timezone information in Posix format. - UTCDateTime: - allOf: - - $ref: '#/components/schemas/onvif_DateTime' - - description: Current system date and time in UTC format. This field is - mandatory since version 2.0. - required: - - DateTimeType - - DaylightSavings - type: object - onvif_SystemDateTimeExtension: - type: object - onvif_SystemLog: - properties: - Binary: - allOf: - - $ref: '#/components/schemas/onvif_AttachmentData' - - description: The log information as attachment data. - String: - description: The log information as character data. - type: string - type: object - onvif_SystemLogType: - description: Enumeration describing the available system log modes. - enum: - - System - - Access - type: string - onvif_SystemLogUri: - properties: - Type: - $ref: '#/components/schemas/onvif_SystemLogType' - Uri: - type: string - required: - - Type - - Uri - type: object - onvif_SystemLogUriList: - properties: - SystemLog: - items: - $ref: '#/components/schemas/onvif_SystemLogUri' - type: array - type: object - onvif_TLSConfiguration: - properties: - CertificateID: - type: string - required: - - CertificateID - type: object - onvif_Time: - properties: - Hour: - description: Range is 0 to 23. - format: int32 - type: integer - Minute: - description: Range is 0 to 59. - format: int32 - type: integer - Second: - description: Range is 0 to 61 (typically 59). - format: int32 - type: integer - required: - - Hour - - Minute - - Second - type: object - onvif_TimeZone: - description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 - section 8.3 - properties: - TZ: - description: Posix timezone string. - type: string - required: - - TZ - type: object - onvif_ToneCompensation: - properties: - Extension: - $ref: '#/components/schemas/onvif_ToneCompensationExtension' - Level: - description: Optional level parameter specified with unitless normalized - value from 0.0 to +1.0. - type: number - Mode: - description: Parameter to enable/disable or automatic ToneCompensation feature. - Its options shall be chosen from tt:ToneCompensationMode Type. - type: string - required: - - Mode - type: object - onvif_ToneCompensationExtension: - type: object - onvif_ToneCompensationMode: - enum: - - false - - true - - AUTO - type: string - onvif_ToneCompensationOptions: - properties: - Level: - description: Indicates whether or not support Level parameter for Tone Compensation. - type: boolean - Mode: - description: Supported options for Tone Compensation mode. Its options shall - be chosen from tt:ToneCompensationMode Type. - items: - type: string - type: array - required: - - Mode - - Level - type: object - onvif_TrackAttributes: - properties: - AudioAttributes: - allOf: - - $ref: '#/components/schemas/onvif_AudioAttributes' - - description: If the track is an audio track, exactly one of this structure - shall be present and contain the audio attributes. - Extension: - $ref: '#/components/schemas/onvif_TrackAttributesExtension' - MetadataAttributes: - allOf: - - $ref: '#/components/schemas/onvif_MetadataAttributes' - - description: If the track is an metadata track, exactly one of this structure - shall be present and contain the metadata attributes. - TrackInformation: - allOf: - - $ref: '#/components/schemas/onvif_TrackInformation' - - description: The basic information about the track. Note that a track - may represent a single contiguous time span or consist of multiple slices. - VideoAttributes: - allOf: - - $ref: '#/components/schemas/onvif_VideoAttributes' - - description: If the track is a video track, exactly one of this structure - shall be present and contain the video attributes. - required: - - TrackInformation - type: object - onvif_TrackAttributesExtension: - type: object - onvif_TrackConfiguration: - properties: - Description: - description: Informative description of the track. - type: string - TrackType: - allOf: - - $ref: '#/components/schemas/onvif_TrackType' - - 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." - required: - - TrackType - - Description - type: object - onvif_TrackInformation: - properties: - DataFrom: - description: The start date and time of the oldest recorded data in the - track. - format: date-time - type: string - DataTo: - description: The stop date and time of the newest recorded data in the track. - format: date-time - type: string - Description: - description: Informative description of the contents of the track. - type: string - TrackToken: - maxLength: 64 - type: string - TrackType: - allOf: - - $ref: '#/components/schemas/onvif_TrackType' - - 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." - required: - - TrackToken - - TrackType - - Description - - DataFrom - - DataTo - type: object - onvif_TrackType: - enum: - - Video - - Audio - - Metadata - - Extended - type: string - onvif_Transformation: - properties: - Extension: - $ref: '#/components/schemas/onvif_TransformationExtension' - Scale: - $ref: '#/components/schemas/onvif_Vector' - Translate: - $ref: '#/components/schemas/onvif_Vector' - type: object - onvif_TransformationExtension: - type: object - onvif_Transport: - properties: - Protocol: - allOf: - - $ref: '#/components/schemas/onvif_TransportProtocol' - - description: Defines the network protocol for streaming, either UDP=RTP/UDP, - RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP - Tunnel: - allOf: - - $ref: '#/components/schemas/onvif_Transport' - - description: Optional element to describe further tunnel options. This - element is normally not needed - required: - - Protocol - type: object - onvif_TransportProtocol: - enum: - - UDP - - TCP - - RTSP - - HTTP - type: string - onvif_User: - properties: - Extension: - $ref: '#/components/schemas/onvif_UserExtension' - Password: - description: Password string. - type: string - UserLevel: - allOf: - - $ref: '#/components/schemas/onvif_UserLevel' - - description: User level string. - Username: - description: Username string. - type: string - required: - - Username - - UserLevel - type: object - onvif_UserExtension: - type: object - onvif_UserLevel: - enum: - - Administrator - - Operator - - User - - Anonymous - - Extended - type: string - onvif_Vector: - properties: - x: - type: number - y: - type: number - type: object - onvif_Vector1D: - properties: - space: - description: 'Zoom coordinate space selector. The following options are - defined:' - type: string - x: - type: number - required: - - x - type: object - onvif_Vector2D: - properties: - space: - description: 'Pan/tilt coordinate space selector. The following options - are defined:' - type: string - x: - type: number - y: - type: number - required: - - x - - y - type: object - onvif_VehicleInfo: - properties: - Brand: - $ref: '#/components/schemas/onvif_StringLikelihood' - Model: - $ref: '#/components/schemas/onvif_StringLikelihood' - Type: - $ref: '#/components/schemas/onvif_StringLikelihood' - required: - - Type - type: object - onvif_VehicleType: - enum: - - Bus - - Car - - Truck - - Bicycle - - Motorcycle - type: string - onvif_VideoAnalyticsConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - AnalyticsEngineConfiguration: - $ref: '#/components/schemas/onvif_AnalyticsEngineConfiguration' - RuleEngineConfiguration: - $ref: '#/components/schemas/onvif_RuleEngineConfiguration' - required: - - AnalyticsEngineConfiguration - - RuleEngineConfiguration - type: object - onvif_VideoAnalyticsStream: - properties: - Extension: - items: - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamExtension' - type: array - Frame: - items: - $ref: '#/components/schemas/onvif_Frame' - type: array - type: object - onvif_VideoAnalyticsStreamChoice0: - properties: - Frame: - items: - $ref: '#/components/schemas/onvif_Frame' - type: array - type: object - onvif_VideoAnalyticsStreamChoice1: - properties: - Extension: - items: - $ref: '#/components/schemas/onvif_VideoAnalyticsStreamExtension' - type: array - type: object - onvif_VideoAnalyticsStreamChoice2: - type: object - onvif_VideoAnalyticsStreamExtension: - type: object - onvif_VideoAttributes: - properties: - Bitrate: - description: Average bitrate in kbps. - format: int32 - type: integer - Encoding: - description: Video encoding of the track. Use value from tt:VideoEncoding - for MPEG4. Otherwise use values from tt:VideoEncodingMimeNames and - type: string - Framerate: - description: Average framerate in frames per second. - type: number - Height: - description: The height of the video in pixels. - format: int32 - type: integer - Width: - description: The width of the video in pixels. - format: int32 - type: integer - required: - - Width - - Height - - Encoding - - Framerate - type: object - onvif_VideoDecoderConfigurationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoDecoderConfigurationOptionsExtension' - H264DecOptions: - allOf: - - $ref: '#/components/schemas/onvif_H264DecOptions' - - description: If the device is able to decode H.264 streams this element - describes the supported codecs and configurations - JpegDecOptions: - allOf: - - $ref: '#/components/schemas/onvif_JpegDecOptions' - - description: If the device is able to decode Jpeg streams this element - describes the supported codecs and configurations - Mpeg4DecOptions: - allOf: - - $ref: '#/components/schemas/onvif_Mpeg4DecOptions' - - description: If the device is able to decode Mpeg4 streams this element - describes the supported codecs and configurations - type: object - onvif_VideoDecoderConfigurationOptionsExtension: - type: object - onvif_VideoEncoder2Configuration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - Encoding: - description: Video Media Subtype for the video format. For definitions - see tt:VideoEncodingMimeNames and - type: string - GovLength: - 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. - format: int32 - type: integer - GuaranteedFrameRate: - 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." - type: boolean - Multicast: - allOf: - - $ref: '#/components/schemas/onvif_MulticastConfiguration' - - description: Defines the multicast settings that could be used for video - streaming. - Profile: - description: The encoder profile as defined in tt:VideoEncodingProfiles. - type: string - Quality: - description: Relative value for the video quantizers and the quality of - the video. A high value within supported quality range means higher - quality - type: number - RateControl: - allOf: - - $ref: '#/components/schemas/onvif_VideoRateControl2' - - description: Optional element to configure rate control related parameters. - Resolution: - allOf: - - $ref: '#/components/schemas/onvif_VideoResolution2' - - description: Configured video resolution - required: - - Encoding - - Resolution - - Quality - type: object - onvif_VideoEncoder2ConfigurationOptions: - properties: - BitrateRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Supported range of encoded bitrate in kbps. - ConstantBitRateSupported: - description: Signal whether enforcing constant bitrate is supported. - type: boolean - Encoding: - description: Video Media Subtype for the video format. For definitions see - tt:VideoEncodingMimeNames and - type: string - FrameRatesSupported: - description: List of supported target frame rates in fps (frames per second). - The list shall be sorted with highest values first. - type: number - GovLengthRange: - 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. - format: int32 - type: integer - GuaranteedFrameRateSupported: - description: Indicates the support for the GuaranteedFrameRate attribute - on the VideoEncoder2Configuration element. - type: boolean - ProfilesSupported: - description: List of supported encoder profiles as defined in tt::VideoEncodingProfiles. - type: string - QualityRange: - allOf: - - $ref: '#/components/schemas/onvif_FloatRange' - - description: Range of the quality values. A high value means higher quality. - ResolutionsAvailable: - description: List of supported image sizes. - items: - $ref: '#/components/schemas/onvif_VideoResolution2' - type: array - required: - - Encoding - - QualityRange - - ResolutionsAvailable - - BitrateRange - type: object - onvif_VideoEncoderConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - Encoding: - allOf: - - $ref: '#/components/schemas/onvif_VideoEncoding' - - description: Used video codec, either Jpeg, H.264 or Mpeg4 - GuaranteedFrameRate: - 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." - type: boolean - H264: - allOf: - - $ref: '#/components/schemas/onvif_H264Configuration' - - description: Optional element to configure H.264 related parameters. - MPEG4: - allOf: - - $ref: '#/components/schemas/onvif_Mpeg4Configuration' - - description: Optional element to configure Mpeg4 related parameters. - Multicast: - allOf: - - $ref: '#/components/schemas/onvif_MulticastConfiguration' - - description: Defines the multicast settings that could be used for video - streaming. - Quality: - description: Relative value for the video quantizers and the quality of - the video. A high value within supported quality range means higher - quality - type: number - RateControl: - allOf: - - $ref: '#/components/schemas/onvif_VideoRateControl' - - description: Optional element to configure rate control related parameters. - Resolution: - allOf: - - $ref: '#/components/schemas/onvif_VideoResolution' - - description: Configured video resolution - SessionTimeout: - description: The rtsp session timeout for the related video stream - format: date-time - type: string - required: - - Encoding - - Resolution - - Quality - - Multicast - - SessionTimeout - type: object - onvif_VideoEncoderConfigurationOptions: - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoEncoderOptionsExtension' - GuaranteedFrameRateSupported: - description: Indicates the support for the GuaranteedFrameRate attribute - on the VideoEncoderConfiguration element. - type: boolean - H264: - allOf: - - $ref: '#/components/schemas/onvif_H264Options' - - description: Optional H.264 encoder settings ranges (See also Extension - element). - JPEG: - allOf: - - $ref: '#/components/schemas/onvif_JpegOptions' - - description: Optional JPEG encoder settings ranges (See also Extension - element). - MPEG4: - allOf: - - $ref: '#/components/schemas/onvif_Mpeg4Options' - - description: Optional MPEG-4 encoder settings ranges (See also Extension - element). - QualityRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRange' - - description: Range of the quality values. A high value means higher quality. - required: - - QualityRange - type: object - onvif_VideoEncoderOptionsExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoEncoderOptionsExtension2' - H264: - allOf: - - $ref: '#/components/schemas/onvif_H264Options2' - - description: Optional H.264 encoder settings ranges. - JPEG: - allOf: - - $ref: '#/components/schemas/onvif_JpegOptions2' - - description: Optional JPEG encoder settings ranges. - MPEG4: - allOf: - - $ref: '#/components/schemas/onvif_Mpeg4Options2' - - description: Optional MPEG-4 encoder settings ranges. - type: object - onvif_VideoEncoderOptionsExtension2: - type: object - onvif_VideoEncoding: - enum: - - JPEG - - MPEG4 - - H264 - type: string - onvif_VideoEncodingMimeNames: - description: Video Media Subtypes as referenced by IANA (without the leading - "video/" Video Media Type). See also - enum: - - JPEG - - MPV4-ES - - H264 - - H265 - type: string - onvif_VideoEncodingProfiles: - enum: - - Simple - - AdvancedSimple - - Baseline - - Main - - Main10 - - Extended - - High - type: string - onvif_VideoOutput: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - AspectRatio: - description: Aspect ratio of the display as physical extent of width divided - by height. - type: number - Extension: - $ref: '#/components/schemas/onvif_VideoOutputExtension' - Layout: - $ref: '#/components/schemas/onvif_Layout' - RefreshRate: - description: Refresh rate of the display in Hertz. - type: number - Resolution: - allOf: - - $ref: '#/components/schemas/onvif_VideoResolution' - - description: Resolution of the display in Pixel. - required: - - Layout - type: object - description: Representation of a physical video outputs. - onvif_VideoOutputConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - OutputToken: - description: Token of the Video Output the configuration applies to - maxLength: 64 - type: string - required: - - OutputToken - type: object - onvif_VideoOutputConfigurationOptions: - type: object - onvif_VideoOutputExtension: - type: object - onvif_VideoRateControl: - properties: - BitrateLimit: - description: the maximum output bitrate in kbps - format: int32 - type: integer - EncodingInterval: - 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 ...) - format: int32 - type: integer - FrameRateLimit: - description: Maximum output framerate in fps. If an EncodingInterval is - provided the resulting encoded framerate will be reduced by the given - factor. - format: int32 - type: integer - required: - - FrameRateLimit - - EncodingInterval - - BitrateLimit - type: object - onvif_VideoRateControl2: - properties: - BitrateLimit: - description: the maximum output bitrate in kbps - format: int32 - type: integer - ConstantBitRate: - description: Enforce constant bitrate. - type: boolean - FrameRateLimit: - description: Desired frame rate in fps. The actual rate may be lower due - to e.g. performance limitations. - type: number - required: - - FrameRateLimit - - BitrateLimit - type: object - onvif_VideoResolution: - properties: - Height: - description: Number of the lines of the Video image. - format: int32 - type: integer - Width: - description: Number of the columns of the Video image. - format: int32 - type: integer - required: - - Width - - Height - type: object - onvif_VideoResolution2: - properties: - Height: - description: Number of the lines of the Video image. - format: int32 - type: integer - Width: - description: Number of the columns of the Video image. - format: int32 - type: integer - required: - - Width - - Height - type: object - onvif_VideoSource: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoSourceExtension' - Framerate: - description: Frame rate in frames per second. - type: number - Imaging: - allOf: - - $ref: '#/components/schemas/onvif_ImagingSettings' - - description: Optional configuration of the image sensor. - Resolution: - allOf: - - $ref: '#/components/schemas/onvif_VideoResolution' - - description: Horizontal and vertical resolution - required: - - Framerate - - Resolution - type: object - description: Representation of a physical video input. - onvif_VideoSourceConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ConfigurationEntity' - - properties: - Bounds: - allOf: - - $ref: '#/components/schemas/onvif_IntRectangle' - - description: Rectangle specifying the Video capturing area. The capturing - area shall not be larger than the whole Video source area. - Extension: - $ref: '#/components/schemas/onvif_VideoSourceConfigurationExtension' - SourceToken: - description: Reference to the physical input. - maxLength: 64 - type: string - ViewMode: - description: Readonly parameter signalling Source configuration's view - mode, for devices supporting different view modes as defined in tt:viewModes. - type: string - required: - - SourceToken - - Bounds - type: object - onvif_VideoSourceConfigurationExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoSourceConfigurationExtension2' - Rotate: - allOf: - - $ref: '#/components/schemas/onvif_Rotate' - - 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." - type: object - onvif_VideoSourceConfigurationExtension2: - properties: - LensDescription: - description: Optional element describing the geometric lens distortion. - Multiple instances for future variable lens support. - items: - $ref: '#/components/schemas/onvif_LensDescription' - type: array - SceneOrientation: - allOf: - - $ref: '#/components/schemas/onvif_SceneOrientation' - - description: Optional element describing the scene orientation in the - camera’s field of view. - type: object - onvif_VideoSourceConfigurationOptions: - properties: - BoundsRange: - allOf: - - $ref: '#/components/schemas/onvif_IntRectangleRange' - - 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." - Extension: - $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptionsExtension' - MaximumNumberOfProfiles: - description: Maximum number of profiles. - format: int32 - type: integer - VideoSourceTokensAvailable: - description: List of physical inputs. - items: - maxLength: 64 - type: string - type: array - required: - - BoundsRange - - VideoSourceTokensAvailable - type: object - onvif_VideoSourceConfigurationOptionsExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptionsExtension2' - Rotate: - allOf: - - $ref: '#/components/schemas/onvif_RotateOptions' - - description: Options of parameters for Rotation feature. - type: object - onvif_VideoSourceConfigurationOptionsExtension2: - properties: - SceneOrientationMode: - description: Scene orientation modes supported by the device for this configuration. - items: - $ref: '#/components/schemas/onvif_SceneOrientationMode' - type: array - type: object - onvif_VideoSourceExtension: - properties: - Extension: - $ref: '#/components/schemas/onvif_VideoSourceExtension2' - Imaging: - allOf: - - $ref: '#/components/schemas/onvif_ImagingSettings20' - - description: Optional configuration of the image sensor. To be used if - imaging service 2.00 is supported. - type: object - onvif_VideoSourceExtension2: - type: object - onvif_ViewModes: - description: Source view modes supported by device. - enum: - - tt:Fisheye - - tt:360Panorama - - tt:180Panorama - - tt:Quad - - tt:Original - - tt:LeftHalf - - tt:RightHalf - - tt:Dewarp - type: string - onvif_WhiteBalance: - properties: - CbGain: - description: Bgain (unitless). - type: number - CrGain: - description: Rgain (unitless). - type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_WhiteBalanceMode' - - description: Auto whitebalancing mode (auto/manual). - required: - - Mode - - CrGain - - CbGain - type: object - onvif_WhiteBalance20: - properties: - CbGain: - description: Bgain (unitless). - type: number - CrGain: - description: Rgain (unitless). - type: number - Extension: - $ref: '#/components/schemas/onvif_WhiteBalance20Extension' - Mode: - allOf: - - $ref: '#/components/schemas/onvif_WhiteBalanceMode' - - description: "'AUTO' or 'MANUAL'" - required: - - Mode - type: object - onvif_WhiteBalance20Extension: - type: object - onvif_WhiteBalanceMode: - enum: - - AUTO - - MANUAL - type: string - onvif_WhiteBalanceOptions: - properties: - Mode: - items: - $ref: '#/components/schemas/onvif_WhiteBalanceMode' - type: array - YbGain: - $ref: '#/components/schemas/onvif_FloatRange' - YrGain: - $ref: '#/components/schemas/onvif_FloatRange' - required: - - Mode - - YrGain - - YbGain - type: object - onvif_WhiteBalanceOptions20: - properties: - Extension: - $ref: '#/components/schemas/onvif_WhiteBalanceOptions20Extension' - Mode: - description: Mode of WhiteBalance. - items: - $ref: '#/components/schemas/onvif_WhiteBalanceMode' - type: array - YbGain: - $ref: '#/components/schemas/onvif_FloatRange' - YrGain: - $ref: '#/components/schemas/onvif_FloatRange' - required: - - Mode - type: object - onvif_WhiteBalanceOptions20Extension: - type: object - onvif_WideDynamicMode: - enum: - - false - - true - type: string - onvif_WideDynamicRange: - properties: - Level: - description: Optional level parameter (unitless) - type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_WideDynamicMode' - - description: White dynamic range (on/off) - required: - - Mode - - Level - type: object - onvif_WideDynamicRange20: - description: Type describing whether WDR mode is enabled or disabled (on/off). - properties: - Level: - description: Optional level parameter (unit unspecified). - type: number - Mode: - allOf: - - $ref: '#/components/schemas/onvif_WideDynamicMode' - - description: Wide dynamic range mode (on/off). - required: - - Mode - type: object - onvif_WideDynamicRangeOptions: - properties: - Level: - $ref: '#/components/schemas/onvif_FloatRange' - Mode: - items: - $ref: '#/components/schemas/onvif_WideDynamicMode' - type: array - required: - - Mode - - Level - type: object - onvif_WideDynamicRangeOptions20: - properties: - Level: - $ref: '#/components/schemas/onvif_FloatRange' - Mode: - items: - $ref: '#/components/schemas/onvif_WideDynamicMode' - type: array - required: - - Mode - type: object - onvif_ZoomLimits: - properties: - Range: - allOf: - - $ref: '#/components/schemas/onvif_Space1DDescription' - - description: A range of zoom limit - required: - - Range - type: object - soapenv_Body: - type: object - soapenv_Envelope: - properties: - Body: - $ref: '#/components/schemas/soapenv_Body' - Header: - $ref: '#/components/schemas/soapenv_Header' - required: - - Body - type: object - soapenv_Fault: - description: Fault reporting structure - properties: - Code: - $ref: '#/components/schemas/soapenv_faultcode' - Detail: - $ref: '#/components/schemas/soapenv_detail' - Node: - type: string - Reason: - $ref: '#/components/schemas/soapenv_faultreason' - Role: - type: string - required: - - Code - - Reason - type: object - soapenv_Header: - description: Elements replacing the wildcard MUST be namespace qualified, but - can be in the targetNamespace - type: object - soapenv_NotUnderstoodType: - properties: - qname: - type: string - required: - - qname - type: object - soapenv_SupportedEnvType: - properties: - qname: - type: string - required: - - qname - type: object - soapenv_UpgradeType: - properties: - SupportedEnvelope: - items: - $ref: '#/components/schemas/soapenv_SupportedEnvType' - type: array - required: - - SupportedEnvelope - type: object - soapenv_detail: - type: object - soapenv_faultcode: - properties: - Subcode: - $ref: '#/components/schemas/soapenv_subcode' - Value: - $ref: '#/components/schemas/soapenv_faultcodeEnum' - required: - - Value - type: object - soapenv_faultcodeEnum: - enum: - - tns:DataEncodingUnknown - - tns:MustUnderstand - - tns:Receiver - - tns:Sender - - tns:VersionMismatch - type: string - soapenv_faultreason: - properties: - Text: - items: - $ref: '#/components/schemas/soapenv_reasontext' - type: array - required: - - Text - type: object - soapenv_reasontext: - properties: - lang: - description: "lang (as an attribute name)\n denotes an attribute whose\ - \ value\n is a language code for the natural language of the content\ - \ of\n any element; its value is inherited. This name is reserved\n\ - \ by virtue of its definition in the XML specification." - oneOf: - - type: string - - type: string - type: object - soapenv_subcode: - properties: - Subcode: - $ref: '#/components/schemas/soapenv_subcode' - Value: - type: string - required: - - Value - type: object - tns1_space: - enum: - - default - - preserve - type: string - wsa_AttributedAnyType: - type: object - wsa_AttributedQNameType: - type: object - wsa_AttributedURIType: - type: object - wsa_EndpointReferenceType: - properties: - Address: - $ref: '#/components/schemas/wsa_AttributedURIType' - Metadata: - $ref: '#/components/schemas/wsa_MetadataType' - ReferenceParameters: - $ref: '#/components/schemas/wsa_ReferenceParametersType' - required: - - Address - type: object - wsa_FaultCodesOpenEnumType: - enum: - - tns:InvalidAddressingHeader - - tns:InvalidAddress - - tns:InvalidEPR - - tns:InvalidCardinality - - tns:MissingAddressInEPR - - tns:DuplicateMessageID - - tns:ActionMismatch - - tns:MessageAddressingHeaderRequired - - tns:DestinationUnreachable - - tns:ActionNotSupported - - tns:EndpointUnavailable - type: string - wsa_FaultCodesOpenEnumType1: - oneOf: - - type: object - wsa_MetadataType: - type: object - wsa_ProblemActionType: - properties: - Action: - $ref: '#/components/schemas/wsa_AttributedURIType' - SoapAction: - type: string - type: object - wsa_ReferenceParametersType: - type: object - wsa_RelatesToType: - properties: - RelationshipType: - oneOf: - - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' - type: object - wsa_RelationshipTypeOpenEnum: - enum: - - http://www.w3.org/2005/08/addressing/reply - type: string - wsa_RelationshipTypeOpenEnum1: - oneOf: - - $ref: '#/components/schemas/wsa_RelationshipTypeOpenEnum' - wsnt_AbsoluteOrRelativeTimeType: - oneOf: - - type: string - - type: string - wsnt_CreatePullPoint: - type: object - wsnt_CreatePullPointResponse: - properties: - PullPoint: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - required: - - PullPoint - type: object - wsnt_DestroyPullPoint: - type: object - wsnt_DestroyPullPointResponse: - type: object - wsnt_FilterType: - type: object - wsnt_GetCurrentMessage: - properties: - Topic: - $ref: '#/components/schemas/wsnt_TopicExpressionType' - required: - - Topic - type: object - wsnt_GetCurrentMessageResponse: - type: object - wsnt_GetMessages: - properties: - MaximumNumber: - format: int32 - type: integer - type: object - wsnt_GetMessagesResponse: - properties: - NotificationMessage: - items: - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' - type: array - type: object - wsnt_InvalidFilterFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - properties: - UnknownFilter: - items: - type: string - type: array - required: - - UnknownFilter - type: object - wsnt_InvalidMessageContentExpressionFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_InvalidProducerPropertiesExpressionFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_InvalidTopicExpressionFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_Message: - type: object - wsnt_MultipleTopicsSpecifiedFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_NoCurrentMessageOnTopicFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_NotificationMessageHolderType: - properties: - Message: - $ref: '#/components/schemas/wsnt_Message' - ProducerReference: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - SubscriptionReference: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - Topic: - $ref: '#/components/schemas/wsnt_TopicExpressionType' - required: - - Message - type: object - wsnt_NotificationProducerRP: - properties: - FixedTopicSet: - default: true - type: boolean - TopicExpression: - items: - $ref: '#/components/schemas/wsnt_TopicExpressionType' - type: array - TopicExpressionDialect: - items: - type: string - type: array - TopicSet: - $ref: '#/components/schemas/wstop_TopicSetType' - type: object - wsnt_Notify: - properties: - NotificationMessage: - items: - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' - type: array - required: - - NotificationMessage - type: object - wsnt_NotifyMessageNotSupportedFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_PauseFailedFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_PauseSubscription: - type: object - wsnt_PauseSubscriptionResponse: - type: object - wsnt_QueryExpressionType: - properties: - Dialect: - type: string - required: - - Dialect - type: object - wsnt_Renew: - properties: - TerminationTime: - allOf: - - oneOf: - - nullable: true - - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' - required: - - TerminationTime - type: object - wsnt_RenewResponse: - properties: - CurrentTime: - format: date-time - type: string - TerminationTime: - format: date-time - type: string - required: - - TerminationTime - type: object - wsnt_ResumeFailedFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_ResumeSubscription: - type: object - wsnt_ResumeSubscriptionResponse: - type: object - wsnt_Subscribe: - properties: - ConsumerReference: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - Filter: - $ref: '#/components/schemas/wsnt_FilterType' - InitialTerminationTime: - allOf: - - oneOf: - - nullable: true - - $ref: '#/components/schemas/wsnt_AbsoluteOrRelativeTimeType' - SubscriptionPolicy: - $ref: '#/components/schemas/wsnt_SubscriptionPolicy' - required: - - ConsumerReference - type: object - wsnt_SubscribeCreationFailedFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_SubscribeResponse: - properties: - CurrentTime: - format: date-time - type: string - SubscriptionReference: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - TerminationTime: - format: date-time - type: string - required: - - SubscriptionReference - type: object - wsnt_SubscriptionManagerRP: - properties: - ConsumerReference: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - CreationTime: - format: date-time - type: string - Filter: - $ref: '#/components/schemas/wsnt_FilterType' - SubscriptionPolicy: - $ref: '#/components/schemas/wsnt_SubscriptionPolicyType' - required: - - ConsumerReference - type: object - wsnt_SubscriptionPolicy: - type: object - wsnt_SubscriptionPolicyType: - type: object - wsnt_TopicExpressionDialectUnknownFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_TopicExpressionType: - properties: - Dialect: - type: string - required: - - Dialect - type: object - wsnt_TopicNotSupportedFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_UnableToCreatePullPointFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_UnableToDestroyPullPointFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_UnableToDestroySubscriptionFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_UnableToGetMessagesFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsnt_UnacceptableInitialTerminationTimeFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - properties: - MaximumTime: - format: date-time - type: string - MinimumTime: - format: date-time - type: string - required: - - MinimumTime - type: object - wsnt_UnacceptableTerminationTimeFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - properties: - MaximumTime: - format: date-time - type: string - MinimumTime: - format: date-time - type: string - required: - - MinimumTime - type: object - wsnt_UnrecognizedPolicyRequestFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - properties: - UnrecognizedPolicy: - items: - type: string - type: array - type: object - wsnt_Unsubscribe: - type: object - wsnt_UnsubscribeResponse: - type: object - wsnt_UnsupportedPolicyRequestFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - properties: - UnsupportedPolicy: - items: - type: string - type: array - type: object - wsnt_UseRaw: - type: object - wsrf-bf_BaseFaultType: - properties: - Description: - items: - $ref: '#/components/schemas/wsrf-bf_Description' - type: array - ErrorCode: - $ref: '#/components/schemas/wsrf-bf_ErrorCode' - FaultCause: - $ref: '#/components/schemas/wsrf-bf_FaultCause' - Originator: - $ref: '#/components/schemas/wsa_EndpointReferenceType' - Timestamp: - format: date-time - type: string - required: - - Timestamp - type: object - wsrf-bf_Description: - properties: - lang: - description: "lang (as an attribute name)\n denotes an attribute whose\ - \ value\n is a language code for the natural language of the content\ - \ of\n any element; its value is inherited. This name is reserved\n\ - \ by virtue of its definition in the XML specification." - oneOf: - - type: string - - type: string - type: object - wsrf-bf_ErrorCode: - properties: - dialect: - type: string - required: - - dialect - type: object - wsrf-bf_FaultCause: - type: object - wstop_Documentation: - type: object - wstop_ExtensibleDocumented: - properties: - documentation: - $ref: '#/components/schemas/wstop_Documentation' - type: object - wstop_QueryExpressionType: - properties: - Dialect: - type: string - required: - - Dialect - type: object - wstop_TopicSetType: - allOf: - - $ref: '#/components/schemas/wstop_ExtensibleDocumented' - - type: object - xmime_base64Binary: - properties: - contentType: - minLength: 3 - type: string - type: object - xmime_hexBinary: - properties: - contentType: - minLength: 3 - type: string - type: object - xop_Include: - properties: - href: - type: string - required: - - href - type: object - device_AddIPAddressFilter: - properties: - IPAddressFilter: - $ref: '#/components/schemas/onvif_IPAddressFilter' - required: - - IPAddressFilter - type: object - device_AddIPAddressFilterResponse: - type: object - device_AddScopes: - properties: - ScopeItem: - description: Contains a list of new configurable scope parameters that will - be added to the existing configurable scope. - items: - type: string - type: array - required: - - ScopeItem - type: object - device_AddScopesResponse: - type: object - device_AutoGeoModes: - enum: - - Location - - Heading - - Leveling - type: string - device_Capabilities: - type: object - device_CreateCertificate: - properties: - CertificateID: - description: Certificate id. - type: string - Subject: - description: Identification of the entity associated with the public-key. - type: string - ValidNotAfter: - description: Certificate expiry start date. - format: date-time - type: string - ValidNotBefore: - description: Certificate validity start date. - format: date-time - type: string - type: object - device_CreateCertificateResponse: - properties: - NvtCertificate: - allOf: - - $ref: '#/components/schemas/onvif_Certificate' - - description: base64 encoded DER representation of certificate. - required: - - NvtCertificate - type: object - device_CreateDot1XConfiguration: - properties: - Dot1XConfiguration: - $ref: '#/components/schemas/onvif_Dot1XConfiguration' - required: - - Dot1XConfiguration - type: object - device_CreateDot1XConfigurationResponse: - type: object - device_CreateStorageConfiguration: - properties: - StorageConfiguration: - $ref: '#/components/schemas/device_StorageConfigurationData' - required: - - StorageConfiguration - type: object - device_CreateStorageConfigurationResponse: - properties: - Token: - maxLength: 64 - type: string - required: - - Token - type: object - device_CreateUsers: - properties: - User: - 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.' - items: - $ref: '#/components/schemas/onvif_User' - type: array - required: - - User - type: object - device_CreateUsersResponse: - type: object - device_DeleteCertificates: - properties: - CertificateID: - description: List of ids of certificates to delete. - items: - type: string - type: array - required: - - CertificateID - type: object - device_DeleteCertificatesResponse: - type: object - device_DeleteDot1XConfiguration: - properties: - Dot1XConfigurationToken: - items: - maxLength: 64 - type: string - type: array - type: object - device_DeleteDot1XConfigurationResponse: - type: object - device_DeleteGeoLocation: - properties: - Location: - items: - $ref: '#/components/schemas/onvif_LocationEntity' - type: array - required: - - Location - type: object - device_DeleteGeoLocationResponse: - type: object - device_DeleteStorageConfiguration: - properties: - Token: - maxLength: 64 - type: string - required: - - Token - type: object - device_DeleteStorageConfigurationResponse: - type: object - device_DeleteUsers: - properties: - Username: - 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. - items: - type: string - type: array - required: - - Username - type: object - device_DeleteUsersResponse: - type: object - device_DeviceServiceCapabilities: - properties: - Misc: - allOf: - - $ref: '#/components/schemas/device_MiscCapabilities' - - description: Capabilities that do not fit in any of the other categories. - Network: - allOf: - - $ref: '#/components/schemas/device_NetworkCapabilities' - - description: Network capabilities. - Security: - allOf: - - $ref: '#/components/schemas/device_SecurityCapabilities' - - description: Security capabilities. - System: - allOf: - - $ref: '#/components/schemas/device_SystemCapabilities' - - description: System capabilities. - required: - - Network - - Security - - System - type: object - device_Extension: - type: object - device_GetAccessPolicy: - type: object - device_GetAccessPolicyResponse: - properties: - PolicyFile: - $ref: '#/components/schemas/onvif_BinaryData' - required: - - PolicyFile - type: object - device_GetAuthFailureWarningConfiguration: - type: object - device_GetAuthFailureWarningConfigurationResponse: - properties: - Enabled: - type: boolean - MaxAuthFailures: - format: int32 - type: integer - MonitorPeriod: - format: int32 - type: integer - required: - - Enabled - - MonitorPeriod - - MaxAuthFailures - type: object - device_GetAuthFailureWarningOptions: - type: object - device_GetAuthFailureWarningOptionsResponse: - properties: - AuthFailureRange: - $ref: '#/components/schemas/onvif_IntRange' - MonitorPeriodRange: - $ref: '#/components/schemas/onvif_IntRange' - required: - - MonitorPeriodRange - - AuthFailureRange - type: object - device_GetCACertificates: - type: object - device_GetCACertificatesResponse: - properties: - CACertificate: - items: - $ref: '#/components/schemas/onvif_Certificate' - type: array - type: object - device_GetCapabilities: - properties: - Category: - description: List of categories to retrieve capability information on. - items: - $ref: '#/components/schemas/onvif_CapabilityCategory' - type: array - type: object - device_GetCapabilitiesResponse: - properties: - Capabilities: - allOf: - - $ref: '#/components/schemas/onvif_Capabilities' - - description: Capability information. - required: - - Capabilities - type: object - device_GetCertificateInformation: - properties: - CertificateID: - type: string - required: - - CertificateID - type: object - device_GetCertificateInformationResponse: - properties: - CertificateInformation: - $ref: '#/components/schemas/onvif_CertificateInformation' - required: - - CertificateInformation - type: object - device_GetCertificates: - type: object - device_GetCertificatesResponse: - properties: - NvtCertificate: - description: Id and base64 encoded DER representation of all available certificates. - items: - $ref: '#/components/schemas/onvif_Certificate' - type: array - type: object - device_GetCertificatesStatus: - type: object - device_GetCertificatesStatusResponse: - properties: - CertificateStatus: - description: Indicates if a certificate is used in an optional HTTPS configuration - of the device. - items: - $ref: '#/components/schemas/onvif_CertificateStatus' - type: array - type: object - device_GetClientCertificateMode: - type: object - device_GetClientCertificateModeResponse: - properties: - Enabled: - description: Indicates whether or not client certificates are required by - device. - type: boolean - required: - - Enabled - type: object - device_GetDNS: - type: object - device_GetDNSResponse: - properties: - DNSInformation: - allOf: - - $ref: '#/components/schemas/onvif_DNSInformation' - - description: DNS information. - required: - - DNSInformation - type: object - device_GetDPAddresses: - type: object - device_GetDPAddressesResponse: - properties: - DPAddress: - items: - $ref: '#/components/schemas/onvif_NetworkHost' - type: array - type: object - device_GetDeviceInformation: - type: object - device_GetDeviceInformationResponse: - properties: - FirmwareVersion: - description: The firmware version in the device. - type: string - HardwareId: - description: The hardware ID of the device. - type: string - Manufacturer: - description: The manufactor of the device. - type: string - Model: - description: The device model. - type: string - SerialNumber: - description: The serial number of the device. - type: string - required: - - Manufacturer - - Model - - FirmwareVersion - - SerialNumber - - HardwareId - type: object - device_GetDiscoveryMode: - type: object - device_GetDiscoveryModeResponse: - properties: - DiscoveryMode: - allOf: - - $ref: '#/components/schemas/onvif_DiscoveryMode' - - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' - required: - - DiscoveryMode - type: object - device_GetDot11Capabilities: - type: object - device_GetDot11CapabilitiesResponse: - properties: - Capabilities: - $ref: '#/components/schemas/onvif_Dot11Capabilities' - required: - - Capabilities - type: object - device_GetDot11Status: - properties: - InterfaceToken: - maxLength: 64 - type: string - required: - - InterfaceToken - type: object - device_GetDot11StatusResponse: - properties: - Status: - $ref: '#/components/schemas/onvif_Dot11Status' - required: - - Status - type: object - device_GetDot1XConfiguration: - properties: - Dot1XConfigurationToken: - maxLength: 64 - type: string - required: - - Dot1XConfigurationToken - type: object - device_GetDot1XConfigurationResponse: - properties: - Dot1XConfiguration: - $ref: '#/components/schemas/onvif_Dot1XConfiguration' - required: - - Dot1XConfiguration - type: object - device_GetDot1XConfigurations: - type: object - device_GetDot1XConfigurationsResponse: - properties: - Dot1XConfiguration: - items: - $ref: '#/components/schemas/onvif_Dot1XConfiguration' - type: array - type: object - device_GetDynamicDNS: - type: object - device_GetDynamicDNSResponse: - properties: - DynamicDNSInformation: - allOf: - - $ref: '#/components/schemas/onvif_DynamicDNSInformation' - - description: Dynamic DNS information. - required: - - DynamicDNSInformation - type: object - device_GetEndpointReference: - type: object - device_GetEndpointReferenceResponse: - properties: - GUID: - type: string - required: - - GUID - type: object - device_GetGeoLocation: - type: object - device_GetGeoLocationResponse: - properties: - Location: - items: - $ref: '#/components/schemas/onvif_LocationEntity' - type: array - type: object - device_GetHostname: - type: object - device_GetHostnameResponse: - properties: - HostnameInformation: - allOf: - - $ref: '#/components/schemas/onvif_HostnameInformation' - - description: Contains the hostname information. - required: - - HostnameInformation - type: object - device_GetIPAddressFilter: - type: object - device_GetIPAddressFilterResponse: - properties: - IPAddressFilter: - $ref: '#/components/schemas/onvif_IPAddressFilter' - required: - - IPAddressFilter - type: object - device_GetNTP: - type: object - device_GetNTPResponse: - properties: - NTPInformation: - allOf: - - $ref: '#/components/schemas/onvif_NTPInformation' - - description: NTP information. - required: - - NTPInformation - type: object - device_GetNetworkDefaultGateway: - type: object - device_GetNetworkDefaultGatewayResponse: - properties: - NetworkGateway: - allOf: - - $ref: '#/components/schemas/onvif_NetworkGateway' - - description: Gets the default IPv4 and IPv6 gateway settings from the - device. - required: - - NetworkGateway - type: object - device_GetNetworkInterfaces: - type: object - device_GetNetworkInterfacesResponse: - properties: - NetworkInterfaces: - description: List of network interfaces. - items: - $ref: '#/components/schemas/onvif_NetworkInterface' - type: array - required: - - NetworkInterfaces - type: object - device_GetNetworkProtocols: - type: object - device_GetNetworkProtocolsResponse: - properties: - NetworkProtocols: - 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.' - items: - $ref: '#/components/schemas/onvif_NetworkProtocol' - type: array - type: object - device_GetPasswordComplexityConfiguration: - type: object - device_GetPasswordComplexityConfigurationResponse: - properties: - BlockUsernameOccurrence: - type: boolean - MinLen: - format: int32 - type: integer - Number: - format: int32 - type: integer - PolicyConfigurationLocked: - type: boolean - SpecialChars: - format: int32 - type: integer - Uppercase: - format: int32 - type: integer - type: object - device_GetPasswordComplexityOptions: - type: object - device_GetPasswordComplexityOptionsResponse: - properties: - BlockUsernameOccurrenceSupported: - type: boolean - MinLenRange: - $ref: '#/components/schemas/onvif_IntRange' - NumberRange: - $ref: '#/components/schemas/onvif_IntRange' - PolicyConfigurationLockSupported: - type: boolean - SpecialCharsRange: - $ref: '#/components/schemas/onvif_IntRange' - UppercaseRange: - $ref: '#/components/schemas/onvif_IntRange' - type: object - device_GetPasswordHistoryConfiguration: - type: object - device_GetPasswordHistoryConfigurationResponse: - properties: - Enabled: - type: boolean - Length: - format: int32 - type: integer - required: - - Enabled - - Length - type: object - device_GetPkcs10Request: - properties: - Attributes: - allOf: - - $ref: '#/components/schemas/onvif_BinaryData' - - description: Optional base64 encoded DER attributes. - CertificateID: - description: List of ids of certificates to delete. - type: string - Subject: - description: Relative Dinstinguished Name(RDN) CommonName(CN). - type: string - required: - - CertificateID - type: object - device_GetPkcs10RequestResponse: - properties: - Pkcs10Request: - allOf: - - $ref: '#/components/schemas/onvif_BinaryData' - - description: base64 encoded DER representation of certificate. - required: - - Pkcs10Request - type: object - device_GetRelayOutputs: - type: object - device_GetRelayOutputsResponse: - properties: - RelayOutputs: - items: - $ref: '#/components/schemas/onvif_RelayOutput' - type: array - type: object - device_GetRemoteDiscoveryMode: - type: object - device_GetRemoteDiscoveryModeResponse: - properties: - RemoteDiscoveryMode: - allOf: - - $ref: '#/components/schemas/onvif_DiscoveryMode' - - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' - required: - - RemoteDiscoveryMode - type: object - device_GetRemoteUser: - type: object - device_GetRemoteUserResponse: - properties: - RemoteUser: - $ref: '#/components/schemas/onvif_RemoteUser' - type: object - device_GetScopes: - type: object - device_GetScopesResponse: - properties: - Scopes: - 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.' - items: - $ref: '#/components/schemas/onvif_Scope' - type: array - required: - - Scopes - type: object - device_GetServiceCapabilities: - type: object - device_GetServiceCapabilitiesResponse: - properties: - Capabilities: - allOf: - - $ref: '#/components/schemas/device_DeviceServiceCapabilities' - - description: The capabilities for the device service is returned in the - Capabilities element. - required: - - Capabilities - type: object - device_GetServices: - properties: - IncludeCapability: - description: Indicates if the service capabilities (untyped) should be included - in the response. - type: boolean - required: - - IncludeCapability - type: object - device_GetServicesResponse: - properties: - Service: - description: Each Service element contains information about one service. - items: - $ref: '#/components/schemas/device_Service' - type: array - required: - - Service - type: object - device_GetStorageConfiguration: - properties: - Token: - maxLength: 64 - type: string - required: - - Token - type: object - device_GetStorageConfigurationResponse: - properties: - StorageConfiguration: - $ref: '#/components/schemas/device_StorageConfiguration' - required: - - StorageConfiguration - type: object - device_GetStorageConfigurations: - type: object - device_GetStorageConfigurationsResponse: - properties: - StorageConfigurations: - items: - $ref: '#/components/schemas/device_StorageConfiguration' - type: array - type: object - device_GetSystemBackup: - type: object - device_GetSystemBackupResponse: - properties: - BackupFiles: - items: - $ref: '#/components/schemas/onvif_BackupFile' - type: array - required: - - BackupFiles - type: object - device_GetSystemDateAndTime: - type: object - device_GetSystemDateAndTimeResponse: - properties: - SystemDateAndTime: - allOf: - - $ref: '#/components/schemas/onvif_SystemDateTime' - - 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. - required: - - SystemDateAndTime - type: object - device_GetSystemLog: - properties: - LogType: - allOf: - - $ref: '#/components/schemas/onvif_SystemLogType' - - description: Specifies the type of system log to get. - required: - - LogType - type: object - device_GetSystemLogResponse: - properties: - SystemLog: - allOf: - - $ref: '#/components/schemas/onvif_SystemLog' - - description: Contains the system log information. - required: - - SystemLog - type: object - device_GetSystemSupportInformation: - type: object - device_GetSystemSupportInformationResponse: - properties: - SupportInformation: - allOf: - - $ref: '#/components/schemas/onvif_SupportInformation' - - description: Contains the arbitary device diagnostics information. - required: - - SupportInformation - type: object - device_GetSystemUris: - type: object - device_GetSystemUrisResponse: - properties: - Extension: - $ref: '#/components/schemas/device_Extension' - SupportInfoUri: - type: string - SystemBackupUri: - type: string - SystemLogUris: - $ref: '#/components/schemas/onvif_SystemLogUriList' - type: object - device_GetUsers: - type: object - device_GetUsersResponse: - properties: - User: - description: 'Contains a list of the onvif users and following information - is included in each entry: username and user level.' - items: - $ref: '#/components/schemas/onvif_User' - type: array - type: object - device_GetWsdlUrl: - type: object - device_GetWsdlUrlResponse: - properties: - WsdlUrl: - type: string - required: - - WsdlUrl - type: object - device_GetZeroConfiguration: - type: object - device_GetZeroConfigurationResponse: - properties: - ZeroConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_NetworkZeroConfiguration' - - description: Contains the zero-configuration. - required: - - ZeroConfiguration - type: object - device_LoadCACertificates: - properties: - CACertificate: - items: - $ref: '#/components/schemas/onvif_Certificate' - type: array - required: - - CACertificate - type: object - device_LoadCACertificatesResponse: - type: object - device_LoadCertificateWithPrivateKey: - properties: - CertificateWithPrivateKey: - items: - $ref: '#/components/schemas/onvif_CertificateWithPrivateKey' - type: array - required: - - CertificateWithPrivateKey - type: object - device_LoadCertificateWithPrivateKeyResponse: - type: object - device_LoadCertificates: - properties: - NVTCertificate: - description: Optional id and base64 encoded DER representation of certificate. - items: - $ref: '#/components/schemas/onvif_Certificate' - type: array - required: - - NVTCertificate - type: object - device_LoadCertificatesResponse: - type: object - device_MiscCapabilities: - properties: - AuxiliaryCommands: - description: Lists of commands supported by SendAuxiliaryCommand. - type: string - type: object - device_NetworkCapabilities: - properties: - DHCPv6: - description: Indicates support for Stateful IPv6 DHCP. - type: boolean - Dot11Configuration: - description: Indicates support for IEEE 802.11 configuration. - type: boolean - Dot1XConfigurations: - description: Indicates the maximum number of Dot1X configurations supported - by the device - format: int32 - type: integer - DynDNS: - description: Indicates support for dynamic DNS configuration. - type: boolean - HostnameFromDHCP: - description: Indicates support for retrieval of hostname from DHCP. - type: boolean - IPFilter: - description: Indicates support for IP filtering. - type: boolean - IPVersion6: - description: Indicates support for IPv6. - type: boolean - NTP: - description: Maximum number of NTP servers supported by the devices SetNTP - command. - format: int32 - type: integer - ZeroConfiguration: - description: Indicates support for zeroconf. - type: boolean - type: object - device_RemoveIPAddressFilter: - properties: - IPAddressFilter: - $ref: '#/components/schemas/onvif_IPAddressFilter' - required: - - IPAddressFilter - type: object - device_RemoveIPAddressFilterResponse: - type: object - device_RemoveScopes: - properties: - ScopeItem: - description: Contains a list of URIs that should be removed from the device - scope. - items: - type: string - type: array - required: - - ScopeItem - type: object - device_RemoveScopesResponse: - properties: - ScopeItem: - description: Contains a list of URIs that has been removed from the device - scope - items: - type: string - type: array - type: object - device_RestoreSystem: - properties: - BackupFiles: - items: - $ref: '#/components/schemas/onvif_BackupFile' - type: array - required: - - BackupFiles - type: object - device_RestoreSystemResponse: - type: object - device_ScanAvailableDot11Networks: - properties: - InterfaceToken: - maxLength: 64 - type: string - required: - - InterfaceToken - type: object - device_ScanAvailableDot11NetworksResponse: - properties: - Networks: - items: - $ref: '#/components/schemas/onvif_Dot11AvailableNetworks' - type: array - type: object - device_SecurityCapabilities: - properties: - AccessPolicyConfig: - description: Indicates support for access policy configuration. - type: boolean - DefaultAccessPolicy: - description: Indicates support for the ONVIF default access policy. - type: boolean - Dot1X: - description: Indicates support for IEEE 802.1X configuration. - type: boolean - HttpDigest: - description: Indicates support for WS over HTTP digest authenticated communication - layer. - type: boolean - KerberosToken: - description: Indicates support for WS-Security Kerberos token. - type: boolean - MaxPasswordHistory: - description: Maximum number of passwords that the device can remember for - each user - format: int32 - type: integer - MaxPasswordLength: - description: Maximum number of characters supported for the password by - CreateUsers and SetUser. - format: int32 - type: integer - MaxUserNameLength: - description: Maximum number of characters supported for the username by - CreateUsers. - format: int32 - type: integer - MaxUsers: - description: The maximum number of users that the device supports. - format: int32 - type: integer - OnboardKeyGeneration: - description: Indicates support for onboard key generation. - type: boolean - RELToken: - description: Indicates support for WS-Security REL token. - type: boolean - RemoteUserHandling: - description: Indicates support for remote user configuration. Used when - accessing another device. - type: boolean - SAMLToken: - description: Indicates support for WS-Security SAML token. - type: boolean - SecurityPolicies: - description: 'Indicates which security policies are supported. Options are: - ModifyPassword, PasswordComplexity, AuthFailureWarnings' - type: string - SupportedEAPMethods: - description: EAP Methods supported by the device. The int values refer to - the - format: int32 - type: integer - TLS1.0: - description: Indicates support for TLS 1.0. - type: boolean - TLS1.1: - description: Indicates support for TLS 1.1. - type: boolean - TLS1.2: - description: Indicates support for TLS 1.2. - type: boolean - UsernameToken: - description: Indicates support for WS-Security Username token. - type: boolean - X.509Token: - description: Indicates support for WS-Security X.509 token. - type: boolean - type: object - device_SendAuxiliaryCommand: - properties: - AuxiliaryCommand: - maxLength: 128 - type: string - required: - - AuxiliaryCommand - type: object - device_SendAuxiliaryCommandResponse: - properties: - AuxiliaryCommandResponse: - maxLength: 128 - type: string - type: object - device_Service: - properties: - Capabilities: - $ref: '#/components/schemas/device_Capabilities' - Namespace: - 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. - type: string - Version: - allOf: - - $ref: '#/components/schemas/onvif_OnvifVersion' - - description: The version of the service (not the ONVIF core spec version). - XAddr: - 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). - type: string - required: - - Namespace - - XAddr - - Version - type: object - device_SetAccessPolicy: - properties: - PolicyFile: - $ref: '#/components/schemas/onvif_BinaryData' - required: - - PolicyFile - type: object - device_SetAccessPolicyResponse: - type: object - device_SetAuthFailureWarningConfiguration: - properties: - Enabled: - type: boolean - MaxAuthFailures: - format: int32 - type: integer - MonitorPeriod: - format: int32 - type: integer - required: - - Enabled - - MonitorPeriod - - MaxAuthFailures - type: object - device_SetAuthFailureWarningConfigurationResponse: - type: object - device_SetCertificatesStatus: - properties: - CertificateStatus: - description: Indicates if a certificate is to be used in an optional HTTPS - configuration of the device. - items: - $ref: '#/components/schemas/onvif_CertificateStatus' - type: array - type: object - device_SetCertificatesStatusResponse: - type: object - device_SetClientCertificateMode: - properties: - Enabled: - description: Indicates whether or not client certificates are required by - device. - type: boolean - required: - - Enabled - type: object - device_SetClientCertificateModeResponse: - type: object - device_SetDNS: - properties: - DNSManual: - description: DNS address(es) set manually. - items: - $ref: '#/components/schemas/onvif_IPAddress' - type: array - FromDHCP: - description: Indicate if the DNS address is to be retrieved using DHCP. - type: boolean - SearchDomain: - description: DNS search domain. - items: - type: string - type: array - required: - - FromDHCP - type: object - device_SetDNSResponse: - type: object - device_SetDPAddresses: - properties: - DPAddress: - items: - $ref: '#/components/schemas/onvif_NetworkHost' - type: array - type: object - device_SetDPAddressesResponse: - type: object - device_SetDiscoveryMode: - properties: - DiscoveryMode: - allOf: - - $ref: '#/components/schemas/onvif_DiscoveryMode' - - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' - required: - - DiscoveryMode - type: object - device_SetDiscoveryModeResponse: - type: object - device_SetDot1XConfiguration: - properties: - Dot1XConfiguration: - $ref: '#/components/schemas/onvif_Dot1XConfiguration' - required: - - Dot1XConfiguration - type: object - device_SetDot1XConfigurationResponse: - type: object - device_SetDynamicDNS: - properties: - Name: - description: DNS name. - type: string - TTL: - description: DNS record time to live. - format: date-time - type: string - Type: - allOf: - - $ref: '#/components/schemas/onvif_DynamicDNSType' - - description: Dynamic DNS type. - required: - - Type - type: object - device_SetDynamicDNSResponse: - type: object - device_SetGeoLocation: - properties: - Location: - items: - $ref: '#/components/schemas/onvif_LocationEntity' - type: array - required: - - Location - type: object - device_SetGeoLocationResponse: - type: object - device_SetHostname: - properties: - Name: - description: The hostname to set. - type: string - required: - - Name - type: object - device_SetHostnameFromDHCP: - properties: - FromDHCP: - description: True if the hostname shall be obtained via DHCP. - type: boolean - required: - - FromDHCP - type: object - device_SetHostnameFromDHCPResponse: - properties: - RebootNeeded: - description: Indicates whether or not a reboot is required after configuration - updates. - type: boolean - required: - - RebootNeeded - type: object - device_SetHostnameResponse: - type: object - device_SetIPAddressFilter: - properties: - IPAddressFilter: - $ref: '#/components/schemas/onvif_IPAddressFilter' - required: - - IPAddressFilter - type: object - device_SetIPAddressFilterResponse: - type: object - device_SetNTP: - properties: - FromDHCP: - description: Indicate if NTP address information is to be retrieved using - DHCP. - type: boolean - NTPManual: - description: Manual NTP settings. - items: - $ref: '#/components/schemas/onvif_NetworkHost' - type: array - required: - - FromDHCP - type: object - device_SetNTPResponse: - type: object - device_SetNetworkDefaultGateway: - properties: - IPv4Address: - description: Sets IPv4 gateway address used as default setting. - items: - type: string - type: array - IPv6Address: - description: Sets IPv6 gateway address used as default setting. - items: - type: string - type: array - type: object - device_SetNetworkDefaultGatewayResponse: - type: object - device_SetNetworkInterfaces: - properties: - InterfaceToken: - description: Symbolic network interface name. - maxLength: 64 - type: string - NetworkInterface: - allOf: - - $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfiguration' - - description: Network interface name. - required: - - InterfaceToken - - NetworkInterface - type: object - device_SetNetworkInterfacesResponse: - properties: - RebootNeeded: - 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." - type: boolean - required: - - RebootNeeded - type: object - device_SetNetworkProtocols: - properties: - NetworkProtocols: - 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.' - items: - $ref: '#/components/schemas/onvif_NetworkProtocol' - type: array - required: - - NetworkProtocols - type: object - device_SetNetworkProtocolsResponse: - type: object - device_SetPasswordComplexityConfiguration: - properties: - BlockUsernameOccurrence: - type: boolean - MinLen: - format: int32 - type: integer - Number: - format: int32 - type: integer - PolicyConfigurationLocked: - type: boolean - SpecialChars: - format: int32 - type: integer - Uppercase: - format: int32 - type: integer - type: object - device_SetPasswordComplexityConfigurationResponse: - type: object - device_SetPasswordHistoryConfiguration: - properties: - Enabled: - type: boolean - Length: - format: int32 - type: integer - required: - - Enabled - - Length - type: object - device_SetPasswordHistoryConfigurationResponse: - type: object - device_SetRelayOutputSettings: - properties: - Properties: - $ref: '#/components/schemas/onvif_RelayOutputSettings' - RelayOutputToken: - maxLength: 64 - type: string - required: - - RelayOutputToken - - Properties - type: object - device_SetRelayOutputSettingsResponse: - type: object - device_SetRelayOutputState: - properties: - LogicalState: - $ref: '#/components/schemas/onvif_RelayLogicalState' - RelayOutputToken: - maxLength: 64 - type: string - required: - - RelayOutputToken - - LogicalState - type: object - device_SetRelayOutputStateResponse: - type: object - device_SetRemoteDiscoveryMode: - properties: - RemoteDiscoveryMode: - allOf: - - $ref: '#/components/schemas/onvif_DiscoveryMode' - - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' - required: - - RemoteDiscoveryMode - type: object - device_SetRemoteDiscoveryModeResponse: - type: object - device_SetRemoteUser: - properties: - RemoteUser: - $ref: '#/components/schemas/onvif_RemoteUser' - type: object - device_SetRemoteUserResponse: - type: object - device_SetScopes: - properties: - Scopes: - description: Contains a list of scope parameters that will replace all existing - configurable scope parameters. - items: - type: string - type: array - required: - - Scopes - type: object - device_SetScopesResponse: - type: object - device_SetStorageConfiguration: - properties: - StorageConfiguration: - $ref: '#/components/schemas/device_StorageConfiguration' - required: - - StorageConfiguration - type: object - device_SetStorageConfigurationResponse: - type: object - device_SetSystemDateAndTime: - properties: - DateTimeType: - allOf: - - $ref: '#/components/schemas/onvif_SetDateTimeType' - - description: Defines if the date and time is set via NTP or manually. - DaylightSavings: - description: Automatically adjust Daylight savings if defined in TimeZone. - type: boolean - TimeZone: - allOf: - - $ref: '#/components/schemas/onvif_TimeZone' - - description: The time zone in POSIX 1003.1 format - UTCDateTime: - allOf: - - $ref: '#/components/schemas/onvif_DateTime' - - description: Date and time in UTC. If time is obtained via NTP, UTCDateTime - has no meaning - required: - - DateTimeType - - DaylightSavings - type: object - device_SetSystemDateAndTimeResponse: - type: object - device_SetSystemFactoryDefault: - properties: - FactoryDefault: - allOf: - - $ref: '#/components/schemas/onvif_FactoryDefaultType' - - description: Specifies the factory default action type. - required: - - FactoryDefault - type: object - device_SetSystemFactoryDefaultResponse: - type: object - device_SetUser: - properties: - User: - 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. - items: - $ref: '#/components/schemas/onvif_User' - type: array - required: - - User - type: object - device_SetUserResponse: - type: object - device_SetZeroConfiguration: - properties: - Enabled: - description: Specifies if the zero-configuration should be enabled or not. - type: boolean - InterfaceToken: - description: Unique identifier referencing the physical interface. - maxLength: 64 - type: string - required: - - InterfaceToken - - Enabled - type: object - device_SetZeroConfigurationResponse: - type: object - device_StartFirmwareUpgrade: - type: object - device_StartFirmwareUpgradeResponse: - properties: - ExpectedDownTime: - format: date-time - type: string - UploadDelay: - format: date-time - type: string - UploadUri: - type: string - required: - - UploadUri - - UploadDelay - - ExpectedDownTime - type: object - device_StartSystemRestore: - type: object - device_StartSystemRestoreResponse: - properties: - ExpectedDownTime: - format: date-time - type: string - UploadUri: - type: string - required: - - UploadUri - - ExpectedDownTime - type: object - device_StorageConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_DeviceEntity' - - properties: - Data: - $ref: '#/components/schemas/device_StorageConfigurationData' - required: - - Data - type: object - device_StorageConfigurationData: - properties: - Extension: - $ref: '#/components/schemas/device_Extension' - LocalPath: - description: local path - type: string - StorageUri: - description: Storage server address - type: string - User: - allOf: - - $ref: '#/components/schemas/device_UserCredential' - - description: User credential for the storage server - type: - description: StorageType lists the acceptable values for type attribute - type: string - required: - - type - type: object - device_StorageType: - enum: - - NFS - - CIFS - - CDMI - - FTP - type: string - device_SystemCapabilities: - properties: - Addons: - description: List of supported Addons by the device. - type: string - AutoGeo: - description: List of supported automatic GeoLocation adjustment supported - by the device. Valid items are defined by tds:AutoGeoMode. - type: string - DiscoveryBye: - description: Indicates support for WS-Discovery Bye. - type: boolean - DiscoveryNotSupported: - description: Indicates no support for network discovery. - type: boolean - DiscoveryResolve: - description: Indicates support for WS Discovery resolve requests. - type: boolean - FirmwareUpgrade: - description: Indicates support for firmware upgrade through MTOM. - type: boolean - GeoLocationEntries: - description: If present signals support for geo location. The value signals - the supported number of entries. - format: int32 - type: integer - HttpFirmwareUpgrade: - description: Indicates support for firmware upgrade through HTTP. - type: boolean - HttpSupportInformation: - description: Indicates support for retrieving support information through - HTTP. - type: boolean - HttpSystemBackup: - description: Indicates support for system backup through HTTP. - type: boolean - HttpSystemLogging: - description: Indicates support for retrieval of system logging through HTTP. - type: boolean - MaxStorageConfigurations: - description: Indicates maximum number of storage configurations supported. - format: int32 - type: integer - NetworkConfigNotSupported: - description: Indicates no support for network configuration. - type: boolean - RemoteDiscovery: - description: Indicates support for remote discovery. - type: boolean - StorageConfiguration: - description: Indicates support for storage configuration interfaces. - type: boolean - StorageTypesSupported: - description: Enumerates the supported StorageTypes, see tds:StorageType. - type: string - SystemBackup: - description: Indicates support for system backup through MTOM. - type: boolean - SystemLogging: - description: Indicates support for retrieval of system logging through MTOM. - type: boolean - UserConfigNotSupported: - description: Indicates no support for user configuration. - type: boolean - type: object - device_SystemReboot: - type: object - device_SystemRebootResponse: - properties: - Message: - description: Contains the reboot message sent by the device. - type: string - required: - - Message - type: object - device_UpgradeSystemFirmware: - properties: - Firmware: - $ref: '#/components/schemas/onvif_AttachmentData' - required: - - Firmware - type: object - device_UpgradeSystemFirmwareResponse: - properties: - Message: - type: string - type: object - device_UserCredential: - properties: - Extension: - $ref: '#/components/schemas/device_Extension' - Password: - description: optional password - type: string - UserName: - description: User name - type: string - required: - - UserName - type: object - PullMessagesFaultResponse_Error: - properties: - PullMessagesFaultResponse: - $ref: '#/components/schemas/event_PullMessagesFaultResponse' - required: - - PullMessagesFaultResponse - type: object - ResourceUnknownFault_Error: - properties: - ResourceUnknownFault: - $ref: '#/components/schemas/wsrf-r_ResourceUnknownFaultType' - required: - - ResourceUnknownFault - type: object - UnableToCreatePullPointFault_Error: - properties: - UnableToCreatePullPointFault: - $ref: '#/components/schemas/wsnt_UnableToCreatePullPointFaultType' - required: - - UnableToCreatePullPointFault - type: object - event_AbsoluteOrRelativeTimeType: - oneOf: - - type: string - - type: string - event_AddEventBroker: - properties: - EventBroker: - $ref: '#/components/schemas/event_EventBrokerConfig' - required: - - EventBroker - type: object - event_AddEventBrokerResponse: - type: object - event_Capabilities: - properties: - EventBrokerProtocols: - description: A space separated list of supported event broker protocols - as defined by the tev:EventBrokerProtocol datatype. - type: string - MaxEventBrokers: - description: Maxiumum number of event broker configurations that can be - added to the device. - format: int32 - type: integer - MaxNotificationProducers: - description: Maximum number of supported notification producers as defined - by WS-BaseNotification. - format: int32 - type: integer - MaxPullPoints: - description: Maximum supported number of notification pull points. - format: int32 - type: integer - MetadataOverMQTT: - description: Indicates that metadata streaming over MQTT is supported - type: boolean - PersistentNotificationStorage: - description: Indication if the device supports persistent notification storage. - type: boolean - WSPausableSubscriptionManagerInterfaceSupport: - description: Indicates that the WS Pausable Subscription Manager Interface - is supported. - type: boolean - WSPullPointSupport: - description: Indicates that the WS Pull Point is supported. - type: boolean - WSSubscriptionPolicySupport: - description: Indicates that the WS Subscription policy is supported. - type: boolean - type: object - event_ConnectionStatus: - enum: - - Offline - - Connecting - - Connected - type: string - event_CreatePullPointSubscription: - properties: - Filter: - allOf: - - $ref: '#/components/schemas/wsnt_FilterType' - - description: Optional XPATH expression to select specific topics. - InitialTerminationTime: - allOf: - - oneOf: - - nullable: true - - $ref: '#/components/schemas/event_AbsoluteOrRelativeTimeType' - - description: Initial termination time. - SubscriptionPolicy: - allOf: - - $ref: '#/components/schemas/event_SubscriptionPolicy' - - description: Refer to - type: object - event_CreatePullPointSubscriptionResponse: - properties: - CurrentTime: - description: Current time of the server for synchronization purposes. - format: date-time - type: string - SubscriptionReference: - allOf: - - $ref: '#/components/schemas/wsa_EndpointReferenceType' - - description: Endpoint reference of the subscription to be used for pulling - the messages. - TerminationTime: - description: Date time when the PullPoint will be shut down without further - pull requests. - format: date-time - type: string - required: - - SubscriptionReference - - CurrentTime - - TerminationTime - type: object - event_DeleteEventBroker: - properties: - Address: - type: string - required: - - Address - type: object - event_DeleteEventBrokerResponse: - type: object - event_EventBrokerConfig: - properties: - Address: - 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. - type: string - CertPathValidationPolicyID: - 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. - type: string - CertificateID: - description: Optional certificate ID in the key store pointing to a client - certificate to be used for authenticating the device at the message broker. - type: string - MetadataFilter: - allOf: - - $ref: '#/components/schemas/wsnt_FilterType' - - description: Concrete Topic Expression to select specific metadata topics - to publish. - Password: - description: Password for the event broker. Password shall not be included - when returned with GetEventBrokers. - type: string - PublishFilter: - allOf: - - $ref: '#/components/schemas/wsnt_FilterType' - - description: Concrete Topic Expression to select specific event topics - to publish. - QoS: - 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.' - format: int32 - type: integer - Status: - description: Current connection status (see tev:ConnectionStatus for possible - values). - type: string - TopicPrefix: - 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. - type: string - UserName: - description: User name for the event broker. - type: string - required: - - Address - - TopicPrefix - type: object - event_EventBrokerProtocol: - enum: - - mqtt - - mqtts - - ws - - wss - type: string - event_GetEventBrokers: - properties: - Address: - type: string - type: object - event_GetEventBrokersResponse: - properties: - EventBroker: - items: - $ref: '#/components/schemas/event_EventBrokerConfig' - type: array - type: object - event_GetEventProperties: - type: object - event_GetEventPropertiesResponse: - properties: - FixedTopicSet: - description: True when topicset is fixed for all times. - type: boolean - MessageContentFilterDialect: - description: Defines the XPath function set supported for message content - filtering. - items: - type: string - type: array - MessageContentSchemaLocation: - 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." - items: - type: string - type: array - ProducerPropertiesFilterDialect: - description: Optional ProducerPropertiesDialects. Refer to - items: - type: string - type: array - TopicExpressionDialect: - description: Defines the XPath expression syntax supported for matching - topic expressions. - items: - type: string - type: array - TopicNamespaceLocation: - description: List of topic namespaces supported. - items: - type: string - type: array - TopicSet: - allOf: - - $ref: '#/components/schemas/wstop_TopicSetType' - - description: Set of topics supported. - required: - - TopicNamespaceLocation - - FixedTopicSet - - TopicSet - - TopicExpressionDialect - - MessageContentFilterDialect - - MessageContentSchemaLocation - type: object - event_GetServiceCapabilities: - type: object - event_GetServiceCapabilitiesResponse: - properties: - Capabilities: - allOf: - - $ref: '#/components/schemas/event_Capabilities' - - description: The capabilities for the event service is returned in the - Capabilities element. - required: - - Capabilities - type: object - event_PullMessages: - properties: - MessageLimit: - description: Upper limit for the number of messages to return at once. A - server implementation may decide to return less messages. - format: int32 - type: integer - Timeout: - description: Maximum time to block until this method returns. - format: date-time - type: string - required: - - Timeout - - MessageLimit - type: object - event_PullMessagesFaultResponse: - properties: - MaxMessageLimit: - description: Maximum message limit supported by the device. - format: int32 - type: integer - MaxTimeout: - description: Maximum timeout supported by the device. - format: date-time - type: string - required: - - MaxTimeout - - MaxMessageLimit - type: object - event_PullMessagesResponse: - properties: - CurrentTime: - description: The date and time when the messages have been delivered by - the web server to the client. - format: date-time - type: string - NotificationMessage: - description: List of messages. This list shall be empty in case of a timeout. - items: - $ref: '#/components/schemas/wsnt_NotificationMessageHolderType' - type: array - TerminationTime: - description: Date time when the PullPoint will be shut down without further - pull requests. - format: date-time - type: string - required: - - CurrentTime - - TerminationTime - type: object - event_Seek: - properties: - Reverse: - description: Reverse the pull direction of PullMessages. - type: boolean - UtcTime: - description: The date and time to match against stored messages. - format: date-time - type: string - required: - - UtcTime - type: object - event_SeekResponse: - type: object - event_SetSynchronizationPoint: - type: object - event_SetSynchronizationPointResponse: - type: object - event_SubscriptionPolicy: - description: Refer to - type: object - wsrf-r_ResourceUnavailableFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - wsrf-r_ResourceUnknownFaultType: - allOf: - - $ref: '#/components/schemas/wsrf-bf_BaseFaultType' - - type: object - imaging_Capabilities: - properties: - AdaptablePreset: - description: Indicates whether or not imaging preset settings can be updated. - type: boolean - ImageStabilization: - 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." - type: boolean - Presets: - description: Indicates whether or not Imaging Presets feature is supported. - type: boolean - type: object - imaging_GetCurrentPreset: - properties: - VideoSourceToken: - description: Reference token to the VideoSource where the current Imaging - Preset should be requested. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_GetCurrentPresetResponse: - properties: - Preset: - allOf: - - $ref: '#/components/schemas/imaging_ImagingPreset' - - description: Current Imaging Preset in use for the specified Video Source. - type: object - imaging_GetImagingSettings: - properties: - VideoSourceToken: - description: Reference token to the VideoSource for which the ImagingSettings. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_GetImagingSettingsResponse: - properties: - ImagingSettings: - allOf: - - $ref: '#/components/schemas/onvif_ImagingSettings20' - - description: ImagingSettings for the VideoSource that was requested. - required: - - ImagingSettings - type: object - imaging_GetMoveOptions: - properties: - VideoSourceToken: - description: Reference token to the VideoSource for the requested move options. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_GetMoveOptionsResponse: - properties: - MoveOptions: - allOf: - - $ref: '#/components/schemas/onvif_MoveOptions20' - - description: Valid ranges for the focus lens move options. - required: - - MoveOptions - type: object - imaging_GetOptions: - properties: - VideoSourceToken: - description: Reference token to the VideoSource for which the imaging parameter - options are requested. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_GetOptionsResponse: - properties: - ImagingOptions: - allOf: - - $ref: '#/components/schemas/onvif_ImagingOptions20' - - description: Valid ranges for the imaging parameters that are categorized - as device specific. - required: - - ImagingOptions - type: object - imaging_GetPresets: - properties: - VideoSourceToken: - description: A reference to the VideoSource where the operation should take - place. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_GetPresetsResponse: - properties: - Preset: - description: List of Imaging Presets which are available for the requested - VideoSource. - items: - $ref: '#/components/schemas/imaging_ImagingPreset' - type: array - required: - - Preset - type: object - imaging_GetServiceCapabilities: - type: object - imaging_GetServiceCapabilitiesResponse: - properties: - Capabilities: - allOf: - - $ref: '#/components/schemas/imaging_Capabilities' - - description: The capabilities for the imaging service is returned in the - Capabilities element. - required: - - Capabilities - type: object - imaging_GetStatus: - properties: - VideoSourceToken: - description: Reference token to the VideoSource where the imaging status - should be requested. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_GetStatusResponse: - properties: - Status: - allOf: - - $ref: '#/components/schemas/onvif_ImagingStatus20' - - description: Requested imaging status. - required: - - Status - type: object - imaging_ImagingPreset: - description: Type describing the Imaging Preset settings. - properties: - Name: - description: Human readable name of the Imaging Preset. - maxLength: 64 - type: string - token: - description: Unique identifier of this Imaging Preset. - maxLength: 64 - type: string - type: - description: "Indicates Imaging Preset Type. Use timg:ImagingPresetType.\ - \ \n\t\t\t\t\t\tUsed for multi-language support and display." - type: string - required: - - token - - type - - Name - type: object - imaging_ImagingPresetType: - description: "Describes standard Imaging Preset types, used to facilitate Multi-language\ - \ support and client display.\n\t\t\t\t\t\"Custom\" Type shall be used when\ - \ Imaging Preset Name does not match any of the types included in the standard\ - \ classification." - enum: - - Custom - - ClearWeather - - Cloudy - - Fog - - Rain - - Snowing - - Snow - - WDR - - Shade - - Night - - Indoor - - Fluorescent - - Incandescent - - Sodium(Natrium) - - Sunrise(Horizon) - - Sunset(Rear) - - ExtremeHot - - ExtremeCold - - Underwater - - CloseUp - - Motion - - FlickerFree50 - - FlickerFree60 - type: string - imaging_Move: - properties: - Focus: - allOf: - - $ref: '#/components/schemas/onvif_FocusMove' - - description: Content of the requested move (focus) operation. - VideoSourceToken: - description: Reference to the VideoSource for the requested move (focus) - operation. - maxLength: 64 - type: string - required: - - VideoSourceToken - - Focus - type: object - imaging_MoveResponse: - type: object - imaging_SetCurrentPreset: - properties: - PresetToken: - description: Reference token to the Imaging Preset to be applied to the - specified Video Source. - maxLength: 64 - type: string - VideoSourceToken: - description: Reference token to the VideoSource to which the specified Imaging - Preset should be applied. - maxLength: 64 - type: string - required: - - VideoSourceToken - - PresetToken - type: object - imaging_SetCurrentPresetResponse: - type: object - imaging_SetImagingSettings: - properties: - ForcePersistence: - type: boolean - ImagingSettings: - $ref: '#/components/schemas/onvif_ImagingSettings20' - VideoSourceToken: - maxLength: 64 - type: string - required: - - VideoSourceToken - - ImagingSettings - type: object - imaging_SetImagingSettingsResponse: - type: object - imaging_Stop: - properties: - VideoSourceToken: - description: Reference token to the VideoSource where the focus movement - should be stopped. - maxLength: 64 - type: string - required: - - VideoSourceToken - type: object - imaging_StopResponse: - type: object - media_AddAudioDecoderConfiguration: - properties: - ConfigurationToken: - description: This element contains a reference to the AudioDecoderConfiguration - to add. - maxLength: 64 - type: string - ProfileToken: - description: This element contains a reference to the profile where the - configuration should be added. - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddAudioDecoderConfigurationResponse: - type: object - media_AddAudioEncoderConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the AudioEncoderConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddAudioEncoderConfigurationResponse: - type: object - media_AddAudioOutputConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the AudioOutputConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddAudioOutputConfigurationResponse: - type: object - media_AddAudioSourceConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the AudioSourceConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddAudioSourceConfigurationResponse: - type: object - media_AddMetadataConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the MetadataConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddMetadataConfigurationResponse: - type: object - media_AddPTZConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the PTZConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddPTZConfigurationResponse: - type: object - media_AddVideoAnalyticsConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the VideoAnalyticsConfiguration to - add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddVideoAnalyticsConfigurationResponse: - type: object - media_AddVideoEncoderConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the VideoEncoderConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddVideoEncoderConfigurationResponse: - type: object - media_AddVideoSourceConfiguration: - properties: - ConfigurationToken: - description: Contains a reference to the VideoSourceConfiguration to add - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken - - ConfigurationToken - type: object - media_AddVideoSourceConfigurationResponse: - type: object - media_Capabilities: - properties: - EXICompression: - description: Indicates the support for the Efficient XML Interchange (EXI) - binary XML format. - type: boolean - OSD: - description: Indicates if OSD is supported. - type: boolean - ProfileCapabilities: - allOf: - - $ref: '#/components/schemas/media_ProfileCapabilities' - - description: Media profile capabilities. - Rotation: - description: Indicates whether or not Rotation feature is supported. - type: boolean - SnapshotUri: - description: Indicates if GetSnapshotUri is supported. - type: boolean - StreamingCapabilities: - allOf: - - $ref: '#/components/schemas/media_StreamingCapabilities' - - description: Streaming capabilities. - TemporaryOSDText: - description: Indicates the support for temporary osd text configuration. - type: boolean - VideoSourceMode: - description: Indicates the support for changing video source mode. - type: boolean - required: - - ProfileCapabilities - - StreamingCapabilities - type: object - media_CreateOSD: - properties: - OSD: - allOf: - - $ref: '#/components/schemas/onvif_OSDConfiguration' - - description: Contain the initial OSD configuration for create. - required: - - OSD - type: object - media_CreateOSDResponse: - properties: - OSDToken: - description: Returns Token of the newly created OSD - maxLength: 64 - type: string - required: - - OSDToken - type: object - media_CreateProfile: - properties: - Name: - description: friendly name of the profile to be created - maxLength: 64 - type: string - Token: - description: Optional token, specifying the unique identifier of the new - profile. - maxLength: 64 - type: string - required: - - Name - type: object - media_CreateProfileResponse: - properties: - Profile: - allOf: - - $ref: '#/components/schemas/onvif_Profile' - - description: returns the new created profile - required: - - Profile - type: object - media_DeleteOSD: - properties: - OSDToken: - description: This element contains a reference to the OSD configuration - that should be deleted. - maxLength: 64 - type: string - required: - - OSDToken - type: object - media_DeleteOSDResponse: - type: object - media_DeleteProfile: - properties: - ProfileToken: - description: This element contains a reference to the profile that should - be deleted. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_DeleteProfileResponse: - type: object - media_GetAudioDecoderConfiguration: - properties: - ConfigurationToken: - description: Token of the requested audio decoder configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object - media_GetAudioDecoderConfigurationOptions: - properties: - ConfigurationToken: - description: Optional audio decoder configuration token that specifies an - existing configuration that the options are intended for. - maxLength: 64 - type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. - maxLength: 64 - type: string - type: object - media_GetAudioDecoderConfigurationOptionsResponse: - properties: - Options: - allOf: - - $ref: '#/components/schemas/onvif_AudioDecoderConfigurationOptions' - - 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. - required: - - Options - type: object - media_GetAudioDecoderConfigurationResponse: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - - description: The requested audio decoder configuration - required: - - Configuration - type: object - media_GetAudioDecoderConfigurations: - type: object - media_GetAudioDecoderConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of audio decoder configurations - items: - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - type: array - type: object - media_GetAudioEncoderConfiguration: - properties: - ConfigurationToken: - description: Token of the requested audio encoder configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object - media_GetAudioEncoderConfigurationOptions: - properties: - ConfigurationToken: - description: Optional audio encoder configuration token that specifies an - existing configuration that the options are intended for. - maxLength: 64 - type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. - maxLength: 64 - type: string - type: object - media_GetAudioEncoderConfigurationOptionsResponse: - properties: - Options: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoderConfigurationOptions' - - 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. - required: - - Options - type: object - media_GetAudioEncoderConfigurationResponse: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' - - description: The requested audio encoder configuration - required: - - Configuration - type: object - media_GetAudioEncoderConfigurations: - type: object - media_GetAudioEncoderConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of audio encoder configurations. - items: - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' - type: array - type: object - media_GetAudioOutputConfiguration: - properties: - ConfigurationToken: - description: Token of the requested audio output configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object - media_GetAudioOutputConfigurationOptions: - properties: - ConfigurationToken: - description: Optional audio output configuration token that specifies an - existing configuration that the options are intended for. - maxLength: 64 - type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. - maxLength: 64 - type: string - type: object - media_GetAudioOutputConfigurationOptionsResponse: - properties: - Options: - allOf: - - $ref: '#/components/schemas/onvif_AudioOutputConfigurationOptions' - - 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. - required: - - Options - type: object - media_GetAudioOutputConfigurationResponse: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' - - description: The requested audio output configuration. - required: - - Configuration - type: object - media_GetAudioOutputConfigurations: - type: object - media_GetAudioOutputConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of audio output configurations - items: - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' - type: array - type: object - media_GetAudioOutputs: - type: object - media_GetAudioOutputsResponse: - properties: - AudioOutputs: - description: List of existing Audio Outputs - items: - $ref: '#/components/schemas/onvif_AudioOutput' - type: array - type: object - media_GetAudioSourceConfiguration: - properties: - ConfigurationToken: - description: Token of the requested audio source configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object - media_GetAudioSourceConfigurationOptions: - properties: - ConfigurationToken: - description: Optional audio source configuration token that specifies an - existing configuration that the options are intended for. - maxLength: 64 - type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. - maxLength: 64 - type: string - type: object - media_GetAudioSourceConfigurationOptionsResponse: - properties: - Options: - allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfigurationOptions' - - 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. - required: - - Options - type: object - media_GetAudioSourceConfigurationResponse: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - - description: The requested audio source configuration. - required: - - Configuration - type: object - media_GetAudioSourceConfigurations: - type: object - media_GetAudioSourceConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of audio source configurations. - items: - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - type: array - type: object - media_GetAudioSources: - type: object - media_GetAudioSourcesResponse: - properties: - AudioSources: - description: List of existing Audio Sources - items: - $ref: '#/components/schemas/onvif_AudioSource' - type: array - type: object - media_GetCompatibleAudioDecoderConfigurations: - properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_GetCompatibleAudioDecoderConfigurationsResponse: - properties: - Configurations: - description: Contains a list of audio decoder configurations that are compatible - with the specified media profile. - items: - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - type: array + Events: + allOf: + - $ref: '#/components/schemas/onvif_EventSubscription' + - 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\t\ + none or some of the events produced by the device:" + Extension: + $ref: '#/components/schemas/onvif_MetadataConfigurationExtension' + GeoLocation: + description: Optional parameter to configure if the metadata stream shall + contain the Geo Location coordinates of each target. + type: boolean + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + PTZStatus: + allOf: + - $ref: '#/components/schemas/onvif_PTZFilter' + - description: optional element to configure which PTZ related data is + to include in the metadata stream + SessionTimeout: + description: The rtsp session timeout for the related audio stream (when + using Media2 Service, this value is deprecated and ignored) + format: date-time + type: string + ShapePolygon: + description: Optional parameter to configure if the generated metadata + stream should contain shape information as polygon. + type: boolean + required: + - Multicast + - SessionTimeout + type: object + onvif_MetadataConfigurationExtension: type: object - media_GetCompatibleAudioEncoderConfigurations: + onvif_MetadataConfigurationOptions: properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string + Extension: + $ref: '#/components/schemas/onvif_MetadataConfigurationOptionsExtension' + GeoLocation: + description: True if the device is able to stream the Geo Located positions + of each target. + type: boolean + MaxContentFilterSize: + description: A device signalling support for content filtering shall support + expressions with the provided expression size. + format: int32 + type: integer + PTZStatusFilterOptions: + $ref: '#/components/schemas/onvif_PTZStatusFilterOptions' required: - - ProfileToken + - PTZStatusFilterOptions type: object - media_GetCompatibleAudioEncoderConfigurationsResponse: + onvif_MetadataConfigurationOptionsExtension: properties: - Configurations: - description: Contains a list of audio encoder configurations that are compatible - with the specified media profile. + CompressionType: + description: List of supported metadata compression type. Its options shall + be chosen from tt:MetadataCompressionType. items: - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + type: string type: array + Extension: + $ref: '#/components/schemas/onvif_MetadataConfigurationOptionsExtension2' + type: object + onvif_MetadataConfigurationOptionsExtension2: type: object - media_GetCompatibleAudioOutputConfigurations: + onvif_MoveStatus: + enum: + - IDLE + - MOVING + - UNKNOWN + type: string + onvif_Mpeg4Configuration: properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string + GovLength: + 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. + format: int32 + type: integer + Mpeg4Profile: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Profile' + - description: the Mpeg4 profile, either simple profile (SP) or advanced + simple profile (ASP) required: - - ProfileToken + - GovLength + - Mpeg4Profile type: object - media_GetCompatibleAudioOutputConfigurationsResponse: + onvif_Mpeg4Options: properties: - Configurations: - description: Contains a list of audio output configurations that are compatible - with the specified media profile. + EncodingIntervalRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported encoding interval range. The encoding interval + corresponds to the number of frames devided by the encoded frames. An + encoding interval value of "1" means that all frames are encoded. + FrameRateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported frame rate in fps (frames per second). + GovLengthRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported group of Video frames length. This value typically + corresponds to the I-Frame distance. + Mpeg4ProfilesSupported: + description: List of supported MPEG-4 profiles. items: - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + $ref: '#/components/schemas/onvif_Mpeg4Profile' type: array - type: object - media_GetCompatibleAudioSourceConfigurations: - properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_GetCompatibleAudioSourceConfigurationsResponse: - properties: - Configurations: - description: Contains a list of audio source configurations that are compatible - with the specified media profile. + ResolutionsAvailable: + description: List of supported image sizes. items: - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + $ref: '#/components/schemas/onvif_VideoResolution' type: array + required: + - ResolutionsAvailable + - GovLengthRange + - FrameRateRange + - EncodingIntervalRange + - Mpeg4ProfilesSupported type: object - media_GetCompatibleMetadataConfigurations: + onvif_Mpeg4Options2: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Options' + - properties: + BitrateRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Supported range of encoded bitrate in kbps. + required: + - BitrateRange + type: object + onvif_Mpeg4Profile: + enum: + - SP + - ASP + type: string + onvif_MulticastConfiguration: properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string + Address: + allOf: + - $ref: '#/components/schemas/onvif_IPAddress' + - description: The multicast address (if this address is set to 0 no multicast + streaming is enaled) + AutoStart: + description: Read only property signalling that streaming is persistant. + Use the methods StartMulticastStreaming and StopMulticastStreaming to + switch its state. + type: boolean + Port: + description: The RTP mutlicast 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. + format: int32 + type: integer + TTL: + 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. + format: int32 + type: integer required: - - ProfileToken + - Address + - Port + - TTL + - AutoStart type: object - media_GetCompatibleMetadataConfigurationsResponse: + onvif_NetworkGateway: properties: - Configurations: - description: Contains a list of metadata configurations that are compatible - with the specified media profile. + IPv4Address: + description: IPv4 address string. items: - $ref: '#/components/schemas/onvif_MetadataConfiguration' + type: string type: array - type: object - media_GetCompatibleVideoAnalyticsConfigurations: - properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_GetCompatibleVideoAnalyticsConfigurationsResponse: - properties: - Configurations: - description: Contains a list of video analytics configurations that are - compatible with the specified media profile. + IPv6Address: + description: IPv6 address string. items: - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + type: string type: array type: object - media_GetCompatibleVideoEncoderConfigurations: + onvif_NetworkInterface: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + Enabled: + description: Indicates whether or not an interface is enabled. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceExtension' + IPv4: + allOf: + - $ref: '#/components/schemas/onvif_IPv4NetworkInterface' + - description: IPv4 network interface configuration. + IPv6: + allOf: + - $ref: '#/components/schemas/onvif_IPv6NetworkInterface' + - description: IPv6 network interface configuration. + Info: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceInfo' + - description: Network interface information + Link: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceLink' + - description: Link configuration. + required: + - Enabled + type: object + onvif_NetworkInterfaceConnectionSetting: properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string + AutoNegotiation: + description: Auto negotiation on/off. + type: boolean + Duplex: + allOf: + - $ref: '#/components/schemas/onvif_Duplex' + - description: Duplex type, Half or Full. + Speed: + description: Speed. + format: int32 + type: integer required: - - ProfileToken + - AutoNegotiation + - Speed + - Duplex type: object - media_GetCompatibleVideoEncoderConfigurationsResponse: + onvif_NetworkInterfaceExtension: properties: - Configurations: - description: Contains a list of video encoder configurations that are compatible - with the specified media profile. + Dot11: items: - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + $ref: '#/components/schemas/onvif_Dot11Configuration' type: array - type: object - media_GetCompatibleVideoSourceConfigurations: - properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_GetCompatibleVideoSourceConfigurationsResponse: - properties: - Configurations: - description: Contains a list of video source configurations that are compatible - with the specified media profile. + Dot3: + description: Extension point prepared for future 802.3 configuration. items: - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + $ref: '#/components/schemas/onvif_Dot3Configuration' type: array - type: object - media_GetGuaranteedNumberOfVideoEncoderInstances: - properties: - ConfigurationToken: - description: Token of the video source configuration - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object - media_GetGuaranteedNumberOfVideoEncoderInstancesResponse: - properties: - H264: - 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. - format: int32 - type: integer - JPEG: - 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. - format: int32 - type: integer - MPEG4: - 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. - format: int32 - type: integer - TotalNumber: - description: The minimum guaranteed total number of encoder instances (applications) - per VideoSourceConfiguration. The device is able to deliver the TotalNumber - of streams + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceExtension2' + InterfaceType: format: int32 type: integer required: - - TotalNumber + - InterfaceType type: object - media_GetMetadataConfiguration: - properties: - ConfigurationToken: - description: Token of the requested metadata configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken + onvif_NetworkInterfaceExtension2: type: object - media_GetMetadataConfigurationOptions: + onvif_NetworkInterfaceInfo: properties: - ConfigurationToken: - description: Optional metadata configuration token that specifies an existing - configuration that the options are intended for. - maxLength: 64 + HwAddress: + description: Network interface MAC address. type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. - maxLength: 64 + MTU: + description: Maximum transmission unit. + format: int32 + type: integer + Name: + description: Network interface name, for example eth0. type: string + required: + - HwAddress type: object - media_GetMetadataConfigurationOptionsResponse: + onvif_NetworkInterfaceLink: properties: - Options: + AdminSettings: allOf: - - $ref: '#/components/schemas/onvif_MetadataConfigurationOptions' - - 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. + - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' + - description: Configured link settings. + InterfaceType: + description: 'Integer indicating interface type, for example: 6 is ethernet.' + format: int32 + type: integer + OperSettings: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' + - description: Current active link settings. required: - - Options + - AdminSettings + - OperSettings + - InterfaceType type: object - media_GetMetadataConfigurationResponse: + onvif_NetworkInterfaceSetConfiguration: properties: - Configuration: + Enabled: + description: Indicates whether or not an interface is enabled. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfigurationExtension' + IPv4: allOf: - - $ref: '#/components/schemas/onvif_MetadataConfiguration' - - description: The requested metadata configuration. - required: - - Configuration - type: object - media_GetMetadataConfigurations: + - $ref: '#/components/schemas/onvif_IPv4NetworkInterfaceSetConfiguration' + - description: IPv4 network interface configuration. + IPv6: + allOf: + - $ref: '#/components/schemas/onvif_IPv6NetworkInterfaceSetConfiguration' + - description: IPv6 network interface configuration. + Link: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceConnectionSetting' + - description: Link configuration. + MTU: + description: Maximum transmission unit. + format: int32 + type: integer type: object - media_GetMetadataConfigurationsResponse: + onvif_NetworkInterfaceSetConfigurationExtension: properties: - Configurations: - description: This element contains a list of metadata configurations + Dot11: items: - $ref: '#/components/schemas/onvif_MetadataConfiguration' + $ref: '#/components/schemas/onvif_Dot11Configuration' + type: array + Dot3: + items: + $ref: '#/components/schemas/onvif_Dot3Configuration' type: array + Extension: + $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfigurationExtension2' + type: object + onvif_NetworkInterfaceSetConfigurationExtension2: type: object - media_GetOSD: + onvif_NetworkProtocol: properties: - OSDToken: - description: The GetOSD command fetches the OSD configuration if the OSD - token is known. - maxLength: 64 - type: string + Enabled: + description: Indicates if the protocol is enabled or not. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkProtocolExtension' + Name: + allOf: + - $ref: '#/components/schemas/onvif_NetworkProtocolType' + - description: Network protocol type string. + Port: + description: The port that is used by the protocol. + items: + format: int32 + type: integer + type: array required: - - OSDToken + - Name + - Enabled + - Port + type: object + onvif_NetworkProtocolExtension: type: object - media_GetOSDOptions: + onvif_NetworkProtocolType: + enum: + - HTTP + - HTTPS + - RTSP + type: string + onvif_NetworkZeroConfiguration: properties: - ConfigurationToken: - description: Video Source Configuration Token that specifies an existing - video source configuration that the options shall be compatible with. + Addresses: + description: The zero-configuration IPv4 address(es) + items: + type: string + type: array + Enabled: + description: Indicates whether the zero-configuration is enabled or not. + type: boolean + Extension: + $ref: '#/components/schemas/onvif_NetworkZeroConfigurationExtension' + InterfaceToken: + description: Unique identifier of network interface. maxLength: 64 type: string required: - - ConfigurationToken + - InterfaceToken + - Enabled type: object - media_GetOSDOptionsResponse: + onvif_NetworkZeroConfigurationExtension: properties: - OSDOptions: - $ref: '#/components/schemas/onvif_OSDConfigurationOptions' - required: - - OSDOptions + Additional: + description: Optional array holding the configuration for the second and + possibly further interfaces. + items: + $ref: '#/components/schemas/onvif_NetworkZeroConfiguration' + type: array + Extension: + $ref: '#/components/schemas/onvif_NetworkZeroConfigurationExtension2' type: object - media_GetOSDResponse: + onvif_NetworkZeroConfigurationExtension2: + type: object + onvif_PTControlDirection: properties: - OSD: + EFlip: allOf: - - $ref: '#/components/schemas/onvif_OSDConfiguration' - - description: The requested OSD configuration. - required: - - OSD + - $ref: '#/components/schemas/onvif_EFlip' + - description: Optional element to configure related parameters for E-Flip. + Extension: + $ref: '#/components/schemas/onvif_PTControlDirectionExtension' + Reverse: + allOf: + - $ref: '#/components/schemas/onvif_Reverse' + - description: Optional element to configure related parameters for reversing + of PT Control Direction. type: object - media_GetOSDs: - properties: - ConfigurationToken: - description: Token of the Video Source Configuration, which has OSDs associated - with are requested. If token not exist, request all available OSDs. - maxLength: 64 - type: string + onvif_PTControlDirectionExtension: type: object - media_GetOSDsResponse: + onvif_PTControlDirectionOptions: properties: - OSDs: - description: This element contains a list of requested OSDs. - items: - $ref: '#/components/schemas/onvif_OSDConfiguration' - type: array + EFlip: + allOf: + - $ref: '#/components/schemas/onvif_EFlipOptions' + - description: Supported options for EFlip feature. + Extension: + $ref: '#/components/schemas/onvif_PTControlDirectionOptionsExtension' + Reverse: + allOf: + - $ref: '#/components/schemas/onvif_ReverseOptions' + - description: Supported options for Reverse feature. type: object - media_GetProfile: - properties: - ProfileToken: - description: this command requests a specific profile - maxLength: 64 - type: string - required: - - ProfileToken + onvif_PTControlDirectionOptionsExtension: type: object - media_GetProfileResponse: + onvif_PTZConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + DefaultAbsolutePantTiltPositionSpace: + description: If the PTZ Node supports absolute Pan/Tilt movements, it + shall specify one Absolute Pan/Tilt Position Space as default. + type: string + DefaultAbsoluteZoomPositionSpace: + description: If the PTZ Node supports absolute zoom movements, it shall + specify one Absolute Zoom Position Space as default. + type: string + DefaultContinuousPanTiltVelocitySpace: + description: If the PTZ Node supports continuous Pan/Tilt movements, it + shall specify one Continuous Pan/Tilt Velocity Space as default. + type: string + DefaultContinuousZoomVelocitySpace: + description: If the PTZ Node supports continuous zoom movements, it shall + specify one Continuous Zoom Velocity Space as default. + type: string + DefaultPTZSpeed: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpeed' + - description: If the PTZ Node supports absolute or relative PTZ movements, + it shall specify corresponding default Pan/Tilt and Zoom speeds. + DefaultPTZTimeout: + description: If the PTZ Node supports continuous movements, it shall specify + a default timeout, after which the movement stops. + format: date-time + type: string + DefaultRelativePanTiltTranslationSpace: + description: If the PTZ Node supports relative Pan/Tilt movements, it + shall specify one RelativePan/Tilt Translation Space as default. + type: string + DefaultRelativeZoomTranslationSpace: + description: If the PTZ Node supports relative zoom movements, it shall + specify one Relative Zoom Translation Space as default. + type: string + Extension: + $ref: '#/components/schemas/onvif_PTZConfigurationExtension' + MoveRamp: + description: The optional acceleration ramp used by the device when moving. + format: int32 + type: integer + NodeToken: + description: A mandatory reference to the PTZ Node that the PTZ Configuration + belongs to. + maxLength: 64 + type: string + PanTiltLimits: + allOf: + - $ref: '#/components/schemas/onvif_PanTiltLimits' + - 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. + PresetRamp: + description: The optional acceleration ramp used by the device when recalling + presets. + format: int32 + type: integer + PresetTourRamp: + description: The optional acceleration ramp used by the device when executing + PresetTours. + format: int32 + type: integer + ZoomLimits: + allOf: + - $ref: '#/components/schemas/onvif_ZoomLimits' + - 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. + required: + - NodeToken + type: object + onvif_PTZConfigurationExtension: properties: - Profile: + Extension: + $ref: '#/components/schemas/onvif_PTZConfigurationExtension2' + PTControlDirection: allOf: - - $ref: '#/components/schemas/onvif_Profile' - - description: returns the requested media profile - required: - - Profile - type: object - media_GetProfiles: - type: object - media_GetProfilesResponse: - properties: - Profiles: - description: lists all profiles that exist in the media service - items: - $ref: '#/components/schemas/onvif_Profile' - type: array + - $ref: '#/components/schemas/onvif_PTControlDirection' + - description: Optional element to configure PT Control Direction related + features. type: object - media_GetServiceCapabilities: + onvif_PTZConfigurationExtension2: type: object - media_GetServiceCapabilitiesResponse: + onvif_PTZConfigurationOptions: properties: - Capabilities: + Extension: + $ref: '#/components/schemas/onvif_PTZConfigurationOptions2' + PTControlDirection: allOf: - - $ref: '#/components/schemas/media_Capabilities' - - description: The capabilities for the media service is returned in the - Capabilities element. - required: - - Capabilities - type: object - media_GetSnapshotUri: - properties: - ProfileToken: - description: The ProfileToken element indicates the media profile to use - and will define the source and dimensions of the snapshot. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_GetSnapshotUriResponse: - properties: - MediaUri: - $ref: '#/components/schemas/onvif_MediaUri' - required: - - MediaUri - type: object - media_GetStreamUri: - properties: - ProfileToken: - description: The ProfileToken element indicates the media profile to use - and will define the configuration of the content of the stream. - maxLength: 64 - type: string - StreamSetup: + - $ref: '#/components/schemas/onvif_PTControlDirectionOptions' + - description: Supported options for PT Direction Control. + PTZRamps: + 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." + format: int32 + type: integer + PTZTimeout: allOf: - - $ref: '#/components/schemas/onvif_StreamSetup' - - description: Stream Setup that should be used with the uri - required: - - StreamSetup - - ProfileToken - type: object - media_GetStreamUriResponse: - properties: - MediaUri: - $ref: '#/components/schemas/onvif_MediaUri' - required: - - MediaUri - type: object - media_GetVideoAnalyticsConfiguration: - properties: - ConfigurationToken: - description: Token of the requested video analytics configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object - media_GetVideoAnalyticsConfigurationResponse: - properties: - Configuration: + - $ref: '#/components/schemas/onvif_DurationRange' + - description: A timeout Range within which Timeouts are accepted by the + PTZ Node. + Spaces: allOf: - - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - - description: The requested video analytics configuration. + - $ref: '#/components/schemas/onvif_PTZSpaces' + - description: A list of supported coordinate systems including their range + limitations. required: - - Configuration - type: object - media_GetVideoAnalyticsConfigurations: + - Spaces + - PTZTimeout type: object - media_GetVideoAnalyticsConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of VideoAnalytics configurations. - items: - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - type: array + onvif_PTZConfigurationOptions2: type: object - media_GetVideoEncoderConfiguration: + onvif_PTZFilter: properties: - ConfigurationToken: - description: Token of the requested video encoder configuration. - maxLength: 64 - type: string + Position: + description: True if the metadata stream shall contain the PTZ position + type: boolean + Status: + description: True if the metadata stream shall contain the PTZ status (IDLE, + MOVING or UNKNOWN) + type: boolean required: - - ConfigurationToken - type: object - media_GetVideoEncoderConfigurationOptions: - properties: - ConfigurationToken: - description: Optional video encoder configuration token that specifies an - existing configuration that the options are intended for. - maxLength: 64 - type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. - maxLength: 64 - type: string + - Status + - Position type: object - media_GetVideoEncoderConfigurationOptionsResponse: + onvif_PTZMoveStatus: properties: - Options: - $ref: '#/components/schemas/onvif_VideoEncoderConfigurationOptions' - required: - - Options + PanTilt: + $ref: '#/components/schemas/onvif_MoveStatus' + Zoom: + $ref: '#/components/schemas/onvif_MoveStatus' type: object - media_GetVideoEncoderConfigurationResponse: + onvif_PTZNode: + allOf: + - $ref: '#/components/schemas/onvif_DeviceEntity' + - properties: + AuxiliaryCommands: + description: A list of supported Auxiliary commands. If the list is not + empty, the Auxiliary Operations MUST be available for this PTZ Node. + items: + maxLength: 128 + type: string + type: array + Extension: + $ref: '#/components/schemas/onvif_PTZNodeExtension' + FixedHomePosition: + description: Indication whether the HomePosition of a Node is fixed or + it can be changed via the SetHomePosition command. + type: boolean + GeoMove: + description: Indication whether the Node supports the geo-referenced move + command. + type: boolean + HomeSupported: + 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. + type: boolean + MaximumNumberOfPresets: + description: All preset operations MUST be available for this PTZ Node + if one preset is supported. + format: int32 + type: integer + Name: + description: A unique identifier that is used to reference PTZ Nodes. + maxLength: 64 + type: string + SupportedPTZSpaces: + allOf: + - $ref: '#/components/schemas/onvif_PTZSpaces' + - description: A list of Coordinate Systems available for the PTZ Node. + For each Coordinate System, the PTZ Node MUST specify its allowed + range. + required: + - SupportedPTZSpaces + - MaximumNumberOfPresets + - HomeSupported + type: object + onvif_PTZNodeExtension: properties: - Configuration: + Extension: + $ref: '#/components/schemas/onvif_PTZNodeExtension2' + SupportedPresetTour: allOf: - - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' - - description: The requested video encoder configuration. - required: - - Configuration - type: object - media_GetVideoEncoderConfigurations: - type: object - media_GetVideoEncoderConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of video encoder configurations. - items: - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' - type: array + - $ref: '#/components/schemas/onvif_PTZPresetTourSupported' + - description: Detail of supported Preset Tour feature. type: object - media_GetVideoSourceConfiguration: - properties: - ConfigurationToken: - description: Token of the requested video source configuration. - maxLength: 64 - type: string - required: - - ConfigurationToken + onvif_PTZNodeExtension2: type: object - media_GetVideoSourceConfigurationOptions: + onvif_PTZPreset: properties: - ConfigurationToken: - description: Optional video source configurationToken that specifies an - existing configuration that the options are intended for. - maxLength: 64 - type: string - ProfileToken: - description: Optional ProfileToken that specifies an existing media profile - that the options shall be compatible with. + Name: + description: A list of preset position name. maxLength: 64 type: string - type: object - media_GetVideoSourceConfigurationOptionsResponse: - properties: - Options: - allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptions' - - 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. - required: - - Options - type: object - media_GetVideoSourceConfigurationResponse: - properties: - Configuration: + PTZPosition: allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - - description: The requested video source configuration. - required: - - Configuration - type: object - media_GetVideoSourceConfigurations: - type: object - media_GetVideoSourceConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of video source configurations. - items: - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - type: array - type: object - media_GetVideoSourceModes: - properties: - VideoSourceToken: - description: Contains a video source reference for which a video source - mode is requested. + - $ref: '#/components/schemas/onvif_PTZVector' + - description: A list of preset position. + token: maxLength: 64 type: string - required: - - VideoSourceToken type: object - media_GetVideoSourceModesResponse: + onvif_PTZPresetTourOperation: + enum: + - Start + - Stop + - Pause + - Extended + type: string + onvif_PTZPresetTourSupported: properties: - VideoSourceModes: - description: Return the information for specified video source mode. + Extension: + $ref: '#/components/schemas/onvif_PTZPresetTourSupportedExtension' + MaximumNumberOfPresetTours: + 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. + format: int32 + type: integer + PTZPresetTourOperation: + description: Indicates which preset tour operations are available for this + PTZ Node. items: - $ref: '#/components/schemas/media_VideoSourceMode' + $ref: '#/components/schemas/onvif_PTZPresetTourOperation' type: array required: - - VideoSourceModes + - MaximumNumberOfPresetTours type: object - media_GetVideoSources: + onvif_PTZPresetTourSupportedExtension: type: object - media_GetVideoSourcesResponse: + onvif_PTZSpaces: properties: - VideoSources: - description: List of existing Video Sources + AbsolutePanTiltPositionSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space2DDescription' + type: array + AbsoluteZoomPositionSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + ContinuousPanTiltVelocitySpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space2DDescription' + type: array + ContinuousZoomVelocitySpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + Extension: + $ref: '#/components/schemas/onvif_PTZSpacesExtension' + PanTiltSpeedSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + RelativePanTiltTranslationSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space2DDescription' + type: array + RelativeZoomTranslationSpace: + 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." + items: + $ref: '#/components/schemas/onvif_Space1DDescription' + type: array + ZoomSpeedSpace: + 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\t\ + In contrast to the velocity spaces, speed spaces do not contain any directional\ + \ information." items: - $ref: '#/components/schemas/onvif_VideoSource' + $ref: '#/components/schemas/onvif_Space1DDescription' type: array type: object - media_ProfileCapabilities: - properties: - MaximumNumberOfProfiles: - description: Maximum number of profiles supported. - format: int32 - type: integer + onvif_PTZSpacesExtension: type: object - media_RemoveAudioDecoderConfiguration: + onvif_PTZSpeed: properties: - ProfileToken: - description: This element contains a reference to the media profile from - which the AudioDecoderConfiguration shall be removed. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_RemoveAudioDecoderConfigurationResponse: + PanTilt: + allOf: + - $ref: '#/components/schemas/onvif_Vector2D' + - 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. + Zoom: + allOf: + - $ref: '#/components/schemas/onvif_Vector1D' + - description: A zoom speed. If omitted in a request, the current (if any) + Zoom movement should not be affected. type: object - media_RemoveAudioEncoderConfiguration: + onvif_PTZStatus: properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - AudioEncoderConfiguration shall be removed." - maxLength: 64 + Error: + description: States a current PTZ error. + type: string + MoveStatus: + allOf: + - $ref: '#/components/schemas/onvif_PTZMoveStatus' + - description: Indicates if the Pan/Tilt/Zoom device unit is currently moving, + idle or in an unknown state. + Position: + allOf: + - $ref: '#/components/schemas/onvif_PTZVector' + - 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. + UtcTime: + description: Specifies the UTC time when this status was generated. + format: date-time type: string required: - - ProfileToken - type: object - media_RemoveAudioEncoderConfigurationResponse: + - UtcTime type: object - media_RemoveAudioOutputConfiguration: + onvif_PTZStatusFilterOptions: properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - AudioOutputConfiguration shall be removed." - maxLength: 64 - type: string + Extension: + $ref: '#/components/schemas/onvif_PTZStatusFilterOptionsExtension' + PanTiltPositionSupported: + description: True if the device is able to stream the pan or tilt position. + type: boolean + PanTiltStatusSupported: + description: True if the device is able to stream pan or tilt status information. + type: boolean + ZoomPositionSupported: + description: True if the device is able to stream zoom position information. + type: boolean + ZoomStatusSupported: + description: True if the device is able to stream zoom status inforamtion. + type: boolean required: - - ProfileToken + - PanTiltStatusSupported + - ZoomStatusSupported type: object - media_RemoveAudioOutputConfigurationResponse: + onvif_PTZStatusFilterOptionsExtension: type: object - media_RemoveAudioSourceConfiguration: + onvif_PTZVector: properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - AudioSourceConfiguration shall be removed." - maxLength: 64 - type: string - required: - - ProfileToken - type: object - media_RemoveAudioSourceConfigurationResponse: + PanTilt: + allOf: + - $ref: '#/components/schemas/onvif_Vector2D' + - description: Pan and tilt position. The x component corresponds to pan + and the y component to tilt. + Zoom: + allOf: + - $ref: '#/components/schemas/onvif_Vector1D' + - description: A zoom position. type: object - media_RemoveMetadataConfiguration: + onvif_PanTiltLimits: properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - MetadataConfiguration shall be removed." - maxLength: 64 - type: string + Range: + allOf: + - $ref: '#/components/schemas/onvif_Space2DDescription' + - description: A range of pan tilt limits. required: - - ProfileToken - type: object - media_RemoveMetadataConfigurationResponse: + - Range type: object - media_RemovePTZConfiguration: + onvif_PrefixedIPv4Address: properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - PTZConfiguration shall be removed." - maxLength: 64 + Address: + description: IPv4 address type: string + PrefixLength: + description: Prefix/submask length + format: int32 + type: integer required: - - ProfileToken - type: object - media_RemovePTZConfigurationResponse: + - Address + - PrefixLength type: object - media_RemoveVideoAnalyticsConfiguration: + onvif_PrefixedIPv6Address: properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - VideoAnalyticsConfiguration shall be removed." - maxLength: 64 + Address: + description: IPv6 address type: string + PrefixLength: + description: Prefix/submask length + format: int32 + type: integer required: - - ProfileToken - type: object - media_RemoveVideoAnalyticsConfigurationResponse: + - Address + - PrefixLength type: object - media_RemoveVideoEncoderConfiguration: + onvif_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." properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - VideoEncoderConfiguration shall be removed." + AudioEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' + - description: Optional configuration of the Audio encoder. + AudioSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + Extension: + allOf: + - $ref: '#/components/schemas/onvif_ProfileExtension' + - description: Extensions defined in ONVIF 2.0 + MetadataConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + Name: + description: User readable name of the profile. maxLength: 64 type: string - required: - - ProfileToken - type: object - media_RemoveVideoEncoderConfigurationResponse: - type: object - media_RemoveVideoSourceConfiguration: - properties: - ProfileToken: - description: "Contains a reference to the media profile from which the\n\ - VideoSourceConfiguration shall be removed." + PTZConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + - description: Optional configuration of the video analytics module and + rule engine. + VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + - description: Optional configuration of the Video encoder. + VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + fixed: + description: A value of true signals that the profile cannot be deleted. + Default is false. + type: boolean + token: + description: Unique identifier of the profile. maxLength: 64 type: string required: - - ProfileToken - type: object - media_RemoveVideoSourceConfigurationResponse: + - token + - Name type: object - media_SetAudioDecoderConfiguration: + onvif_ProfileExtension: properties: - Configuration: + AudioDecoderConfiguration: allOf: - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - - description: Contains the modified audio decoder configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean - required: - - Configuration - - ForcePersistence - type: object - media_SetAudioDecoderConfigurationResponse: - type: object - media_SetAudioEncoderConfiguration: - properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoderConfiguration' - - description: Contains the modified audio encoder configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean - required: - - Configuration - - ForcePersistence - type: object - media_SetAudioEncoderConfigurationResponse: - type: object - media_SetAudioOutputConfiguration: - properties: - Configuration: + - description: Optional configuration of the Audio decoder. + AudioOutputConfiguration: allOf: - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' - - description: Contains the modified audio output configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean - required: - - Configuration - - ForcePersistence + - description: Optional configuration of the Audio output. + Extension: + $ref: '#/components/schemas/onvif_ProfileExtension2' type: object - media_SetAudioOutputConfigurationResponse: + onvif_ProfileExtension2: type: object - media_SetAudioSourceConfiguration: + onvif_ReceiverConfiguration: + description: Describes the configuration of a receiver. properties: - Configuration: + MediaUri: + description: Details of the URI to which the receiver should connect. + type: string + Mode: allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - - description: Contains the modified audio source configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean + - $ref: '#/components/schemas/onvif_ReceiverMode' + - description: 'The following connection modes are defined:' + StreamSetup: + allOf: + - $ref: '#/components/schemas/onvif_StreamSetup' + - description: Stream connection parameters. required: - - Configuration - - ForcePersistence - type: object - media_SetAudioSourceConfigurationResponse: + - Mode + - MediaUri + - StreamSetup type: object - media_SetMetadataConfiguration: + onvif_ReceiverMode: + description: Specifies a receiver connection mode. + enum: + - AutoConnect + - AlwaysConnect + - NeverConnect + - Unknown + type: string + onvif_Reverse: properties: - Configuration: + Mode: allOf: - - $ref: '#/components/schemas/onvif_MetadataConfiguration' - - description: Contains the modified metadata configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean + - $ref: '#/components/schemas/onvif_ReverseMode' + - description: Parameter to enable/disable Reverse feature. required: - - Configuration - - ForcePersistence - type: object - media_SetMetadataConfigurationResponse: + - Mode type: object - media_SetOSD: + onvif_ReverseMode: + enum: + - false + - true + - AUTO + - Extended + type: string + onvif_ReverseOptions: properties: - OSD: - allOf: - - $ref: '#/components/schemas/onvif_OSDConfiguration' - - description: Contains the modified OSD configuration. - required: - - OSD + Extension: + $ref: '#/components/schemas/onvif_ReverseOptionsExtension' + Mode: + description: Options of Reverse mode parameter. + items: + $ref: '#/components/schemas/onvif_ReverseMode' + type: array type: object - media_SetOSDResponse: + onvif_ReverseOptionsExtension: type: object - media_SetSynchronizationPoint: + onvif_Rotate: properties: - ProfileToken: - description: Contains a Profile reference for which a Synchronization Point - is requested. - maxLength: 64 - type: string + Degree: + 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. + format: int32 + type: integer + Extension: + $ref: '#/components/schemas/onvif_RotateExtension' + Mode: + allOf: + - $ref: '#/components/schemas/onvif_RotateMode' + - description: Parameter to enable/disable Rotation feature. required: - - ProfileToken + - Mode type: object - media_SetSynchronizationPointResponse: + onvif_RotateExtension: type: object - media_SetVideoAnalyticsConfiguration: + onvif_RotateMode: + enum: + - false + - true + - AUTO + type: string + onvif_RuleEngineConfiguration: properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - - description: Contains the modified video analytics configuration. The - configuration shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean - required: - - Configuration - - ForcePersistence + Extension: + $ref: '#/components/schemas/onvif_RuleEngineConfigurationExtension' + Rule: + items: + $ref: '#/components/schemas/onvif_Config' + type: array type: object - media_SetVideoAnalyticsConfigurationResponse: + onvif_RuleEngineConfigurationExtension: type: object - media_SetVideoEncoderConfiguration: + onvif_SceneOrientation: properties: - Configuration: + Mode: allOf: - - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' - - description: Contains the modified video encoder configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean + - $ref: '#/components/schemas/onvif_SceneOrientationMode' + - description: Parameter to assign the way the camera determines the scene + orientation. + Orientation: + 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." + type: string required: - - Configuration - - ForcePersistence - type: object - media_SetVideoEncoderConfigurationResponse: + - Mode type: object - media_SetVideoSourceConfiguration: + onvif_SceneOrientationMode: + enum: + - MANUAL + - AUTO + type: string + onvif_Scope: properties: - Configuration: + ScopeDef: allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - - description: Contains the modified video source configuration. The configuration - shall exist in the device. - ForcePersistence: - description: The ForcePersistence element is obsolete and should always - be assumed to be true. - type: boolean + - $ref: '#/components/schemas/onvif_ScopeDefinition' + - description: Indicates if the scope is fixed or configurable. + ScopeItem: + description: Scope item URI. + type: string required: - - Configuration - - ForcePersistence - type: object - media_SetVideoSourceConfigurationResponse: + - ScopeDef + - ScopeItem type: object - media_SetVideoSourceMode: + onvif_ScopeDefinition: + enum: + - Fixed + - Configurable + type: string + onvif_SetDateTimeType: + enum: + - Manual + - NTP + type: string + onvif_SimpleItem: + description: Value name pair as defined by the corresponding description. properties: - VideoSourceModeToken: - description: Indicate video source mode. - maxLength: 64 + Name: + description: Item name. type: string - VideoSourceToken: - description: Contains a video source reference for which a video source - mode is requested. - maxLength: 64 + Value: + description: Item value. The type is defined in the corresponding description. type: string required: - - VideoSourceToken - - VideoSourceModeToken + - Name + - Value type: object - media_SetVideoSourceModeResponse: + onvif_SimpleItemDescription: + description: Description of a simple item. The type must be of cathegory simpleType + (xs:string, xs:integer, xs:float, ...). properties: - Reboot: - description: The response contains information about rebooting after returning - response. When Reboot is set true, a device will reboot automatically - after setting mode. - type: boolean + Name: + description: Item name. Must be unique within a list. + type: string + Type: + type: string required: - - Reboot + - Name + - Type type: object - media_StartMulticastStreaming: + onvif_Space1DDescription: properties: - ProfileToken: - description: Contains the token of the Profile that is used to define the - multicast stream. - maxLength: 64 + URI: + description: A URI of coordinate systems. type: string + XRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: A range of x-axis. required: - - ProfileToken - type: object - media_StartMulticastStreamingResponse: + - URI + - XRange type: object - media_StopMulticastStreaming: + onvif_Space2DDescription: properties: - ProfileToken: - description: Contains the token of the Profile that is used to define the - multicast stream. - maxLength: 64 + URI: + description: A URI of coordinate systems. type: string + XRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: A range of x-axis. + YRange: + allOf: + - $ref: '#/components/schemas/onvif_FloatRange' + - description: A range of y-axis. required: - - ProfileToken - type: object - media_StopMulticastStreamingResponse: + - URI + - XRange + - YRange type: object - media_StreamingCapabilities: + onvif_StreamSetup: properties: - NoRTSPStreaming: - description: Indicates the device does not support live media streaming - via RTSP. - type: boolean - NonAggregateControl: - description: Indicates support for non aggregate RTSP control. - type: boolean - RTPMulticast: - description: Indicates support for RTP multicast. - type: boolean - RTP_RTSP_TCP: - description: Indicates support for RTP/RTSP/TCP. - type: boolean - RTP_TCP: - description: Indicates support for RTP over TCP. - type: boolean + Stream: + allOf: + - $ref: '#/components/schemas/onvif_StreamType' + - description: Defines if a multicast or unicast stream is requested + Transport: + $ref: '#/components/schemas/onvif_Transport' + required: + - Stream + - Transport + type: object + onvif_StreamType: + enum: + - RTP-Unicast + - RTP-Multicast + type: string + onvif_SubscriptionPolicy: type: object - media_VideoSourceMode: + onvif_SupportedAnalyticsModules: properties: - Description: - description: Informative description of this video source mode. This field - should be described in English. - type: string - Enabled: - 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. - type: boolean - Encodings: - description: Indication which encodings are supported for this video source. - The list may contain one or more enumeration values of tt:VideoEncoding. + AnalyticsModuleContentSchemaLocation: + 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." items: type: string type: array + AnalyticsModuleDescription: + items: + $ref: '#/components/schemas/onvif_ConfigDescription' + type: array Extension: - $ref: '#/components/schemas/media_VideoSourceModeExtension' - MaxFramerate: - description: Max frame rate in frames per second for this video source mode. - type: number - MaxResolution: - allOf: - - $ref: '#/components/schemas/onvif_VideoResolution' - - description: Max horizontal and vertical resolution for this video source - mode. - Reboot: - 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. - type: boolean - token: - description: Indicate token for video source mode. - maxLength: 64 - type: string - required: - - token - - MaxFramerate - - MaxResolution - - Encodings - - Reboot + $ref: '#/components/schemas/onvif_SupportedAnalyticsModulesExtension' + Limit: + description: Maximum number of concurrent instances. + format: int32 + type: integer type: object - media_VideoSourceModeExtension: + onvif_SupportedAnalyticsModulesExtension: type: object - media2_AddConfiguration: + onvif_SupportedRules: properties: - Configuration: - 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. + Extension: + $ref: '#/components/schemas/onvif_SupportedRulesExtension' + Limit: + description: Maximum number of concurrent instances. + format: int32 + type: integer + RuleContentSchemaLocation: + description: Lists the location of all schemas that are referenced in the + rules. items: - $ref: '#/components/schemas/media2_ConfigurationRef' + type: string + type: array + RuleDescription: + description: List of rules supported by the Video Analytics configuration.. + items: + $ref: '#/components/schemas/onvif_ConfigDescription' type: array - Name: - description: Optional item. If present updates the Name property of the - profile. - maxLength: 64 - type: string - ProfileToken: - description: Reference to the profile where the configuration should be - added - maxLength: 64 - type: string - required: - - ProfileToken type: object - media2_AddConfigurationResponse: + onvif_SupportedRulesExtension: type: object - media2_Capabilities2: + onvif_SystemDateTime: + description: General date time inforamtion returned by the GetSystemDateTime + method. properties: - Mask: - description: Indicates if Masking is supported. - type: boolean - OSD: - description: Indicates if OSD is supported. - type: boolean - ProfileCapabilities: + DateTimeType: allOf: - - $ref: '#/components/schemas/media2_ProfileCapabilities' - - description: Media profile capabilities. - Rotation: - description: Indicates whether or not Rotation feature is supported. - type: boolean - SnapshotUri: - description: Indicates if GetSnapshotUri is supported. - type: boolean - SourceMask: - 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." + - $ref: '#/components/schemas/onvif_SetDateTimeType' + - description: Indicates if the time is set manully or through NTP. + DaylightSavings: + description: Informative indicator whether daylight savings is currently + on/off. type: boolean - StreamingCapabilities: + Extension: + $ref: '#/components/schemas/onvif_SystemDateTimeExtension' + LocalDateTime: allOf: - - $ref: '#/components/schemas/media2_StreamingCapabilities' - - description: Streaming capabilities. - TemporaryOSDText: - description: Indicates the support for temporary osd text configuration. - type: boolean - VideoSourceMode: - description: Indicates the support for changing video source mode. - type: boolean + - $ref: '#/components/schemas/onvif_DateTime' + - description: Date and time in local format. + TimeZone: + allOf: + - $ref: '#/components/schemas/onvif_TimeZone' + - description: Timezone information in Posix format. + UTCDateTime: + allOf: + - $ref: '#/components/schemas/onvif_DateTime' + - description: Current system date and time in UTC format. This field is + mandatory since version 2.0. required: - - ProfileCapabilities - - StreamingCapabilities + - DateTimeType + - DaylightSavings type: object - media2_ConfigurationEnumeration: - enum: - - All - - VideoSource - - VideoEncoder - - AudioSource - - AudioEncoder - - AudioOutput - - AudioDecoder - - Metadata - - Analytics - - PTZ - - Receiver - type: string - media2_ConfigurationRef: + onvif_SystemDateTimeExtension: + type: object + onvif_Time: properties: - Token: - 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." - maxLength: 64 - type: string - Type: - description: Type of the configuration as defined by tr2:ConfigurationEnumeration. + Hour: + description: Range is 0 to 23. + format: int32 + type: integer + Minute: + description: Range is 0 to 59. + format: int32 + type: integer + Second: + description: Range is 0 to 61 (typically 59). + format: int32 + type: integer + required: + - Hour + - Minute + - Second + type: object + onvif_TimeZone: + description: The TZ format is specified by POSIX, please refer to POSIX 1003.1 + section 8.3 + properties: + TZ: + description: Posix timezone string. type: string required: - - Type + - TZ type: object - media2_ConfigurationSet: - description: A set of media configurations. + onvif_Transport: properties: - Analytics: - allOf: - - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - - description: Optional configuration of the analytics module and rule engine. - AudioDecoder: - allOf: - - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - - description: Optional configuration of the Audio decoder. - AudioEncoder: - allOf: - - $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' - - description: Optional configuration of the Audio encoder. - AudioOutput: - allOf: - - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' - - description: Optional configuration of the Audio output. - AudioSource: - allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - - description: Optional configuration of the Audio input. - Metadata: - allOf: - - $ref: '#/components/schemas/onvif_MetadataConfiguration' - - description: Optional configuration of the metadata stream. - PTZ: - allOf: - - $ref: '#/components/schemas/onvif_PTZConfiguration' - - description: Optional configuration of the pan tilt zoom unit. - Receiver: - allOf: - - $ref: '#/components/schemas/media2_ReceiverConfiguration' - - description: Optional configuration of the Receiver. - VideoEncoder: + Protocol: allOf: - - $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' - - description: Optional configuration of the Video encoder. - VideoSource: + - $ref: '#/components/schemas/onvif_TransportProtocol' + - description: Defines the network protocol for streaming, either UDP=RTP/UDP, + RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP + Tunnel: allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - - description: Optional configuration of the Video input. + - $ref: '#/components/schemas/onvif_Transport' + - description: Optional element to describe further tunnel options. This + element is normally not needed + required: + - Protocol type: object - media2_CreateMask: + onvif_TransportProtocol: + enum: + - UDP + - TCP + - RTSP + - HTTP + type: string + onvif_User: properties: - Mask: + Extension: + $ref: '#/components/schemas/onvif_UserExtension' + Password: + description: Password string. + type: string + UserLevel: allOf: - - $ref: '#/components/schemas/media2_Mask' - - description: Contain the initial mask configuration for create. - required: - - Mask - type: object - media2_CreateMaskResponse: - properties: - Token: - description: Returns Token of the newly created Mask - maxLength: 64 + - $ref: '#/components/schemas/onvif_UserLevel' + - description: User level string. + Username: + description: Username string. type: string required: - - Token + - Username + - UserLevel type: object - media2_CreateOSD: - properties: - OSD: - allOf: - - $ref: '#/components/schemas/onvif_OSDConfiguration' - - description: Contain the initial OSD configuration for create. - required: - - OSD + onvif_UserExtension: type: object - media2_CreateOSDResponse: + onvif_UserLevel: + enum: + - Administrator + - Operator + - User + - Anonymous + - Extended + type: string + onvif_Vector1D: properties: - OSDToken: - description: Returns Token of the newly created OSD - maxLength: 64 + space: + description: 'Zoom coordinate space selector. The following options are + defined:' type: string + x: + type: number required: - - OSDToken + - x type: object - media2_CreateProfile: + onvif_Vector2D: properties: - Configuration: - description: Optional set of configurations to be assigned to the profile. - List entries with tr2:ConfigurationEnumeration value "All" shall be ignored. - items: - $ref: '#/components/schemas/media2_ConfigurationRef' - type: array - Name: - description: friendly name of the profile to be created - maxLength: 64 + space: + description: 'Pan/tilt coordinate space selector. The following options + are defined:' type: string + x: + type: number + y: + type: number required: - - Name + - x + - y type: object - media2_CreateProfileResponse: + onvif_VideoAnalyticsConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + AnalyticsEngineConfiguration: + $ref: '#/components/schemas/onvif_AnalyticsEngineConfiguration' + RuleEngineConfiguration: + $ref: '#/components/schemas/onvif_RuleEngineConfiguration' + required: + - AnalyticsEngineConfiguration + - RuleEngineConfiguration + type: object + onvif_VideoEncoder2Configuration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Encoding: + description: Video Media Subtype for the video format. For definitions + see tt:VideoEncodingMimeNames and + type: string + GovLength: + 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. + format: int32 + type: integer + GuaranteedFrameRate: + 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." + type: boolean + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + Profile: + description: The encoder profile as defined in tt:VideoEncodingProfiles. + type: string + Quality: + description: Relative value for the video quantizers and the quality of + the video. A high value within supported quality range means higher + quality + type: number + RateControl: + allOf: + - $ref: '#/components/schemas/onvif_VideoRateControl2' + - description: Optional element to configure rate control related parameters. + Resolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution2' + - description: Configured video resolution + required: + - Encoding + - Resolution + - Quality + type: object + onvif_VideoEncoderConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Encoding: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoding' + - description: Used video codec, either Jpeg, H.264 or Mpeg4 + GuaranteedFrameRate: + 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." + type: boolean + H264: + allOf: + - $ref: '#/components/schemas/onvif_H264Configuration' + - description: Optional element to configure H.264 related parameters. + MPEG4: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Configuration' + - description: Optional element to configure Mpeg4 related parameters. + Multicast: + allOf: + - $ref: '#/components/schemas/onvif_MulticastConfiguration' + - description: Defines the multicast settings that could be used for video + streaming. + Quality: + description: Relative value for the video quantizers and the quality of + the video. A high value within supported quality range means higher + quality + type: number + RateControl: + allOf: + - $ref: '#/components/schemas/onvif_VideoRateControl' + - description: Optional element to configure rate control related parameters. + Resolution: + allOf: + - $ref: '#/components/schemas/onvif_VideoResolution' + - description: Configured video resolution + SessionTimeout: + description: The rtsp session timeout for the related video stream + format: date-time + type: string + required: + - Encoding + - Resolution + - Quality + - Multicast + - SessionTimeout + type: object + onvif_VideoEncoderConfigurationOptions: properties: - Token: - description: Token assigned by the device for the newly created profile. - maxLength: 64 - type: string + Extension: + $ref: '#/components/schemas/onvif_VideoEncoderOptionsExtension' + GuaranteedFrameRateSupported: + description: Indicates the support for the GuaranteedFrameRate attribute + on the VideoEncoderConfiguration element. + type: boolean + H264: + allOf: + - $ref: '#/components/schemas/onvif_H264Options' + - description: Optional H.264 encoder settings ranges (See also Extension + element). + JPEG: + allOf: + - $ref: '#/components/schemas/onvif_JpegOptions' + - description: Optional JPEG encoder settings ranges (See also Extension + element). + MPEG4: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Options' + - description: Optional MPEG-4 encoder settings ranges (See also Extension + element). + QualityRange: + allOf: + - $ref: '#/components/schemas/onvif_IntRange' + - description: Range of the quality values. A high value means higher quality. required: - - Token + - QualityRange type: object - media2_DeleteMask: + onvif_VideoEncoderOptionsExtension: properties: - Token: - description: This element contains a reference to the Mask configuration - that should be deleted. - maxLength: 64 - type: string - required: - - Token + Extension: + $ref: '#/components/schemas/onvif_VideoEncoderOptionsExtension2' + H264: + allOf: + - $ref: '#/components/schemas/onvif_H264Options2' + - description: Optional H.264 encoder settings ranges. + JPEG: + allOf: + - $ref: '#/components/schemas/onvif_JpegOptions2' + - description: Optional JPEG encoder settings ranges. + MPEG4: + allOf: + - $ref: '#/components/schemas/onvif_Mpeg4Options2' + - description: Optional MPEG-4 encoder settings ranges. type: object - media2_DeleteOSD: + onvif_VideoEncoderOptionsExtension2: + type: object + onvif_VideoEncoding: + enum: + - JPEG + - MPEG4 + - H264 + type: string + onvif_VideoRateControl: properties: - OSDToken: - description: This element contains a reference to the OSD configuration - that should be deleted. - maxLength: 64 - type: string + BitrateLimit: + description: the maximum output bitrate in kbps + format: int32 + type: integer + EncodingInterval: + 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 ...) + format: int32 + type: integer + FrameRateLimit: + description: Maximum output framerate in fps. If an EncodingInterval is + provided the resulting encoded framerate will be reduced by the given + factor. + format: int32 + type: integer required: - - OSDToken + - FrameRateLimit + - EncodingInterval + - BitrateLimit type: object - media2_DeleteProfile: + onvif_VideoRateControl2: properties: - Token: - description: This element contains a reference to the profile that should - be deleted. - maxLength: 64 - type: string + BitrateLimit: + description: the maximum output bitrate in kbps + format: int32 + type: integer + ConstantBitRate: + description: Enforce constant bitrate. + type: boolean + FrameRateLimit: + description: Desired frame rate in fps. The actual rate may be lower due + to e.g. performance limitations. + type: number required: - - Token - type: object - media2_DeleteProfileResponse: + - FrameRateLimit + - BitrateLimit type: object - media2_EncoderInstance: + onvif_VideoResolution: properties: - Encoding: - description: Video Media Subtype for the video format. For definitions see - tt:VideoEncodingMimeNames and - type: string - Number: - description: The minimum guaranteed number of encoder instances (applications) - for the VideoSourceConfiguration. + Height: + description: Number of the lines of the Video image. + format: int32 + type: integer + Width: + description: Number of the columns of the Video image. format: int32 type: integer required: - - Encoding - - Number + - Width + - Height type: object - media2_EncoderInstanceInfo: + onvif_VideoResolution2: properties: - Codec: - 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. - items: - $ref: '#/components/schemas/media2_EncoderInstance' - type: array - Total: - description: The minimum guaranteed total number of encoder instances (applications) - per VideoSourceConfiguration. The device is able to deliver the Total - number of streams + Height: + description: Number of the lines of the Video image. + format: int32 + type: integer + Width: + description: Number of the columns of the Video image. format: int32 type: integer required: - - Total + - Width + - Height type: object - media2_GetAnalyticsConfigurationsResponse: + onvif_VideoSourceConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ConfigurationEntity' + - properties: + Bounds: + allOf: + - $ref: '#/components/schemas/onvif_IntRectangle' + - description: Rectangle specifying the Video capturing area. The capturing + area shall not be larger than the whole Video source area. + Extension: + $ref: '#/components/schemas/onvif_VideoSourceConfigurationExtension' + SourceToken: + description: Reference to the physical input. + maxLength: 64 + type: string + ViewMode: + description: Readonly parameter signalling Source configuration's view + mode, for devices supporting different view modes as defined in tt:viewModes. + type: string + required: + - SourceToken + - Bounds + type: object + onvif_VideoSourceConfigurationExtension: properties: - Configurations: - description: This element contains a list of Analytics configurations. - items: - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' - type: array + Extension: + $ref: '#/components/schemas/onvif_VideoSourceConfigurationExtension2' + Rotate: + allOf: + - $ref: '#/components/schemas/onvif_Rotate' + - 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." type: object - media2_GetAudioDecoderConfigurationOptionsResponse: + onvif_VideoSourceConfigurationExtension2: properties: - Options: - 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. + LensDescription: + description: Optional element describing the geometric lens distortion. + Multiple instances for future variable lens support. items: - $ref: '#/components/schemas/onvif_AudioEncoder2ConfigurationOptions' + $ref: '#/components/schemas/onvif_LensDescription' type: array + SceneOrientation: + allOf: + - $ref: '#/components/schemas/onvif_SceneOrientation' + - description: Optional element describing the scene orientation in the + camera’s field of view. + type: object + onvif_ZoomLimits: + properties: + Range: + allOf: + - $ref: '#/components/schemas/onvif_Space1DDescription' + - description: A range of zoom limit required: - - Options + - Range type: object - media2_GetAudioDecoderConfigurationsResponse: + soapenv_subcode: properties: - Configurations: - description: This element contains a list of audio decoder configurations - items: - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - type: array + Subcode: + $ref: '#/components/schemas/soapenv_subcode' + Value: + type: string + required: + - Value + type: object + wsnt_AbsoluteOrRelativeTimeType: + oneOf: + - type: string + - type: string + wsnt_FilterType: + type: object + wstop_Documentation: type: object - media2_GetAudioEncoderConfigurationOptionsResponse: + wstop_ExtensibleDocumented: properties: - Options: - 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. + documentation: + $ref: '#/components/schemas/wstop_Documentation' + type: object + wstop_TopicSetType: + allOf: + - $ref: '#/components/schemas/wstop_ExtensibleDocumented' + - type: object + device_AddScopes: + properties: + ScopeItem: + description: Contains a list of new configurable scope parameters that will + be added to the existing configurable scope. items: - $ref: '#/components/schemas/onvif_AudioEncoder2ConfigurationOptions' + type: string type: array required: - - Options + - ScopeItem type: object - media2_GetAudioEncoderConfigurationsResponse: + device_CreateUsers: properties: - Configurations: - description: This element contains a list of audio encoder configurations. + User: + 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.' items: - $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' + $ref: '#/components/schemas/onvif_User' type: array - type: object - media2_GetAudioOutputConfigurationOptionsResponse: - properties: - Options: - allOf: - - $ref: '#/components/schemas/onvif_AudioOutputConfigurationOptions' - - 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. required: - - Options + - User type: object - media2_GetAudioOutputConfigurationsResponse: + device_DeleteUsers: properties: - Configurations: - description: This element contains a list of audio output configurations + Username: + 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. items: - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + type: string type: array + required: + - Username type: object - media2_GetAudioSourceConfigurationOptionsResponse: + device_GetDNSResponse: properties: - Options: + DNSInformation: allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfigurationOptions' - - 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. + - $ref: '#/components/schemas/onvif_DNSInformation' + - description: DNS information. required: - - Options - type: object - media2_GetAudioSourceConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of audio source configurations. - items: - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - type: array + - DNSInformation type: object - media2_GetConfiguration: + device_GetDeviceInformationResponse: properties: - ConfigurationToken: - description: Token of the requested configuration. - maxLength: 64 + FirmwareVersion: + description: The firmware version in the device. type: string - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 + HardwareId: + description: The hardware ID of the device. type: string - type: object - media2_GetMaskOptions: - properties: - ConfigurationToken: - description: Video Source Configuration Token that specifies an existing - video source configuration that the options shall be compatible with. - maxLength: 64 + Manufacturer: + description: The manufactor of the device. + type: string + Model: + description: The device model. + type: string + SerialNumber: + description: The serial number of the device. type: string required: - - ConfigurationToken + - Manufacturer + - Model + - FirmwareVersion + - SerialNumber + - HardwareId type: object - media2_GetMaskOptionsResponse: + device_GetDiscoveryModeResponse: properties: - Options: - $ref: '#/components/schemas/media2_MaskOptions' + DiscoveryMode: + allOf: + - $ref: '#/components/schemas/onvif_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' required: - - Options - type: object - media2_GetMasks: - properties: - ConfigurationToken: - description: Optional token of a Video Source Configuration. - maxLength: 64 - type: string - Token: - description: Optional mask token of an existing mask. - maxLength: 64 - type: string + - DiscoveryMode type: object - media2_GetMasksResponse: + device_GetHostnameResponse: properties: - Masks: - description: List of Mask configurations. - items: - $ref: '#/components/schemas/media2_Mask' - type: array + HostnameInformation: + allOf: + - $ref: '#/components/schemas/onvif_HostnameInformation' + - description: Contains the hostname information. + required: + - HostnameInformation type: object - media2_GetMetadataConfigurationOptionsResponse: + device_GetNetworkDefaultGatewayResponse: properties: - Options: + NetworkGateway: allOf: - - $ref: '#/components/schemas/onvif_MetadataConfigurationOptions' - - 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. + - $ref: '#/components/schemas/onvif_NetworkGateway' + - description: Gets the default IPv4 and IPv6 gateway settings from the + device. required: - - Options + - NetworkGateway type: object - media2_GetMetadataConfigurationsResponse: + device_GetNetworkInterfacesResponse: properties: - Configurations: - description: This element contains a list of metadata configurations + NetworkInterfaces: + description: List of network interfaces. items: - $ref: '#/components/schemas/onvif_MetadataConfiguration' + $ref: '#/components/schemas/onvif_NetworkInterface' type: array + required: + - NetworkInterfaces type: object - media2_GetOSDOptions: + device_GetNetworkProtocolsResponse: properties: - ConfigurationToken: - description: Video Source Configuration Token that specifies an existing - video source configuration that the options shall be compatible with. - maxLength: 64 - type: string - required: - - ConfigurationToken + NetworkProtocols: + 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.' + items: + $ref: '#/components/schemas/onvif_NetworkProtocol' + type: array type: object - media2_GetOSDOptionsResponse: + device_GetScopesResponse: properties: - OSDOptions: - $ref: '#/components/schemas/onvif_OSDConfigurationOptions' + Scopes: + 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.' + items: + $ref: '#/components/schemas/onvif_Scope' + type: array required: - - OSDOptions + - Scopes type: object - media2_GetOSDs: + device_GetSystemDateAndTimeResponse: properties: - ConfigurationToken: - description: Token of the Video Source Configuration, which has OSDs associated - with are requested. If token not exist, request all available OSDs. - maxLength: 64 - type: string - OSDToken: - description: The GetOSDs command fetches the OSD configuration if the OSD - token is known. - maxLength: 64 - type: string + SystemDateAndTime: + allOf: + - $ref: '#/components/schemas/onvif_SystemDateTime' + - 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. + required: + - SystemDateAndTime type: object - media2_GetOSDsResponse: + device_GetUsersResponse: properties: - OSDs: - description: This element contains a list of requested OSDs. + User: + description: 'Contains a list of the onvif users and following information + is included in each entry: username and user level.' items: - $ref: '#/components/schemas/onvif_OSDConfiguration' + $ref: '#/components/schemas/onvif_User' type: array type: object - media2_GetProfiles: + device_RemoveScopes: properties: - Token: - description: Optional token of the requested profile. - maxLength: 64 - type: string - Type: - description: The types shall be provided as defined by tr2:ConfigurationEnumeration. + ScopeItem: + description: Contains a list of URIs that should be removed from the device + scope. items: type: string type: array + required: + - ScopeItem type: object - media2_GetProfilesResponse: + device_SetDNS: properties: - Profiles: - 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." + DNSManual: + description: DNS address(es) set manually. items: - $ref: '#/components/schemas/media2_MediaProfile' + $ref: '#/components/schemas/onvif_IPAddress' type: array + FromDHCP: + description: Indicate if the DNS address is to be retrieved using DHCP. + type: boolean + SearchDomain: + description: DNS search domain. + items: + type: string + type: array + required: + - FromDHCP type: object - media2_GetServiceCapabilities: - type: object - media2_GetServiceCapabilitiesResponse: + device_SetDiscoveryMode: properties: - Capabilities: + DiscoveryMode: allOf: - - $ref: '#/components/schemas/media2_Capabilities2' - - description: The capabilities for the media service is returned in the - Capabilities element. + - $ref: '#/components/schemas/onvif_DiscoveryMode' + - description: 'Indicator of discovery mode: Discoverable, NonDiscoverable.' required: - - Capabilities + - DiscoveryMode type: object - media2_GetSnapshotUri: + device_SetHostname: properties: - ProfileToken: - description: The ProfileToken element indicates the media profile to use - and will define the source and dimensions of the snapshot. - maxLength: 64 + Name: + description: The hostname to set. type: string required: - - ProfileToken + - Name type: object - media2_GetSnapshotUriResponse: + device_SetNetworkDefaultGateway: properties: - Uri: - description: Stable Uri to be used for requesting snapshot images. - type: string - required: - - Uri + IPv4Address: + description: Sets IPv4 gateway address used as default setting. + items: + type: string + type: array + IPv6Address: + description: Sets IPv6 gateway address used as default setting. + items: + type: string + type: array type: object - media2_GetStreamUri: + device_SetNetworkInterfaces: properties: - ProfileToken: - description: The ProfileToken element indicates the media profile to use - and will define the configuration of the content of the stream. + InterfaceToken: + description: Symbolic network interface name. maxLength: 64 type: string - Protocol: - description: Defines the network protocol for streaming as defined by tr2:TransportProtocol - type: string - required: - - Protocol - - ProfileToken - type: object - media2_GetStreamUriResponse: - properties: - Uri: - description: Stable Uri to be used for requesting the media stream - type: string + NetworkInterface: + allOf: + - $ref: '#/components/schemas/onvif_NetworkInterfaceSetConfiguration' + - description: Network interface name. required: - - Uri + - InterfaceToken + - NetworkInterface type: object - media2_GetVideoEncoderConfigurationOptionsResponse: + device_SetNetworkProtocols: properties: - Options: + NetworkProtocols: + 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.' items: - $ref: '#/components/schemas/onvif_VideoEncoder2ConfigurationOptions' + $ref: '#/components/schemas/onvif_NetworkProtocol' type: array required: - - Options + - NetworkProtocols type: object - media2_GetVideoEncoderConfigurationsResponse: + device_SetScopes: properties: - Configurations: - description: This element contains a list of video encoder configurations. + Scopes: + description: Contains a list of scope parameters that will replace all existing + configurable scope parameters. items: - $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' + type: string type: array - type: object - media2_GetVideoEncoderInstances: - properties: - ConfigurationToken: - description: Token of the video source configuration - maxLength: 64 - type: string required: - - ConfigurationToken + - Scopes type: object - media2_GetVideoEncoderInstancesResponse: + device_SetSystemDateAndTime: properties: - Info: + DateTimeType: allOf: - - $ref: '#/components/schemas/media2_EncoderInstanceInfo' - - description: The minimum guaranteed total number of encoder instances - (applications) per VideoSourceConfiguration. - required: - - Info - type: object - media2_GetVideoSourceConfigurationOptionsResponse: - properties: - Options: + - $ref: '#/components/schemas/onvif_SetDateTimeType' + - description: Defines if the date and time is set via NTP or manually. + DaylightSavings: + description: Automatically adjust Daylight savings if defined in TimeZone. + type: boolean + TimeZone: allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfigurationOptions' - - 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. + - $ref: '#/components/schemas/onvif_TimeZone' + - description: The time zone in POSIX 1003.1 format + UTCDateTime: + allOf: + - $ref: '#/components/schemas/onvif_DateTime' + - description: Date and time in UTC. If time is obtained via NTP, UTCDateTime + has no meaning required: - - Options - type: object - media2_GetVideoSourceConfigurationsResponse: - properties: - Configurations: - description: This element contains a list of video source configurations. - items: - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - type: array + - DateTimeType + - DaylightSavings type: object - media2_GetVideoSourceModes: + device_SetSystemFactoryDefault: properties: - VideoSourceToken: - description: Contains a video source reference for which a video source - mode is requested. - maxLength: 64 - type: string + FactoryDefault: + allOf: + - $ref: '#/components/schemas/onvif_FactoryDefaultType' + - description: Specifies the factory default action type. required: - - VideoSourceToken + - FactoryDefault type: object - media2_GetVideoSourceModesResponse: + device_SetUser: properties: - VideoSourceModes: - description: Return the information for specified video source mode. + User: + 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. items: - $ref: '#/components/schemas/media2_VideoSourceMode' + $ref: '#/components/schemas/onvif_User' type: array required: - - VideoSourceModes + - User type: object - media2_Mask: - properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_Color' - - description: Color of the masked area. - ConfigurationToken: - description: Token of the VideoSourceConfiguration the Mask is associated - with. - maxLength: 64 - type: string - Enabled: - description: If set the mask will cover the image, otherwise it will be - fully transparent. - type: boolean - Polygon: - allOf: - - $ref: '#/components/schemas/onvif_Polygon' - - description: Geometric representation of the mask area. - Type: - description: 'Type of masking as defined by tr2:MaskType:' - type: string - token: - description: Token of the mask. - maxLength: 64 - type: string - required: - - ConfigurationToken - - Polygon - - Type - - Enabled + device_SystemReboot: type: object - media2_MaskOptions: + event_GetEventPropertiesResponse: properties: - Color: - allOf: - - $ref: '#/components/schemas/onvif_ColorOptions' - - description: Colors supported. - MaxMasks: - description: Maximum supported number of masks per VideoSourceConfiguration. - format: int32 - type: integer - MaxPoints: - description: Maximum supported number of points per mask. - format: int32 - type: integer - RectangleOnly: - description: Information whether the polygon must have four points and a - rectangular shape. - type: boolean - SingleColorOnly: - 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. + FixedTopicSet: + description: True when topicset is fixed for all times. type: boolean - Types: - description: Information which types of tr2:MaskType are supported. Valid - values are 'Color', 'Pixelated' and 'Blurred'. + MessageContentFilterDialect: + description: Defines the XPath function set supported for message content + filtering. + items: + type: string + type: array + MessageContentSchemaLocation: + 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." + items: + type: string + type: array + ProducerPropertiesFilterDialect: + description: Optional ProducerPropertiesDialects. Refer to + items: + type: string + type: array + TopicExpressionDialect: + description: Defines the XPath expression syntax supported for matching + topic expressions. + items: + type: string + type: array + TopicNamespaceLocation: + description: List of topic namespaces supported. items: type: string type: array + TopicSet: + allOf: + - $ref: '#/components/schemas/wstop_TopicSetType' + - description: Set of topics supported. required: - - MaxMasks - - MaxPoints - - Types - - Color + - TopicNamespaceLocation + - FixedTopicSet + - TopicSet + - TopicExpressionDialect + - MessageContentFilterDialect + - MessageContentSchemaLocation type: object - media2_MaskType: - enum: - - Color - - Pixelated - - Blurred - type: string - media2_MediaProfile: - description: A media profile consists of a set of media configurations. + media_AddMetadataConfiguration: properties: - Configurations: - allOf: - - $ref: '#/components/schemas/media2_ConfigurationSet' - - description: The configurations assigned to the profile. - Name: - description: User readable name of the profile. - maxLength: 64 - type: string - fixed: - description: A value of true signals that the profile cannot be deleted. - Default is false. - type: boolean - token: - description: Unique identifier of the profile. + ConfigurationToken: + description: Contains a reference to the MetadataConfiguration to add + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added maxLength: 64 type: string required: - - token - - Name + - ProfileToken + - ConfigurationToken type: object - media2_ProfileCapabilities: + media_AddPTZConfiguration: properties: - ConfigurationsSupported: - description: The configurations supported by the device as defined by tr2:ConfigurationEnumeration. - The enumeration value "All" shall not be included in this list. + ConfigurationToken: + description: Contains a reference to the PTZConfiguration to add + maxLength: 64 type: string - MaximumNumberOfProfiles: - description: Maximum number of profiles supported. - format: int32 - type: integer - type: object - media2_ReceiverConfiguration: - allOf: - - $ref: '#/components/schemas/onvif_ReceiverConfiguration' - - properties: - token: - maxLength: 64 - type: string - type: object - media2_RemoveConfiguration: - properties: - Configuration: - 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. - items: - $ref: '#/components/schemas/media2_ConfigurationRef' - type: array ProfileToken: - description: This element contains a reference to the media profile from - which the AudioDecoderConfiguration shall be removed. + description: Reference to the profile where the configuration should be + added maxLength: 64 type: string required: - ProfileToken - - Configuration + - ConfigurationToken type: object - media2_RemoveConfigurationResponse: + media_GetCompatibleMetadataConfigurationsResponse: + properties: + Configurations: + description: Contains a list of metadata configurations that are compatible + with the specified media profile. + items: + $ref: '#/components/schemas/onvif_MetadataConfiguration' + type: array type: object - media2_SetAudioDecoderConfiguration: + media_GetMetadataConfigurationOptionsResponse: properties: - Configuration: + Options: allOf: - - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' - - description: Contains the modified audio decoder configuration. The configuration - shall exist in the device. + - $ref: '#/components/schemas/onvif_MetadataConfigurationOptions' + - 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. required: - - Configuration + - Options type: object - media2_SetAudioEncoderConfiguration: + media_GetMetadataConfigurationResponse: properties: Configuration: allOf: - - $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' - - description: Contains the modified audio encoder configuration. The configuration - shall exist in the device. + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: The requested metadata configuration. required: - Configuration type: object - media2_SetAudioOutputConfiguration: + media_GetMetadataConfigurationsResponse: properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' - - description: Contains the modified audio output configuration. The configuration - shall exist in the device. - required: - - Configuration + Configurations: + description: This element contains a list of metadata configurations + items: + $ref: '#/components/schemas/onvif_MetadataConfiguration' + type: array + type: object + media_GetProfilesResponse: + properties: + Profiles: + description: lists all profiles that exist in the media service + items: + $ref: '#/components/schemas/onvif_Profile' + type: array type: object - media2_SetAudioSourceConfiguration: + media_GetStreamUriResponse: properties: - Configuration: - allOf: - - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' - - description: Contains the modified audio source configuration. The configuration - shall exist in the device. + MediaUri: + $ref: '#/components/schemas/onvif_MediaUri' required: - - Configuration - type: object - media2_SetConfigurationResponse: + - MediaUri type: object - media2_SetMask: + media_GetVideoEncoderConfigurationOptionsResponse: properties: - Mask: - allOf: - - $ref: '#/components/schemas/media2_Mask' - - description: Mask to be updated. + Options: + $ref: '#/components/schemas/onvif_VideoEncoderConfigurationOptions' required: - - Mask + - Options type: object - media2_SetMetadataConfiguration: + media_GetVideoEncoderConfigurationResponse: properties: Configuration: allOf: - - $ref: '#/components/schemas/onvif_MetadataConfiguration' - - description: Contains the modified metadata configuration. The configuration - shall exist in the device. + - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + - description: The requested video encoder configuration. required: - Configuration type: object - media2_SetOSD: + media_GetVideoEncoderConfigurationsResponse: properties: - OSD: - allOf: - - $ref: '#/components/schemas/onvif_OSDConfiguration' - - description: Contains the modified OSD configuration. - required: - - OSD + Configurations: + description: This element contains a list of video encoder configurations. + items: + $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + type: array type: object - media2_SetSynchronizationPoint: + media_RemoveMetadataConfiguration: properties: ProfileToken: - description: Contains a Profile reference for which a Synchronization Point - is requested. + description: "Contains a reference to the media profile from which the\n\ + MetadataConfiguration shall be removed." maxLength: 64 type: string required: - ProfileToken type: object - media2_SetSynchronizationPointResponse: + media_RemovePTZConfiguration: + properties: + ProfileToken: + description: "Contains a reference to the media profile from which the\n\ + PTZConfiguration shall be removed." + maxLength: 64 + type: string + required: + - ProfileToken type: object - media2_SetVideoEncoderConfiguration: + media_SetMetadataConfiguration: properties: Configuration: allOf: - - $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' - - description: Contains the modified video encoder configuration. The configuration + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Contains the modified metadata configuration. The configuration shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean required: - Configuration + - ForcePersistence type: object - media2_SetVideoSourceConfiguration: + media_SetVideoEncoderConfiguration: properties: Configuration: allOf: - - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' - - description: Contains the modified video source configuration. The configuration + - $ref: '#/components/schemas/onvif_VideoEncoderConfiguration' + - description: Contains the modified video encoder configuration. The configuration shall exist in the device. + ForcePersistence: + description: The ForcePersistence element is obsolete and should always + be assumed to be true. + type: boolean required: - Configuration + - ForcePersistence + type: object + media2_AddConfiguration: + properties: + Configuration: + 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. + items: + $ref: '#/components/schemas/media2_ConfigurationRef' + type: array + Name: + description: Optional item. If present updates the Name property of the + profile. + maxLength: 64 + type: string + ProfileToken: + description: Reference to the profile where the configuration should be + added + maxLength: 64 + type: string + required: + - ProfileToken type: object - media2_SetVideoSourceMode: + media2_ConfigurationRef: properties: - VideoSourceModeToken: - description: Indicate video source mode. + Token: + 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." maxLength: 64 type: string - VideoSourceToken: - description: Contains a video source reference for which a video source - mode is requested. + Type: + description: Type of the configuration as defined by tr2:ConfigurationEnumeration. + type: string + required: + - Type + type: object + media2_ConfigurationSet: + description: A set of media configurations. + properties: + Analytics: + allOf: + - $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + - description: Optional configuration of the analytics module and rule engine. + AudioDecoder: + allOf: + - $ref: '#/components/schemas/onvif_AudioDecoderConfiguration' + - description: Optional configuration of the Audio decoder. + AudioEncoder: + allOf: + - $ref: '#/components/schemas/onvif_AudioEncoder2Configuration' + - description: Optional configuration of the Audio encoder. + AudioOutput: + allOf: + - $ref: '#/components/schemas/onvif_AudioOutputConfiguration' + - description: Optional configuration of the Audio output. + AudioSource: + allOf: + - $ref: '#/components/schemas/onvif_AudioSourceConfiguration' + - description: Optional configuration of the Audio input. + Metadata: + allOf: + - $ref: '#/components/schemas/onvif_MetadataConfiguration' + - description: Optional configuration of the metadata stream. + PTZ: + allOf: + - $ref: '#/components/schemas/onvif_PTZConfiguration' + - description: Optional configuration of the pan tilt zoom unit. + Receiver: + allOf: + - $ref: '#/components/schemas/media2_ReceiverConfiguration' + - description: Optional configuration of the Receiver. + VideoEncoder: + allOf: + - $ref: '#/components/schemas/onvif_VideoEncoder2Configuration' + - description: Optional configuration of the Video encoder. + VideoSource: + allOf: + - $ref: '#/components/schemas/onvif_VideoSourceConfiguration' + - description: Optional configuration of the Video input. + type: object + media2_GetAnalyticsConfigurationsResponse: + properties: + Configurations: + description: This element contains a list of Analytics configurations. + items: + $ref: '#/components/schemas/onvif_VideoAnalyticsConfiguration' + type: array + type: object + media2_GetProfilesResponse: + properties: + Profiles: + 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." + items: + $ref: '#/components/schemas/media2_MediaProfile' + type: array + type: object + media2_MediaProfile: + description: A media profile consists of a set of media configurations. + properties: + Configurations: + allOf: + - $ref: '#/components/schemas/media2_ConfigurationSet' + - description: The configurations assigned to the profile. + Name: + description: User readable name of the profile. maxLength: 64 type: string - required: - - VideoSourceToken - - VideoSourceModeToken - type: object - media2_SetVideoSourceModeResponse: - properties: - Reboot: - description: The response contains information about rebooting after returning - response. When Reboot is set true, a device will reboot automatically - after setting mode. + fixed: + description: A value of true signals that the profile cannot be deleted. + Default is false. type: boolean - required: - - Reboot - type: object - media2_StartStopMulticastStreaming: - properties: - ProfileToken: - description: Contains the token of the Profile that is used to define the - multicast stream. + token: + description: Unique identifier of the profile. maxLength: 64 type: string required: - - ProfileToken - type: object - media2_StreamingCapabilities: - properties: - AutoStartMulticast: - description: Indicates support for non-RTSP controlled multicast streaming. - type: boolean - NonAggregateControl: - description: Indicates support for non aggregate RTSP control. - type: boolean - RTPMulticast: - description: Indicates support for RTP multicast. - type: boolean - RTP_RTSP_TCP: - description: Indicates support for RTP/RTSP/TCP. - type: boolean - RTSPStreaming: - description: Indicates support for live media streaming via RTSP. - type: boolean - RTSPWebSocketUri: - description: If streaming over WebSocket is supported, this shall return - the RTSP WebSocket URI as described in Streaming Specification Section - 5.1.1.5. - type: string + - token + - Name type: object - media2_TransportProtocol: - enum: - - RtspUnicast - - RtspMulticast - - RTSP - - RtspOverHttp - type: string - media2_VideoSourceMode: + media2_ReceiverConfiguration: + allOf: + - $ref: '#/components/schemas/onvif_ReceiverConfiguration' + - properties: + token: + maxLength: 64 + type: string + type: object + media2_RemoveConfiguration: properties: - Description: - description: Informative description of this video source mode. This field - should be described in English. - type: string - Enabled: - 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. - type: boolean - Encodings: - description: List of one or more encodings supported for this video source. For - name definitions see tt:VideoEncodingMimeNames, and see + Configuration: + 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. items: - type: string + $ref: '#/components/schemas/media2_ConfigurationRef' type: array - MaxFramerate: - description: Max frame rate in frames per second for this video source mode. - type: number - MaxResolution: - allOf: - - $ref: '#/components/schemas/onvif_VideoResolution' - - description: Max horizontal and vertical resolution for this video source - mode. - Reboot: - 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. - type: boolean - token: - description: Indicate token for video source mode. + ProfileToken: + description: This element contains a reference to the media profile from + which the AudioDecoderConfiguration shall be removed. maxLength: 64 type: string required: - - token - - MaxFramerate - - MaxResolution - - Encodings - - Reboot + - ProfileToken + - Configuration type: object ptz_AbsoluteMove: properties: @@ -21351,31 +10989,6 @@ components: - ProfileToken - Position type: object - ptz_AbsoluteMoveResponse: - type: object - ptz_Capabilities: - properties: - EFlip: - description: Indicates whether or not EFlip is supported. - type: boolean - GetCompatibleConfigurations: - description: Indicates support for the GetCompatibleConfigurations command. - type: boolean - MoveAndTrack: - description: Indication of the methods of MoveAndTrack that are supported, - acceptable values are defined in tt:MoveAndTrackMethod. - type: string - MoveStatus: - description: Indicates that the PTZStatus includes MoveStatus information. - type: boolean - Reverse: - description: Indicates whether or not reversing of PT control direction - is supported. - type: boolean - StatusPosition: - description: Indicates that the PTZStatus includes Position information. - type: boolean - type: object ptz_ContinuousMove: properties: ProfileToken: @@ -21395,88 +11008,6 @@ components: - ProfileToken - Velocity type: object - ptz_ContinuousMoveResponse: - type: object - ptz_CreatePresetTour: - properties: - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - type: object - ptz_CreatePresetTourResponse: - properties: - PresetTourToken: - maxLength: 64 - type: string - required: - - PresetTourToken - type: object - ptz_GeoMove: - properties: - AreaHeight: - description: An optional indication of the height of the target/area. - type: number - AreaWidth: - description: An optional indication of the width of the target/area. - type: number - ProfileToken: - description: A reference to the MediaProfile. - maxLength: 64 - type: string - Speed: - allOf: - - $ref: '#/components/schemas/onvif_PTZSpeed' - - description: An optional Speed. - Target: - allOf: - - $ref: '#/components/schemas/onvif_GeoLocation' - - description: The geolocation of the target position. - required: - - ProfileToken - - Target - type: object - ptz_GeoMoveResponse: - type: object - ptz_GetCompatibleConfigurations: - properties: - ProfileToken: - description: Contains the token of an existing media profile the configurations - shall be compatible with. - maxLength: 64 - type: string - required: - - ProfileToken - type: object - ptz_GetCompatibleConfigurationsResponse: - properties: - PTZConfiguration: - description: A list of all existing PTZConfigurations on the NVT that is - suitable to be added to the addressed media profile. - items: - $ref: '#/components/schemas/onvif_PTZConfiguration' - type: array - type: object - ptz_GetConfiguration: - properties: - PTZConfigurationToken: - description: Token of the requested PTZConfiguration. - maxLength: 64 - type: string - required: - - PTZConfigurationToken - type: object - ptz_GetConfigurationOptions: - properties: - ConfigurationToken: - description: Token of an existing configuration that the options are intended - for. - maxLength: 64 - type: string - required: - - ConfigurationToken - type: object ptz_GetConfigurationOptionsResponse: properties: PTZConfigurationOptions: @@ -21495,8 +11026,6 @@ components: required: - PTZConfiguration type: object - ptz_GetConfigurations: - type: object ptz_GetConfigurationsResponse: properties: PTZConfiguration: @@ -21505,15 +11034,6 @@ components: $ref: '#/components/schemas/onvif_PTZConfiguration' type: array type: object - ptz_GetNode: - properties: - NodeToken: - description: Token of the requested PTZNode. - maxLength: 64 - type: string - required: - - NodeToken - type: object ptz_GetNodeResponse: properties: PTZNode: @@ -21523,8 +11043,6 @@ components: required: - PTZNode type: object - ptz_GetNodes: - type: object ptz_GetNodesResponse: properties: PTZNode: @@ -21533,68 +11051,6 @@ components: $ref: '#/components/schemas/onvif_PTZNode' type: array type: object - ptz_GetPresetTour: - properties: - PresetTourToken: - maxLength: 64 - type: string - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - - PresetTourToken - type: object - ptz_GetPresetTourOptions: - properties: - PresetTourToken: - maxLength: 64 - type: string - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - type: object - ptz_GetPresetTourOptionsResponse: - properties: - Options: - $ref: '#/components/schemas/onvif_PTZPresetTourOptions' - required: - - Options - type: object - ptz_GetPresetTourResponse: - properties: - PresetTour: - $ref: '#/components/schemas/onvif_PresetTour' - required: - - PresetTour - type: object - ptz_GetPresetTours: - properties: - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - type: object - ptz_GetPresetToursResponse: - properties: - PresetTour: - items: - $ref: '#/components/schemas/onvif_PresetTour' - type: array - type: object - ptz_GetPresets: - properties: - ProfileToken: - description: A reference to the MediaProfile where the operation should - take place. - maxLength: 64 - type: string - required: - - ProfileToken - type: object ptz_GetPresetsResponse: properties: Preset: @@ -21603,28 +11059,6 @@ components: $ref: '#/components/schemas/onvif_PTZPreset' type: array type: object - ptz_GetServiceCapabilities: - type: object - ptz_GetServiceCapabilitiesResponse: - properties: - Capabilities: - allOf: - - $ref: '#/components/schemas/ptz_Capabilities' - - description: The capabilities for the PTZ service is returned in the Capabilities - element. - required: - - Capabilities - type: object - ptz_GetStatus: - properties: - ProfileToken: - description: A reference to the MediaProfile where the PTZStatus should - be requested. - maxLength: 64 - type: string - required: - - ProfileToken - type: object ptz_GetStatusResponse: properties: PTZStatus: @@ -21649,8 +11083,6 @@ components: required: - ProfileToken type: object - ptz_GotoHomePositionResponse: - type: object ptz_GotoPreset: properties: PresetToken: @@ -21671,70 +11103,6 @@ components: - ProfileToken - PresetToken type: object - ptz_GotoPresetResponse: - type: object - ptz_ModifyPresetTour: - properties: - PresetTour: - $ref: '#/components/schemas/onvif_PresetTour' - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - - PresetTour - type: object - ptz_ModifyPresetTourResponse: - type: object - ptz_MoveAndStartTracking: - properties: - GeoLocation: - allOf: - - $ref: '#/components/schemas/onvif_GeoLocation' - - description: The geolocation of the target position. - ObjectID: - description: Object ID of the object to track. - format: int32 - type: integer - PresetToken: - description: A preset token. - maxLength: 64 - type: string - ProfileToken: - description: A reference to the MediaProfile where the operation should - take place. - maxLength: 64 - type: string - Speed: - allOf: - - $ref: '#/components/schemas/onvif_PTZSpeed' - - description: Speed vector specifying the velocity of pan, tilt and zoom. - TargetPosition: - allOf: - - $ref: '#/components/schemas/onvif_PTZVector' - - description: A Position vector specifying the absolute target position. - required: - - ProfileToken - type: object - ptz_MoveAndStartTrackingResponse: - type: object - ptz_OperatePresetTour: - properties: - Operation: - $ref: '#/components/schemas/onvif_PTZPresetTourOperation' - PresetTourToken: - maxLength: 64 - type: string - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - - PresetTourToken - - Operation - type: object - ptz_OperatePresetTourResponse: - type: object ptz_RelativeMove: properties: ProfileToken: @@ -21753,8 +11121,6 @@ components: - ProfileToken - Translation type: object - ptz_RelativeMoveResponse: - type: object ptz_RemovePreset: properties: PresetToken: @@ -21770,22 +11136,6 @@ components: - ProfileToken - PresetToken type: object - ptz_RemovePresetResponse: - type: object - ptz_RemovePresetTour: - properties: - PresetTourToken: - maxLength: 64 - type: string - ProfileToken: - maxLength: 64 - type: string - required: - - ProfileToken - - PresetTourToken - type: object - ptz_RemovePresetTourResponse: - type: object ptz_SendAuxiliaryCommand: properties: AuxiliaryData: @@ -21801,15 +11151,6 @@ components: - ProfileToken - AuxiliaryData type: object - ptz_SendAuxiliaryCommandResponse: - properties: - AuxiliaryResponse: - description: The response contains the auxiliary response. - maxLength: 128 - type: string - required: - - AuxiliaryResponse - type: object ptz_SetConfiguration: properties: ForcePersistence: @@ -21822,8 +11163,6 @@ components: - PTZConfiguration - ForcePersistence type: object - ptz_SetConfigurationResponse: - type: object ptz_SetHomePosition: properties: ProfileToken: @@ -21834,8 +11173,6 @@ components: required: - ProfileToken type: object - ptz_SetHomePositionResponse: - type: object ptz_SetPreset: properties: PresetName: @@ -21853,15 +11190,6 @@ components: required: - ProfileToken type: object - ptz_SetPresetResponse: - properties: - PresetToken: - description: A token to the Preset which has been set. - maxLength: 64 - type: string - required: - - PresetToken - type: object ptz_Stop: properties: PanTilt: @@ -21880,8 +11208,6 @@ components: required: - ProfileToken type: object - ptz_StopResponse: - type: object Event: description: A discrete event containing one or more readings properties: From e2699209860831bfc2e8cdbc5fa14e64f6d8da3a Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Thu, 20 Oct 2022 09:42:45 -0700 Subject: [PATCH 06/15] docs: replace postman env vars Signed-off-by: Anthony Casagrande --- doc/openapi/Makefile | 7 +- doc/openapi/README.md | 22 +- doc/openapi/p2o-options.json | 3 - doc/openapi/python/postprocess.py | 85 +- doc/openapi/sidecar.yaml | 19 +- doc/openapi/v2/device-onvif-camera.yaml | 1214 ++++------------- ...evice-onvif-camera.postman_collection.json | 42 +- ...vice-onvif-camera.postman_environment.json | 31 +- 8 files changed, 400 insertions(+), 1023 deletions(-) diff --git a/doc/openapi/Makefile b/doc/openapi/Makefile index 2d5146fc..e59a5b00 100644 --- a/doc/openapi/Makefile +++ b/doc/openapi/Makefile @@ -6,6 +6,7 @@ SHELL := /bin/bash POSTMAN_COLLECTION = ../postman/device-onvif-camera.postman_collection.json +POSTMAN_ENV = ../postman/device-onvif-camera.postman_environment.json OPENAPI_FILE = v2/device-onvif-camera.yaml OPENAPI_TEMP_FILE = tmp/device-onvif-camera.yaml POSTMAN_2_OPENAPI_OPTIONS = p2o-options.json @@ -19,10 +20,10 @@ SERVICES = analytics device event imaging media media2 ptz # todo: replace the API version number based on the actual source code version -$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) python/postprocess.py python/matrix.py python/cleaner.py Makefile - python3 python/postprocess.py $(OPENAPI_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) +$(OPENAPI_FILE) gen: $(SIDECAR_FILE) $(OPENAPI_TEMP_FILE) $(PROFILE_FILE) $(SERVICES:%=ref/out/%.yaml) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) $(POSTMAN_ENV) python/postprocess.py python/matrix.py python/cleaner.py Makefile + python3 python/postprocess.py $(OPENAPI_TEMP_FILE) $(SIDECAR_FILE) $(PROFILE_FILE) $(OPENAPI_FILE) $(ONVIF_TESTED_FILE) $(ONVIF_FOOTNOTES_FILE) $(POSTMAN_ENV) -$(OPENAPI_TEMP_FILE): $(POSTMAN_COLLECTION) $(POSTMAN_2_OPENAPI_OPTIONS) | ./tmp +$(OPENAPI_TEMP_FILE): $(POSTMAN_COLLECTION) $(POSTMAN_ENV) $(POSTMAN_2_OPENAPI_OPTIONS) | ./tmp p2o $(POSTMAN_COLLECTION) -f $(OPENAPI_TEMP_FILE) -o $(POSTMAN_2_OPENAPI_OPTIONS) > /dev/null ./tmp ./ref/out: diff --git a/doc/openapi/README.md b/doc/openapi/README.md index 7ac2ba9b..4849959c 100644 --- a/doc/openapi/README.md +++ b/doc/openapi/README.md @@ -1,13 +1,11 @@ # OpenAPI / Swagger Spec Files -This code generates OpenAPI 3.0 spec based on the Postman Collection -[device-onvif-camera.postman_collection.json](../postman/device-onvif-camera.postman_collection.json). -It also does some automated find and replace to insert some missing example values. - -> **TODO:** update usage +This code generates OpenAPI 3.0 spec based on the [Postman Collection](../postman/device-onvif-camera.postman_collection.json), +Onvif WSDL Schema Files, and [sidecar.yaml](sidecar.yaml). Usage: -- Install `postman-to-openapi` by running `make install` from this directory. +- Install `postman-to-openapi` and python3 dependencies by running `make install` from this directory. - Update the latest postman collection [device-onvif-camera.postman_collection.json](../postman/device-onvif-camera.postman_collection.json) +- Update the latest postman environment [device-onvif-camera.postman_environment.json](../postman/device-onvif-camera.postman_environment.json) - Run `make gen` to re-generate the OpenAPI files. ## [python](python) folder @@ -17,12 +15,22 @@ generating the OpenAPI spec file. ### [xmlstrip.py](python/xmlstrip.py) This script cleans up the yaml files in the [ref](ref) folder by removing all the xml references in the schema, and tweaking the schema values to clean them up for use in -the [postprocess.py](#postprocesspypythonpostprocesspy) script. +the [postprocess.py](python/postprocess.py) script. ### [postprocess.py](python/postprocess.py) This script takes in the preliminary OpenAPI file that was generated from the Postman collection and adds additional metadata to it, as well as cleaning up the data and format. +### [xmlstrip.py](python/xmlstrip.py) +This script cleans up the yaml files in the [ref](ref) folder by removing all the xml +references in the schema, and tweaking the schema values to clean them up for use in +the [postprocess.py](python/postprocess.py) script. + +### [matrix.py](python/matrix.py) +This script adds the compatibility matrix to each endpoint + +### [cleaner.py](python/cleaner.py) +This script removes all unused schema definition files ## [ref](ref) folder This folder contains files generated from the official Onvif wsdl diff --git a/doc/openapi/p2o-options.json b/doc/openapi/p2o-options.json index a19be484..1f051ba0 100644 --- a/doc/openapi/p2o-options.json +++ b/doc/openapi/p2o-options.json @@ -6,8 +6,5 @@ }, "folders": { "separator": " - " - }, - "additionalVars": { - "EDGEX_DEVICE_NAME": "Camera001" } } diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 7f826e4d..2c0aa57d 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -1,5 +1,6 @@ #!/usr/bin/env python3 - +import base64 +import json # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 from dataclasses import dataclass, field @@ -59,11 +60,13 @@ class YamlProcessor: profile_file: str output_file: str matrix: MarkdownMatrix - yml = None - sidecar = None - profile = None - resources: dict = field(default_factory=dict) - wsdl_files: dict = field(default_factory=dict) + postman_env_file: str + yml: any = None + sidecar: any = None + profile: any = None + postman_env: dict[str, str] = field(default_factory=dict) + resources: dict[str, any] = field(default_factory=dict) + wsdl_files: dict[str, any] = field(default_factory=dict) def _load(self): """Read input yaml file and sidecar yaml files""" @@ -83,6 +86,12 @@ def _load(self): print(f'Loading footnotes file: {self.matrix.footnotes_file}') self.matrix.parse() + print(f'Loading postman env file: {self.postman_env_file}') + with open(self.postman_env_file) as f: + env = json.load(f) + for item in env['values']: + self.postman_env[item['key']] = item['value'] + def _parse(self): """Parse the device resources into a lookup table""" for resource in self.profile['deviceResources']: @@ -215,6 +224,7 @@ def _process_apis(self): # move the example outside the schema to preserve it (and it belongs better up there) if 'example' in jscontent['schema']: jscontent['example'] = jscontent['schema']['example'] + self._insert_postman_env(jscontent['example']) # patch PUT call schema by using service name and onvif function name jscontent['schema'] = { @@ -272,7 +282,8 @@ def _process_apis(self): 'in': 'query', 'schema': { 'type': 'string' - } + }, + 'example': '' } self._set_json_object(param, service, fn) method_obj['parameters'].insert(0, param) @@ -294,12 +305,19 @@ def _set_json_object(self, param, service, fn): **Schema Reference:** [{service.lower()}_{fn}](#{service.lower()}_{fn}) ''' - # if there is a description in the original data, append it here before it gets overridden - if 'description' in param: - desc += f''' -**Example:**
+ if param['example'].startswith('{{'): + key = param['example'].lstrip('{{').rstrip('}}') + if key in self.postman_env: + param['example'] = self.postman_env[key] + if self.postman_env[key].startswith('eyJ'): + # if the value is base64, lets insert it + js = json.loads(base64.b64decode(self.postman_env[key])) + desc += f''' +**Example JSON:**
+> _Note: This value must be encoded to base64!_ + ```json -{param['description']} +{json.dumps(js, indent=2)} ``` ''' param['description'] = multiline_string(desc) @@ -328,12 +346,13 @@ def _combine_schemas(self): self.yml['components'] = { 'schemas': schemas, 'headers': {}, - 'examples': {} + 'examples': {}, + 'parameters': {} } # note: sidecar should always be added last to override the onvif schemas if 'components' in self.sidecar: - for component in ['schemas', 'headers', 'examples']: + for component in ['schemas', 'headers', 'examples', 'parameters']: # for each of the component types, copy the items to the output file if component in self.sidecar['components']: for k, v in self.sidecar['components'][component].items(): @@ -449,18 +468,19 @@ def _verify_complete(self): if 'setFunction' in cmd_obj['attributes'] and (path_obj is None or 'put' not in path_obj): print(f'\033[33m[WARNING] *** Expected call PUT "{cmd}" was not found in input yaml! ***\033[0m') - def _add_example_vars(self): + def _patch_parameters(self): """ - Goes through the paths and adds example values to all missing fields + Goes through the paths and links parameters to pre-defined ones paths/[path]/[method]/parameters/[name=EDGEX_DEVICE_NAME] """ for _, path_obj in self.yml['paths'].items(): for _, method_obj in path_obj.items(): - for param_obj in method_obj['parameters']: - if param_obj['name'] in self.sidecar['parameters']: - param_obj['example'] = self.sidecar['parameters'][param_obj['name']]['example'] - param_obj['description'] = self.sidecar['parameters'][param_obj['name']]['description'] + for i in range(len(method_obj['parameters'])): + name = method_obj['parameters'][i]['name'] + if name in self.yml['components']['parameters']: + # patch the parameter to just be a reference + method_obj['parameters'][i] = {'$ref': f'#/components/parameters/{name}'} def _clean_response_headers(self): """ @@ -490,19 +510,36 @@ def process(self): self._parse() self._combine_schemas() self._process_apis() - self._add_example_vars() + self._patch_parameters() self._clean_response_headers() self._verify_complete() self._clean_schemas() self._write() + def _insert_postman_env(self, obj): + if isinstance(obj, dict): + for k, v in obj.items(): + if isinstance(v, str): + if v.startswith('{{'): + key = v.lstrip('{{').rstrip('}}') + if key in self.postman_env: + print(f'Patching postman env: {key}') + obj[k] = self.postman_env[key] + else: + print(f'\033[33m[WARNING] *** Reference to postman env {key} was not found in environment ***\033[0m') + else: + self._insert_postman_env(v) + elif isinstance(obj, list): + for item in obj: + self._insert_postman_env(item) + def main(): - if len(sys.argv) != 7: - print(f'Usage: {sys.argv[0]} ') + if len(sys.argv) != 8: + print(f'Usage: {sys.argv[0]} ') sys.exit(1) - proc = YamlProcessor(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4], MarkdownMatrix(sys.argv[5], sys.argv[6])) + proc = YamlProcessor(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4], MarkdownMatrix(sys.argv[5], sys.argv[6]), sys.argv[7]) proc.process() diff --git a/doc/openapi/sidecar.yaml b/doc/openapi/sidecar.yaml index afe341e7..f1ed7a1f 100644 --- a/doc/openapi/sidecar.yaml +++ b/doc/openapi/sidecar.yaml @@ -148,13 +148,6 @@ responses: examples: 503Example: $ref: '#/components/examples/503Example' -parameters: - EDGEX_DEVICE_NAME: - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. components: headers: correlatedResponseHeader: @@ -163,6 +156,18 @@ components: type: string format: uuid example: "14a42ea6-c394-41c3-8bcd-a29b9f5e6835" + parameters: + EDGEX_DEVICE_NAME: + name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. examples: 200Example: value: diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 740c5707..f945576e 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -51,16 +51,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -203,16 +194,7 @@ paths: Hostname: Name: localhost555 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': &id006 description: OK @@ -255,16 +237,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -352,16 +325,7 @@ paths: Type: IPv4 IPv4Address: 192.168.12.1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -393,16 +357,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -506,16 +461,7 @@ paths: IPv4: DHCP: true parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -547,16 +493,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -656,16 +593,7 @@ paths: Enabled: true Port: 554 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -697,16 +625,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -791,16 +710,7 @@ paths: NetworkDefaultGateway: IPv4Address: 192.168.12.1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -820,16 +730,7 @@ paths: Used to retrieve network resources for a device such as Hostname, DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -955,16 +856,7 @@ paths: NetworkDefaultGateway: IPv4Address: 192.168.12.1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1003,16 +895,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1091,16 +974,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1225,16 +1099,7 @@ paths: Minute: 48 Second: 20 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -1279,16 +1144,7 @@ paths: SetSystemFactoryDefault: FactoryDefault: Soft parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -1308,16 +1164,7 @@ paths: Indicates whether or not a reboot is required after configuration updates. parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1373,16 +1220,7 @@ paths: example: SystemReboot: {} parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -1415,16 +1253,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1501,7 +1330,7 @@ paths: in: query schema: type: string - example: '{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}' + example: '' description: | **Format:**
This field is a Base64 encoded json string. @@ -1519,16 +1348,7 @@ paths: **Schema Reference:** [media_GetMetadataConfiguration](#media_GetMetadataConfiguration) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1616,16 +1436,7 @@ paths: token: '{{MEDIA_CONFIG_TOKEN}}' Analytics: true parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -1661,7 +1472,7 @@ paths: in: query schema: type: string - example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== description: | **Format:**
This field is a Base64 encoded json string. @@ -1679,16 +1490,16 @@ paths: **Schema Reference:** [media_GetCompatibleMetadataConfigurations](#media_GetCompatibleMetadataConfigurations) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ProfileToken": "profile_1" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1765,7 +1576,7 @@ paths: in: query schema: type: string - example: '{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}' + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== description: | **Format:**
This field is a Base64 encoded json string. @@ -1786,16 +1597,16 @@ paths: **Schema Reference:** [media_GetMetadataConfigurationOptions](#media_GetMetadataConfigurationOptions) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ProfileToken": "profile_1" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -1879,19 +1690,10 @@ paths: type: object example: AddMetadataConfiguration: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 ConfigurationToken: '{{MEDIA_CONFIG_TOKEN}}' parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -1934,18 +1736,9 @@ paths: type: object example: RemoveMetadataConfiguration: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -1977,16 +1770,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2304,6 +2088,7 @@ paths: in: query schema: type: string + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJTdHJlYW1TZXR1cCI6eyJTdHJlYW0iOiJSVFAtVW5pY2FzdCIsIlRyYW5zcG9ydCI6eyJQcm90b2NvbCI6IlJUU1AifX19 description: | **Format:**
This field is a Base64 encoded json string. @@ -2340,21 +2125,21 @@ paths: **Schema Reference:** [media_GetStreamUri](#media_GetStreamUri) - **Example:**
+ **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + ```json - {"ProfileToken":"profile_1"} + { + "ProfileToken": "profile_1", + "StreamSetup": { + "Stream": "RTP-Unicast", + "Transport": { + "Protocol": "RTSP" + } + } + } ``` - example: '{{EDGEX_MEDIA_PROFILE_BASE64}}' - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2433,16 +2218,7 @@ paths: | **GeoVision GV-BX8700** | ❌ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2494,16 +2270,7 @@ paths: in a device. The client need not know anything apriori about the video encoder configurations in order to use the command. parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2603,7 +2370,7 @@ paths: in: query schema: type: string - example: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}' + example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -2621,16 +2388,16 @@ paths: **Schema Reference:** [media_GetVideoEncoderConfiguration](#media_GetVideoEncoderConfiguration) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ConfigurationToken": "main" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2740,7 +2507,7 @@ paths: VideoEncoderConfiguration: ForcePersistence: false Configuration: - token: '{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}' + token: main Encoding: H264 Quality: 3 Resolution: @@ -2754,16 +2521,7 @@ paths: TTL: 1 AutoStart: false parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '500': description: Internal Server Error @@ -2828,7 +2586,7 @@ paths: in: query schema: type: string - example: '{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}' + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -2849,16 +2607,17 @@ paths: **Schema Reference:** [media_GetVideoEncoderConfigurationOptions](#media_GetVideoEncoderConfigurationOptions) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ProfileToken": "profile_1", + "ConfigurationToken": "main" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2976,16 +2735,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -3082,16 +2832,7 @@ paths: Password: Password1! UserLevel: Operator parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -3144,16 +2885,7 @@ paths: Password: Password1! UserLevel: User parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -3200,16 +2932,7 @@ paths: - user1 - user2 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -3241,16 +2964,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -3335,16 +3049,7 @@ paths: DiscoveryMode: DiscoveryMode: Discoverable parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -3390,16 +3095,7 @@ paths: ScopeItem: - http//:123 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -3434,16 +3130,7 @@ paths: | **GeoVision GV-BX8700** | ✔️ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -3539,16 +3226,7 @@ paths: Scopes: - http//:123 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -3594,16 +3272,7 @@ paths: ScopeItem: - onvif://www.onvif.org/name/Geovision parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '500': description: Internal Server Error @@ -3662,16 +3331,7 @@ paths: | **GeoVision GV-BX8700** | ❌ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -3824,21 +3484,16 @@ paths: **Schema Reference:** [ptz_GetNode](#ptz_GetNode) - **Example:**
+ **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + ```json - {"NodeToken": "Node0"} + { + "NodeToken": "Node0" + } ``` example: eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ== - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -3971,16 +3626,7 @@ paths: | **GeoVision GV-BX8700** | ❌ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -4097,21 +3743,16 @@ paths: **Schema Reference:** [ptz_GetConfiguration](#ptz_GetConfiguration) - **Example:**
+ **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + ```json - {"PTZConfigurationToken": "PTZConfiguration0"} + { + "PTZConfigurationToken": "PTZConfiguration0" + } ``` example: eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -4213,8 +3854,8 @@ paths: example: Configuration: PTZConfiguration: - Token: '{{PTZ_CONFIG_TOKEN}}' - NodeToken: '{{PTZ_NODE_TOKEN}}' + Token: PROFILE_3263078452 + NodeToken: PTZNODE_3 PanTiltLimits: Range: XRange: @@ -4224,16 +3865,7 @@ paths: Max: 35 Min: -32 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4286,22 +3918,8 @@ paths: **Schema Reference:** [ptz_GetConfigurationOptions](#ptz_GetConfigurationOptions) - - **Example:**
- ```json - {"ConfigurationToken": "PTZConfiguration0"} - ``` example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -4443,19 +4061,10 @@ paths: type: object example: AddPTZConfiguration: - ProfileToken: '{{MEDIA_PROFILE}}' - ConfigurationToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: profile_1 + ConfigurationToken: PROFILE_3263078452 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4498,18 +4107,9 @@ paths: type: object example: RemovePTZConfiguration: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4554,22 +4154,13 @@ paths: type: object example: AbsoluteMove: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 Position: PanTilt: x: 0 y: 0 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4614,22 +4205,13 @@ paths: type: object example: RelativeMove: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 Translation: PanTilt: x: 0 y: 0 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4672,22 +4254,13 @@ paths: type: object example: ContinuousMove: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 Velocity: PanTilt: x: -1 y: -1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4741,21 +4314,16 @@ paths: **Schema Reference:** [ptz_GetStatus](#ptz_GetStatus) - **Example:**
+ **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + ```json - {"ProfileToken":"profile_1"} + { + "ProfileToken": "profile_1" + } ``` example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -4848,19 +4416,10 @@ paths: type: object example: Stop: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 PanTilt: true parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4904,18 +4463,9 @@ paths: example: SetPreset: PresetName: Preset1 - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -4951,6 +4501,7 @@ paths: in: query schema: type: string + example: eyJQcm9maWxlVG9rZW4iOiAiUFJPRklMRV8zMzA1OTY3Nzk3In0= description: | **Format:**
This field is a Base64 encoded json string. @@ -4969,29 +4520,15 @@ paths: **Schema Reference:** [ptz_GetPresets](#ptz_GetPresets) - **Example:**
- ```json - Json: - ```json - {"ProfileToken":"PROFILE_3305967797"} - ``` + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ - Base64: - ``` - eyJQcm9maWxlVG9rZW4iOiJQUk9GSUxFXzMzMDU5Njc3OTcifQ== - ``` + ```json + { + "ProfileToken": "PROFILE_3305967797" + } ``` - example: '{{PTZ_CONFIG_TOKEN_BASE64}}' - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -5099,19 +4636,10 @@ paths: type: object example: GotoPreset: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 PresetToken: Preset1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5154,19 +4682,10 @@ paths: type: object example: RemovePreset: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 PresetToken: Preset1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5209,18 +4728,9 @@ paths: type: object example: GotoHomePosition: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5263,18 +4773,9 @@ paths: type: object example: SetHomePosition: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5331,19 +4832,10 @@ paths: type: object example: SendAuxiliaryCommand: - ProfileToken: '{{MEDIA_PROFILE}}' + ProfileToken: profile_1 AuxiliaryData: '123' parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5367,16 +4859,7 @@ paths: device in order to provide information about the FilterDialects, Schema files and topics supported by the device. parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -5567,16 +5050,7 @@ paths: TopicFilter: tns1:RuleEngine/TamperDetector/Tamper InitialTerminationTime: PT180S parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5624,16 +5098,7 @@ paths: InitialTerminationTime: PT120S MessageTimeout: PT20S parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5666,16 +5131,7 @@ paths: example: UnsubscribeCameraEvent: {} parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5708,6 +5164,7 @@ paths: in: query schema: type: string + example: '' description: | **Format:**
This field is a Base64 encoded json string. @@ -5728,16 +5185,7 @@ paths: **Schema Reference:** [media2_GetProfiles](#media2_GetProfiles) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '500': description: Internal Server Error @@ -5814,16 +5262,7 @@ paths: | **GeoVision GV-BX8700** | ❌ | | parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '500': description: Internal Server Error @@ -5914,21 +5353,12 @@ paths: type: object example: AddConfiguration: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 Configuration: - Type: Analytics - Token: '{{ANALYTIC_CONFIG_TOKEN}}' + Token: VideoAnalyticsToken_3263078450 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -5971,21 +5401,12 @@ paths: type: object example: RemoveConfiguration: - ProfileToken: '{{PTZ_CONFIG_TOKEN}}' + ProfileToken: PROFILE_3263078452 Configuration: - Type: Analytics - Token: '{{ANALYTIC_CONFIG_TOKEN}}' + Token: VideoAnalyticsToken_3263078450 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -6021,6 +5442,7 @@ paths: in: query schema: type: string + example: '' description: | **Format:**
This field is a Base64 encoded json string. @@ -6038,16 +5460,7 @@ paths: **Schema Reference:** [analytics_GetSupportedAnalyticsModules](#analytics_GetSupportedAnalyticsModules) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -6103,7 +5516,7 @@ paths: in: query schema: type: string - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + example: eyJWaWRlb0FuYWx5dGljc1Rva2VuIjoiVmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -6121,16 +5534,16 @@ paths: **Schema Reference:** [analytics_GetAnalyticsModules](#analytics_GetAnalyticsModules) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "VideoAnalyticsToken": "VideoAnalyticsToken_3012508060" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -6219,7 +5632,7 @@ paths: type: object example: AnalyticsModules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + ConfigurationToken: VideoAnalyticsToken_3263078450 AnalyticsModule: - Name: Viproc Type: '{{ANALYTIC_MODULE_TYPE}}' @@ -6228,16 +5641,7 @@ paths: - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -6286,7 +5690,7 @@ paths: type: object example: CreateAnalyticsModules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + ConfigurationToken: VideoAnalyticsToken_3263078450 AnalyticsModule: - Name: TestAnalyticsModule Type: '{{ANALYTIC_MODULE_TYPE}}' @@ -6295,16 +5699,7 @@ paths: - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -6347,20 +5742,11 @@ paths: type: object example: DeleteAnalyticsModules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + ConfigurationToken: VideoAnalyticsToken_3263078450 AnalyticsModuleName: - TestAnalyticsModule parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -6396,7 +5782,7 @@ paths: in: query schema: type: string - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + example: eyJWaWRlb0FuYWx5dGljc1Rva2VuIjoiVmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -6417,16 +5803,16 @@ paths: **Schema Reference:** [analytics_GetAnalyticsModuleOptions](#analytics_GetAnalyticsModuleOptions) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "VideoAnalyticsToken": "VideoAnalyticsToken_3012508060" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -6508,7 +5894,7 @@ paths: in: query schema: type: string - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + example: eyJWaWRlb0FuYWx5dGljc1Rva2VuIjoiVmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -6527,16 +5913,16 @@ paths: **Schema Reference:** [analytics_GetSupportedRules](#analytics_GetSupportedRules) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "VideoAnalyticsToken": "VideoAnalyticsToken_3012508060" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -6764,7 +6150,7 @@ paths: in: query schema: type: string - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + example: eyJWaWRlb0FuYWx5dGljc1Rva2VuIjoiVmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -6782,16 +6168,16 @@ paths: **Schema Reference:** [analytics_GetRules](#analytics_GetRules) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "VideoAnalyticsToken": "VideoAnalyticsToken_3012508060" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -6886,7 +6272,7 @@ paths: type: object example: Rules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + ConfigurationToken: VideoAnalyticsToken_3263078450 Rule: - Name: MyMotionDetectorRule Type: tt:ObjectInField @@ -6895,16 +6281,7 @@ paths: - Name: ClassFilter Value: ' Bike Car Truck' parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -6940,7 +6317,7 @@ paths: in: query schema: type: string - example: '{{ANALYTIC_CONFIG_TOKEN_BASE64}}' + example: eyJWaWRlb0FuYWx5dGljc1Rva2VuIjoiVmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwIn0= description: | **Format:**
This field is a Base64 encoded json string. @@ -6961,16 +6338,16 @@ paths: **Schema Reference:** [analytics_GetRuleOptions](#analytics_GetRuleOptions) - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "VideoAnalyticsToken": "VideoAnalyticsToken_3012508060" + } + ``` + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -7066,7 +6443,7 @@ paths: type: object example: CreateRules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + ConfigurationToken: VideoAnalyticsToken_3263078450 Rule: - Name: Object Counting Type: tt:LineCounting @@ -7083,16 +6460,7 @@ paths: - x: '0.16' y: '-0.5' parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -7135,20 +6503,11 @@ paths: type: object example: DeleteRules: - ConfigurationToken: '{{ANALYTIC_CONFIG_TOKEN}}' + ConfigurationToken: VideoAnalyticsToken_3263078450 RuleName: - Object Counting parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -7166,16 +6525,7 @@ paths: summary: Get MACAddress description: This command returns the MAC address associated with a device. parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -7245,16 +6595,7 @@ paths: example: MACAddress: 10-27-f5-ea-88-f4 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -7272,16 +6613,7 @@ paths: device. This is a name given to a device by a user to make the device more identifiable. parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -7341,16 +6673,7 @@ paths: FriendlyName: FriendlyName: My Camera parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -7420,16 +6743,7 @@ paths: ``` parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -7522,16 +6836,7 @@ paths: Business: John's Grocery Store Install Date: 01/01/1970 parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -7564,16 +6869,7 @@ paths: - Location - Color parameters: - - name: EDGEX_DEVICE_NAME - in: path - schema: - type: string - required: true - example: Camera001 - description: | - This is the device name associated with the camera. It was - either assigned via the auto-discovery function, or manually - defined when you created the device. + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': *id006 '400': *id001 @@ -11467,3 +10763,15 @@ components: apiVersion: v2 statusCode: 503 message: HTTP request timeout + parameters: + EDGEX_DEVICE_NAME: + name: EDGEX_DEVICE_NAME + in: path + schema: + type: string + required: true + example: Camera001 + description: | + This is the device name associated with the camera. It was + either assigned via the auto-discovery function, or manually + defined when you created the device. diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index e73e539c..e93f3411 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -2360,7 +2360,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}", "protocol": "http", "host": [ "0", @@ -2380,8 +2380,7 @@ "query": [ { "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}", - "description": "{\"ProfileToken\":\"profile_1\"}" + "value": "{{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}" } ] }, @@ -2394,7 +2393,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}", "protocol": "http", "host": [ "0", @@ -2414,7 +2413,7 @@ "query": [ { "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" + "value": "{{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}" } ] } @@ -3886,7 +3885,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetNode?jsonObject=eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetNode?jsonObject={{NODE_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -3906,7 +3905,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ==", + "value": "{{NODE_TOKEN_BASE64}}", "description": "{\"NodeToken\": \"Node0\"}" } ] @@ -3920,7 +3919,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetNode?jsonObject=eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetNode?jsonObject={{NODE_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -3940,7 +3939,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ==" + "value": "{{NODE_TOKEN_BASE64}}" } ] } @@ -4084,7 +4083,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Configuration?jsonObject=eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Configuration?jsonObject={{PTZ_CONFIGURATION_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -4104,7 +4103,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "value": "{{PTZ_CONFIGURATION_TOKEN_BASE64}}", "description": "{\"PTZConfigurationToken\": \"PTZConfiguration0\"}" } ] @@ -4118,7 +4117,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Configuration?jsonObject=eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Configuration?jsonObject={{PTZ_CONFIGURATION_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -4138,7 +4137,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==" + "value": "{{PTZ_CONFIGURATION_TOKEN_BASE64}}" } ] } @@ -4872,7 +4871,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetStatus?jsonObject=eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetStatus?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", "protocol": "http", "host": [ "0", @@ -4892,7 +4891,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", + "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}", "description": "{\"ProfileToken\":\"profile_1\"}" } ] @@ -4906,7 +4905,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetStatus?jsonObject=eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetStatus?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", "protocol": "http", "host": [ "0", @@ -4926,7 +4925,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==" + "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" } ] } @@ -5160,7 +5159,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetPresets?jsonObject={{PTZ_CONFIG_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetPresets?jsonObject={{PTZ_MEDIA_PROFILE_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -5180,8 +5179,7 @@ "query": [ { "key": "jsonObject", - "value": "{{PTZ_CONFIG_TOKEN_BASE64}}", - "description": "Json: \n```json\n{\"ProfileToken\":\"PROFILE_3305967797\"}\n```\n\nBase64:\n```\neyJQcm9maWxlVG9rZW4iOiJQUk9GSUxFXzMzMDU5Njc3OTcifQ==\n```" + "value": "{{PTZ_MEDIA_PROFILE_TOKEN_BASE64}}" } ] }, @@ -5194,7 +5192,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetPresets?jsonObject=eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetPresets?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", "protocol": "http", "host": [ "0", @@ -5214,7 +5212,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==" + "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" } ] } diff --git a/doc/postman/device-onvif-camera.postman_environment.json b/doc/postman/device-onvif-camera.postman_environment.json index 0f0587e2..c37913f4 100644 --- a/doc/postman/device-onvif-camera.postman_environment.json +++ b/doc/postman/device-onvif-camera.postman_environment.json @@ -4,7 +4,7 @@ "values": [ { "key": "EDGEX_DEVICE_NAME", - "value": "Camera002", + "value": "Camera001", "enabled": true }, { @@ -12,6 +12,11 @@ "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", "enabled": true }, + { + "key": "EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64", + "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJTdHJlYW1TZXR1cCI6eyJTdHJlYW0iOiJSVFAtVW5pY2FzdCIsIlRyYW5zcG9ydCI6eyJQcm90b2NvbCI6IlJUU1AifX19", + "enabled": true + }, { "key": "EDGEX_MEDIA_CONFIG_TOKEN_BASE64", "value": "", @@ -57,13 +62,31 @@ }, { "key": "ANALYTIC_CONFIG_TOKEN_BASE64", - "value": "e1ZpZGVvQW5hbHl0aWNzVG9rZW46VmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwfQo=", + "value": "eyJWaWRlb0FuYWx5dGljc1Rva2VuIjoiVmlkZW9BbmFseXRpY3NUb2tlbl8zMDEyNTA4MDYwIn0=", + "type": "default", + "enabled": true + }, + { + "key": "PTZ_MEDIA_PROFILE_TOKEN_BASE64", + "value": "eyJQcm9maWxlVG9rZW4iOiAiUFJPRklMRV8zMzA1OTY3Nzk3In0=", + "type": "default", + "enabled": true + }, + { + "key": "NODE_TOKEN_BASE64", + "value": "eyJOb2RlVG9rZW4iOiAiTm9kZTAifQ==", + "type": "default", + "enabled": true + }, + { + "key": "PTZ_CONFIGURATION_TOKEN_BASE64", + "value": "eyJQVFpDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", "type": "default", "enabled": true }, { - "key": "PTZ_CONFIG_TOKEN_BASE64", - "value": "e1Byb2ZpbGVUb2tlbjpQUk9GSUxFXzMzMDU5Njc3OTd9Cg==", + "key": "MEDIA_PROFILE", + "value": "profile_1", "type": "default", "enabled": true } From 6f511cfdc54a5faed542fac4ba7365aa731660a0 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Thu, 20 Oct 2022 09:45:12 -0700 Subject: [PATCH 07/15] docs: fix postman collection name Signed-off-by: Anthony Casagrande --- doc/postman/device-onvif-camera.postman_collection.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index e93f3411..69d6257d 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -1,7 +1,7 @@ { "info": { "_postman_id": "41b06358-d096-4b9b-8735-a0905762330f", - "name": "device-onvif-camera Copy 2", + "name": "device-onvif-camera", "description": "The Open Network Video Interface Forum (ONVIF) Device Service is a microservice created to address the lack of standardization and automation of camera discovery and onboarding. EdgeX Foundry is a flexible microservice-based architecture created to promote the interoperability of multiple device interface combinations at the edge. In an EdgeX deployment, the ONVIF Device Service controls and communicates with ONVIF-compliant cameras, while EdgeX Foundry presents a standard interface to application developers. With normalized connectivity protocols and a vendor-neutral architecture, EdgeX paired with ONVIF Camera Device Service, simplifies deployment of edge camera devices.\n\nUse the ONVIF Device Service to streamline and scale your edge camera device deployment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "_exporter_id": "7889146" From 68169d1bfd71bebd11a366dae991164454c6cc80 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Thu, 20 Oct 2022 09:56:44 -0700 Subject: [PATCH 08/15] docs: update postman collection Signed-off-by: Anthony Casagrande --- doc/openapi/v2/device-onvif-camera.yaml | 9 +++++++++ .../device-onvif-camera.postman_collection.json | 8 ++++---- .../device-onvif-camera.postman_environment.json | 14 ++++++++++++++ 3 files changed, 27 insertions(+), 4 deletions(-) diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index f945576e..c8e3d191 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -3918,6 +3918,15 @@ paths: **Schema Reference:** [ptz_GetConfigurationOptions](#ptz_GetConfigurationOptions) + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ConfigurationToken": "PTZConfiguration0" + } + ``` example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ== - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index 69d6257d..aeb2ab6c 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -4186,7 +4186,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetConfigurationOptions?jsonObject=eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetConfigurationOptions?jsonObject={{GET_CONFIGURATION_OPTIONS_BASE64}}", "protocol": "http", "host": [ "0", @@ -4206,7 +4206,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "value": "{{GET_CONFIGURATION_OPTIONS_BASE64}}", "description": "{\"ConfigurationToken\": \"PTZConfiguration0\"}" } ] @@ -4220,7 +4220,7 @@ "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetConfigurationOptions?jsonObject=eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetConfigurationOptions?jsonObject={{GET_CONFIGURATION_OPTIONS_BASE64}}", "protocol": "http", "host": [ "0", @@ -4240,7 +4240,7 @@ "query": [ { "key": "jsonObject", - "value": "eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "value": "{{GET_CONFIGURATION_OPTIONS_BASE64}}", "description": "{\"ConfigurationToken\": \"PTZConfiguration0\"}" } ] diff --git a/doc/postman/device-onvif-camera.postman_environment.json b/doc/postman/device-onvif-camera.postman_environment.json index c37913f4..b3910608 100644 --- a/doc/postman/device-onvif-camera.postman_environment.json +++ b/doc/postman/device-onvif-camera.postman_environment.json @@ -5,41 +5,49 @@ { "key": "EDGEX_DEVICE_NAME", "value": "Camera001", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_PROFILE_BASE64", "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64", "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJTdHJlYW1TZXR1cCI6eyJTdHJlYW0iOiJSVFAtVW5pY2FzdCIsIlRyYW5zcG9ydCI6eyJQcm90b2NvbCI6IlJUU1AifX19", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_CONFIG_TOKEN_BASE64", "value": "", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64", "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ==", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_VIDEO_ENCODER_TOKEN", "value": "main", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64", "value": "eyJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0=", + "type": "default", "enabled": true }, { "key": "EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64", "value": "eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0=", + "type": "default", "enabled": true }, { @@ -89,6 +97,12 @@ "value": "profile_1", "type": "default", "enabled": true + }, + { + "key": "GET_CONFIGURATION_OPTIONS_BASE64", + "value": "eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", + "type": "default", + "enabled": true } ], "_postman_variable_scope": "environment", From c44d1cb6a65eeec37ec58c02a279d2b878b9a28f Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Thu, 20 Oct 2022 11:22:15 -0700 Subject: [PATCH 09/15] docs: cleanup Signed-off-by: Anthony Casagrande --- doc/ONVIF-protocol.md | 2 + doc/openapi/python/__init__.py | 3 + doc/openapi/python/cleaner.py | 4 +- doc/openapi/python/matrix.py | 2 + doc/openapi/python/postprocess.py | 9 +- doc/openapi/python/xmlstrip.py | 3 +- doc/openapi/v2/device-onvif-camera.yaml | 3356 +++++++++-------- ...evice-onvif-camera.postman_collection.json | 1568 ++++---- ...vice-onvif-camera.postman_environment.json | 8 +- 9 files changed, 2495 insertions(+), 2460 deletions(-) diff --git a/doc/ONVIF-protocol.md b/doc/ONVIF-protocol.md index acbdac14..75e87157 100644 --- a/doc/ONVIF-protocol.md +++ b/doc/ONVIF-protocol.md @@ -346,7 +346,9 @@ The following table shows the Onvif functions tested for various Onvif cameras: | | PullMessages | ✔ | ❌ | ✔ | ❌ | | | | TopicFilter | ✔ | ❌ | ✔ | ❌ | | | | MessageContentFilter | ❌ | ❌ | ❌ | ❌ | | +| | GetEventProperties | | ✔ | | | | +GetEventProperties ### Analytics Profile Configuration | Onvif Web Service | Onvif Function | Hikvision DFI6256TE | Tapo C200 | BOSCH DINION IP starlight 6000 HD | GeoVision GV-BX8700 | Happytime Simulator | |-------------------|----------------------------|---------------------|-----------|-----------------------------------|---------------------|---------------------| diff --git a/doc/openapi/python/__init__.py b/doc/openapi/python/__init__.py index 6b0e0edd..4064f8f3 100644 --- a/doc/openapi/python/__init__.py +++ b/doc/openapi/python/__init__.py @@ -1,2 +1,5 @@ +#!/usr/bin/env python3 +# # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 +# diff --git a/doc/openapi/python/cleaner.py b/doc/openapi/python/cleaner.py index 2fad1d2f..8cdc1db4 100644 --- a/doc/openapi/python/cleaner.py +++ b/doc/openapi/python/cleaner.py @@ -1,7 +1,9 @@ #!/usr/bin/env python3 - +# # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 +# + from collections import defaultdict from dataclasses import dataclass, field from ruamel.yaml import YAML diff --git a/doc/openapi/python/matrix.py b/doc/openapi/python/matrix.py index c68ec3fe..c7280509 100644 --- a/doc/openapi/python/matrix.py +++ b/doc/openapi/python/matrix.py @@ -1,6 +1,8 @@ #!/usr/bin/env python3 +# # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 +# from enum import Enum, auto from dataclasses import dataclass, field diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 2c0aa57d..d1948b36 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -1,8 +1,11 @@ #!/usr/bin/env python3 -import base64 -import json +# # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 +# + +import base64 +import json from dataclasses import dataclass, field import sys import copy @@ -214,6 +217,8 @@ def _process_apis(self): # --- More ONVIF function patching --- + method_obj['summary'] = f'{service}: {fn}' + # Special handling for PUT calls: # - Move example out of schema into json object itself # - Patch the input body schema based on the EdgeX command name and the Onvif function name diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py index 91f6a456..e5267452 100755 --- a/doc/openapi/python/xmlstrip.py +++ b/doc/openapi/python/xmlstrip.py @@ -1,7 +1,8 @@ #!/usr/bin/env python3 - +# # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 +# import re import sys diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index c8e3d191..06d0aeea 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -6,13 +6,13 @@ info: servers: - url: http://0.0.0.0:59882 tags: +- name: Auto Discovery - name: Network Configuration - name: System Function +- name: User Handling - name: Metadata Configuration - name: Video Streaming - name: Video Encoder Configuration -- name: User Handling -- name: Auto Discovery - name: PTZ - name: PTZ - Capabilities - name: PTZ - Configuration @@ -30,13 +30,13 @@ tags: Custom commands outside of the ONVIF spec handled by the device service directly. paths: - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Hostname: + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DiscoveryMode: get: tags: - - Network Configuration - summary: Hostname + - Auto Discovery + summary: 'Device: GetDiscoveryMode' 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. + 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.
Tested Camera Models @@ -74,29 +74,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetHostnameResponse' + $ref: '#/components/schemas/device_GetDiscoveryModeResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 6ad6d2d6-51af-4084-8a6a-952928942732 + id: 8155efce-41b5-412f-a25d-b63bed015d63 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: Hostname - origin: 1659655574277981200 + sourceName: DiscoveryMode + origin: 1659656339306907600 readings: - - id: b8e4ba90-2aeb-4336-a5ca-923456cff383 - origin: 1659655574277981200 + - id: 099efd6b-d5fa-44a3-98f2-67eb72a1659f + origin: 1659656339306907600 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: Hostname + resourceName: DiscoveryMode profileName: onvif-camera valueType: Object value: '' objectValue: - HostnameInformation: - FromDHCP: false - Name: hostname + DiscoveryMode: Discoverable '400': &id001 description: Request is in an invalid state headers: @@ -159,14 +157,13 @@ paths: $ref: '#/components/examples/503Example' externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetHostname + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDiscoveryMode put: tags: - - Network Configuration - summary: SetHostname + - Auto Discovery + summary: 'Device: SetDiscoveryMode' 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 formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. + 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.
Tested Camera Models @@ -176,7 +173,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -185,14 +182,14 @@ paths: application/json: schema: properties: - Hostname: - $ref: '#/components/schemas/device_SetHostname' + DiscoveryMode: + $ref: '#/components/schemas/device_SetDiscoveryMode' required: - - Hostname + - DiscoveryMode type: object example: - Hostname: - Name: localhost555 + DiscoveryMode: + DiscoveryMode: Discoverable parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -215,86 +212,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetHostname - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DNS: - get: - tags: - - Network Configuration - summary: DNS - description: |- - This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command. - -
- Tested Camera Models - - Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - - | Camera | Supported?    | Notes | - |--------|:------------|-------| - | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | -
- parameters: - - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' - responses: - '200': - description: OK - headers: - Content-Type: - schema: - type: string - example: application/json - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ObjectEventResponse' - - properties: - event: - properties: - readings: - items: - properties: - objectValue: - $ref: '#/components/schemas/device_GetDNSResponse' - example: - apiVersion: v2 - statusCode: 200 - event: - apiVersion: v2 - id: d2d2541f-2feb-490f-bf89-b7407d3078d3 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - profileName: onvif-camera - sourceName: DNS - origin: 1659671999397808400 - readings: - - id: 3ad48fbe-1e98-4c90-a26e-f83a391c4d8c - origin: 1659671999397808400 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: DNS - profileName: onvif-camera - valueType: Object - value: '' - objectValue: - DNSInformation: {} - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDNS + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDiscoveryMode + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddScopes: put: tags: - - Network Configuration - summary: SetDNS + - Auto Discovery + summary: 'Device: AddScopes' description: |- - This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command. + 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.
Tested Camera Models @@ -313,17 +238,15 @@ paths: application/json: schema: properties: - DNS: - $ref: '#/components/schemas/device_SetDNS' + AddScopes: + $ref: '#/components/schemas/device_AddScopes' required: - - DNS + - AddScopes type: object example: - DNS: - FromDHCP: true - DNSManual: - Type: IPv4 - IPv4Address: 192.168.12.1 + AddScopes: + ScopeItem: + - http//:123 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -335,14 +258,17 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDNS - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkInterfaces: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.AddScopes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Scopes: get: tags: - - Network Configuration - summary: NetworkInterfaces + - Auto Discovery + summary: 'Device: GetScopes' 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. + 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.
Tested Camera Models @@ -380,40 +306,37 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetNetworkInterfacesResponse' + $ref: '#/components/schemas/device_GetScopesResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: acc3a74d-852a-4c0c-bf31-dbc06d8a0782 + id: 05f573f4-0836-45ad-b9ba-c393f9927586 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: NetworkInterfaces - origin: 1659655709817960400 + sourceName: Scopes + origin: 1659659228090509000 readings: - - id: 74571fe4-731a-4925-99eb-7d4c317834f6 - origin: 1659655709817960400 + - id: ea858652-cb16-432c-bf45-f9785cd00d85 + origin: 1659659228090509000 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: NetworkInterfaces + resourceName: Scopes profileName: onvif-camera valueType: Object value: '' objectValue: - NetworkInterfaces: - Enabled: true - IPv4: - Config: - DHCP: false - Manual: - Address: 10.0.0.195 - PrefixLength: 24 - Enabled: true - Info: - HwAddress: 10:27:F5:EA:88:F4 - MTU: 1500 - Name: eth0 - Token: eth0 + Scopes: + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/name/TP-IPC + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/hardware/MODEL + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/Profile/Streaming + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/location/ShenZhen + - ScopeDef: Fixed + ScopeItem: onvif://www.onvif.org/type/NetworkVideoTransmitter '400': *id001 '404': *id002 '423': *id003 @@ -421,15 +344,13 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkInterfaces + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetScopes put: tags: - - Network Configuration - summary: SetNetworkInterfaces + - Auto Discovery + summary: 'Device: SetScopes' 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. + 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.
Tested Camera Models @@ -439,7 +360,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -448,18 +369,15 @@ paths: application/json: schema: properties: - NetworkInterfaces: - $ref: '#/components/schemas/device_SetNetworkInterfaces' + Scopes: + $ref: '#/components/schemas/device_SetScopes' required: - - NetworkInterfaces + - Scopes type: object example: - NetworkInterfaces: - InterfaceToken: eth0 - NetworkInterface: - Enabled: true - IPv4: - DHCP: true + Scopes: + Scopes: + - http//:123 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -471,14 +389,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkInterfaces - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkProtocols: - get: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetScopes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveScopes: + put: tags: - - Network Configuration - summary: NetworkProtocols + - Auto Discovery + summary: 'Device: RemoveScopes' description: |- - This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols. + 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
Tested Camera Models @@ -488,15 +406,29 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
+ requestBody: + content: + application/json: + schema: + properties: + RemoveScopes: + $ref: '#/components/schemas/device_RemoveScopes' + required: + - RemoveScopes + type: object + example: + RemoveScopes: + ScopeItem: + - onvif://www.onvif.org/name/Geovision parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '200': - description: OK + '500': + description: Internal Server Error headers: Content-Type: schema: @@ -507,42 +439,95 @@ paths: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ObjectEventResponse' - - properties: - event: - properties: - readings: - items: - properties: - objectValue: - $ref: '#/components/schemas/device_GetNetworkProtocolsResponse' + type: object + example: + apiVersion: v2 + message: >- + request failed, status code: 500, err: + {"apiVersion":"v2","message":"error writing DeviceResourece + RemoveScopes for + Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 -\u003e + failed to execute write command, \u003cnil\u003e -\u003e + invalid request for the function 'RemoveScopes' of web service + 'Device'. Onvif error: fault reason: Trying to Remove scope + which does not exist, fault detail: , fault code: s:Sender + ter:InvalidArgVal ter:NoScope","statusCode":500} + statusCode: 500 + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.RemoveScopes + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Hostname: + get: + tags: + - Network Configuration + summary: 'Device: GetHostname' + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
+ parameters: + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetHostnameResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 193b3677-23c8-4d89-852e-73a1aabf445e + id: 6ad6d2d6-51af-4084-8a6a-952928942732 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: NetworkProtocols - origin: 1659671976670370300 + sourceName: Hostname + origin: 1659655574277981200 readings: - - id: d3a47ec4-3b43-413a-9a67-42f54487cfa5 - origin: 1659671976670370300 + - id: b8e4ba90-2aeb-4336-a5ca-923456cff383 + origin: 1659655574277981200 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: NetworkProtocols + resourceName: Hostname profileName: onvif-camera valueType: Object value: '' objectValue: - NetworkProtocols: - - Enabled: true - Name: HTTPS - Port: 443 - - Enabled: true - Name: RTSP - Port: 554 + HostnameInformation: + FromDHCP: false + Name: hostname '400': *id001 '404': *id002 '423': *id003 @@ -550,13 +535,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkProtocols + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetHostname put: tags: - Network Configuration - summary: SetNetworkProtocols + summary: 'Device: SetHostname' description: |- - This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command. + 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 formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings.
Tested Camera Models @@ -575,23 +561,14 @@ paths: application/json: schema: properties: - NetworkProtocols: - $ref: '#/components/schemas/device_SetNetworkProtocols' + Hostname: + $ref: '#/components/schemas/device_SetHostname' required: - - NetworkProtocols + - Hostname type: object example: - NetworkProtocols: - NetworkProtocols: - - Name: HTTP - Enabled: true - Port: 2020 - - Name: HTTPS - Enabled: false - Port: 443 - - Name: RTSP - Enabled: true - Port: 554 + Hostname: + Name: localhost555 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -603,14 +580,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkProtocols - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkDefaultGateway: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetHostname + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DNS: get: tags: - Network Configuration - summary: NetworkDefaultGateway + summary: 'Device: GetDNS' description: |- - This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es). + This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command.
Tested Camera Models @@ -648,27 +625,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetNetworkDefaultGatewayResponse' + $ref: '#/components/schemas/device_GetDNSResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 78915210-fab0-4018-a8ed-72f793c2cbc7 + id: d2d2541f-2feb-490f-bf89-b7407d3078d3 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: NetworkDefaultGateway - origin: 1659671987813255200 + sourceName: DNS + origin: 1659671999397808400 readings: - - id: c348128d-0c51-4470-a978-b431302906a0 - origin: 1659671987813255200 + - id: 3ad48fbe-1e98-4c90-a26e-f83a391c4d8c + origin: 1659671999397808400 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: NetworkDefaultGateway + resourceName: DNS profileName: onvif-camera valueType: Object value: '' objectValue: - NetworkGateway: {} + DNSInformation: {} '400': *id001 '404': *id002 '423': *id003 @@ -676,13 +653,13 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkDefaultGateway + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDNS put: tags: - Network Configuration - summary: SetNetworkDefaultGateway + summary: 'Device: SetDNS' description: |- - This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command. + This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command.
Tested Camera Models @@ -701,14 +678,17 @@ paths: application/json: schema: properties: - NetworkDefaultGateway: - $ref: '#/components/schemas/device_SetNetworkDefaultGateway' + DNS: + $ref: '#/components/schemas/device_SetDNS' required: - - NetworkDefaultGateway + - DNS type: object example: - NetworkDefaultGateway: - IPv4Address: 192.168.12.1 + DNS: + FromDHCP: true + DNSManual: + Type: IPv4 + IPv4Address: 192.168.12.1 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -720,15 +700,27 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkDefaultGateway - /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkConfiguration: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDNS + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkInterfaces: get: tags: - Network Configuration - summary: NetworkConfiguration - description: >- - Used to retrieve network resources for a device such as Hostname, DNS, - NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. + summary: 'Device: GetNetworkInterfaces' + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ✔️ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -744,40 +736,29 @@ paths: content: application/json: schema: - type: object + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/device_GetNetworkInterfacesResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: b34fe9d1-78f9-4b49-961b-80a252e084c4 + id: acc3a74d-852a-4c0c-bf31-dbc06d8a0782 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: NetworkConfiguration - origin: 1659656577804929300 + sourceName: NetworkInterfaces + origin: 1659655709817960400 readings: - - id: 67e318f5-4426-48ff-8235-4a2471e47baf - origin: 1659656577804929300 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: Hostname - profileName: onvif-camera - valueType: Object - value: '' - objectValue: - HostnameInformation: - FromDHCP: false - Name: hostname - - id: 76cfd2b5-f178-4d16-88d1-6b04f129a867 - origin: 1659656577804929300 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: DNS - profileName: onvif-camera - valueType: Object - value: '' - objectValue: - DNSInformation: {} - - id: 301b79ab-c92d-4a3f-9776-9a71f6c3c340 - origin: 1659656577804929300 + - id: 74571fe4-731a-4925-99eb-7d4c317834f6 + origin: 1659655709817960400 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 resourceName: NetworkInterfaces profileName: onvif-camera @@ -790,7 +771,7 @@ paths: Config: DHCP: false Manual: - Address: 10.0.0.188 + Address: 10.0.0.195 PrefixLength: 24 Enabled: true Info: @@ -798,89 +779,71 @@ paths: MTU: 1500 Name: eth0 Token: eth0 - - id: cc1d5230-06a8-4515-822e-187ba07d0efc - origin: 1659656577804929300 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: NetworkProtocols - profileName: onvif-camera - valueType: Object - value: '' - objectValue: - NetworkProtocols: - - Enabled: true - Name: HTTPS - Port: 443 - - Enabled: true - Name: RTSP - Port: 554 - - id: 81f9c4e6-1cfd-487a-a05b-b8ea5b39ffcf - origin: 1659656577804929300 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: NetworkDefaultGateway - profileName: onvif-camera - valueType: Object - value: '' - objectValue: - NetworkGateway: {} + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkInterfaces put: tags: - Network Configuration - summary: SetNetworkConfiguration - description: >- - Used to configure network resources for a device such as Hostname, DNS, - NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. - requestBody: - content: - application/json: - schema: - type: object - example: - Hostname: - Name: localhost - DNS: - FromDHCP: false - DNSManual: - Type: IPv4 - IPv4Address: 192.168.12.1 + summary: 'Device: SetNetworkInterfaces' + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
+ requestBody: + content: + application/json: + schema: + properties: NetworkInterfaces: - InterfaceToken: eth0 - NetworkInterface: - Enabled: true - IPv4: - DHCP: false - NetworkProtocols: - NetworkProtocols: - - Name: HTTP - Enabled: true - Port: 80 - NetworkDefaultGateway: - IPv4Address: 192.168.12.1 + $ref: '#/components/schemas/device_SetNetworkInterfaces' + required: + - NetworkInterfaces + type: object + example: + NetworkInterfaces: + InterfaceToken: eth0 + NetworkInterface: + Enabled: true + IPv4: + DHCP: true parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '200': - description: OK - headers: - Content-Type: - schema: - type: string - example: application/json - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - type: object - example: - apiVersion: v2 - statusCode: 200 - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeviceInformation: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkInterfaces + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkProtocols: get: tags: - - System Function - summary: DeviceInformation + - Network Configuration + summary: 'Device: GetNetworkProtocols' description: |- - This operation gets basic device information from the device. + This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols.
Tested Camera Models @@ -918,31 +881,33 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetDeviceInformationResponse' + $ref: '#/components/schemas/device_GetNetworkProtocolsResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: a025e1b1-7e2b-4db8-95b6-7dac978e9c97 + id: 193b3677-23c8-4d89-852e-73a1aabf445e deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: DeviceInformation - origin: 1659672857568971800 + sourceName: NetworkProtocols + origin: 1659671976670370300 readings: - - id: 3039ffbc-165a-46ef-849b-95c7df9aacfa - origin: 1659672857568971800 + - id: d3a47ec4-3b43-413a-9a67-42f54487cfa5 + origin: 1659671976670370300 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: DeviceInformation + resourceName: NetworkProtocols profileName: onvif-camera valueType: Object value: '' objectValue: - FirmwareVersion: 1.1.16 Build 211209 Rel.37726n(4555) - HardwareId: '1.0' - Manufacturer: TP-Link - Model: C200 - SerialNumber: 00c20000 + NetworkProtocols: + - Enabled: true + Name: HTTPS + Port: 443 + - Enabled: true + Name: RTSP + Port: 554 '400': *id001 '404': *id002 '423': *id003 @@ -950,16 +915,67 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDeviceInformation - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemDateAndTime: - get: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkProtocols + put: tags: - - System Function - summary: SystemDateAndTime + - Network Configuration + summary: 'Device: SetNetworkProtocols' 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. + This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command. - A device shall provide the UTCDateTime information. +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
+ requestBody: + content: + application/json: + schema: + properties: + NetworkProtocols: + $ref: '#/components/schemas/device_SetNetworkProtocols' + required: + - NetworkProtocols + type: object + example: + NetworkProtocols: + NetworkProtocols: + - Name: HTTP + Enabled: true + Port: 2020 + - Name: HTTPS + Enabled: false + Port: 443 + - Name: RTSP + Enabled: true + Port: 554 + parameters: + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkProtocols + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkDefaultGateway: + get: + tags: + - Network Configuration + summary: 'Device: GetNetworkDefaultGateway' + description: |- + This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es).
Tested Camera Models @@ -969,7 +985,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -997,51 +1013,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetSystemDateAndTimeResponse' + $ref: '#/components/schemas/device_GetNetworkDefaultGatewayResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: da6f552e-e4b3-4d75-a2ce-989745b8ef7b + id: 78915210-fab0-4018-a8ed-72f793c2cbc7 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: SystemDateAndTime - origin: 1659672865881317600 + sourceName: NetworkDefaultGateway + origin: 1659671987813255200 readings: - - id: aa61a541-beb5-4be0-bb7a-625ce60a980e - origin: 1659672865881317600 + - id: c348128d-0c51-4470-a978-b431302906a0 + origin: 1659671987813255200 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: SystemDateAndTime + resourceName: NetworkDefaultGateway profileName: onvif-camera valueType: Object value: '' objectValue: - SystemDateAndTime: - DateTimeType: NTP - DaylightSavings: true - Extension: '' - LocalDateTime: - Date: - Month: '8' - Year: '2022' - Day: '11' - Time: - Hour: '21' - Minute: '14' - Second: '25' - TimeZone: - TZ: > - GMT+08:00DST+07:00,M3.2.0/02:00:00,M11.1.0/02:00:00 - UTCDateTime: - Date: - Month: '8' - Year: '2022' - Day: '11' - Time: - Hour: '4' - Minute: '14' - Second: '25' + NetworkGateway: {} '400': *id001 '404': *id002 '423': *id003 @@ -1049,19 +1041,13 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetSystemDateAndTime + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetNetworkDefaultGateway put: tags: - - System Function - summary: SetSystemDateAndTime + - Network Configuration + summary: 'Device: SetNetworkDefaultGateway' 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. + This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command.
Tested Camera Models @@ -1071,7 +1057,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | Tapo does not support setting the `DaylightSavings` field to `false`. Regardless of the setting, the camera will always use daylight savings time. | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -1080,24 +1066,14 @@ paths: application/json: schema: properties: - SystemDateAndTime: - $ref: '#/components/schemas/device_SetSystemDateAndTime' + NetworkDefaultGateway: + $ref: '#/components/schemas/device_SetNetworkDefaultGateway' required: - - SystemDateAndTime + - NetworkDefaultGateway type: object example: - SystemDateAndTime: - DateTimeType: Manual - DaylightSavings: false - UTCDateTime: - Date: - Month: 12 - Year: 2021 - Day: 11 - Time: - Hour: 5 - Minute: 48 - Second: 20 + NetworkDefaultGateway: + IPv4Address: 192.168.12.1 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -1109,60 +1085,15 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemDateAndTime - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetSystemFactoryDefault: - put: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetNetworkDefaultGateway + /api/v2/device/name/{EDGEX_DEVICE_NAME}/NetworkConfiguration: + get: tags: - - System Function - summary: SetSystemFactoryDefault - description: |- - This operation reloads the parameters on the device to their factory default values. - -
- Tested Camera Models - - Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - - | Camera | Supported?    | Notes | - |--------|:------------|-------| - | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | -
- requestBody: - content: - application/json: - schema: - properties: - SetSystemFactoryDefault: - $ref: '#/components/schemas/device_SetSystemFactoryDefault' - required: - - SetSystemFactoryDefault - type: object - example: - SetSystemFactoryDefault: - FactoryDefault: Soft - parameters: - - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' - responses: - '200': *id006 - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemFactoryDefault - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RebootNeeded: - get: - tags: - - System Function - summary: RebootNeeded + - Network Configuration + summary: NetworkConfiguration description: >- - Indicates whether or not a reboot is required after configuration - updates. + Used to retrieve network resources for a device such as Hostname, DNS, + NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -1178,67 +1109,143 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/BoolEventResponse' + type: object example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: cb3b3a49-86e4-44e3-b2a0-426b08168ae1 + id: b34fe9d1-78f9-4b49-961b-80a252e084c4 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: RebootNeeded - origin: 1659672882772484400 + sourceName: NetworkConfiguration + origin: 1659656577804929300 readings: - - id: f56f48df-d664-4179-98d1-abcb496f07bc - origin: 1659672882772484400 + - id: 67e318f5-4426-48ff-8235-4a2471e47baf + origin: 1659656577804929300 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: RebootNeeded + resourceName: Hostname profileName: onvif-camera - valueType: Bool - value: 'false' - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemReboot: + valueType: Object + value: '' + objectValue: + HostnameInformation: + FromDHCP: false + Name: hostname + - id: 76cfd2b5-f178-4d16-88d1-6b04f129a867 + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: DNS + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + DNSInformation: {} + - id: 301b79ab-c92d-4a3f-9776-9a71f6c3c340 + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkInterfaces + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkInterfaces: + Enabled: true + IPv4: + Config: + DHCP: false + Manual: + Address: 10.0.0.188 + PrefixLength: 24 + Enabled: true + Info: + HwAddress: 10:27:F5:EA:88:F4 + MTU: 1500 + Name: eth0 + Token: eth0 + - id: cc1d5230-06a8-4515-822e-187ba07d0efc + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkProtocols + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkProtocols: + - Enabled: true + Name: HTTPS + Port: 443 + - Enabled: true + Name: RTSP + Port: 554 + - id: 81f9c4e6-1cfd-487a-a05b-b8ea5b39ffcf + origin: 1659656577804929300 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: NetworkDefaultGateway + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + NetworkGateway: {} put: tags: - - System Function - summary: SystemReboot + - Network Configuration + summary: SetNetworkConfiguration + description: >- + Used to configure network resources for a device such as Hostname, DNS, + NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway. requestBody: content: application/json: schema: - properties: - SystemReboot: - $ref: '#/components/schemas/device_SystemReboot' - required: - - SystemReboot type: object - example: - SystemReboot: {} + example: + Hostname: + Name: localhost + DNS: + FromDHCP: false + DNSManual: + Type: IPv4 + IPv4Address: 192.168.12.1 + NetworkInterfaces: + InterfaceToken: eth0 + NetworkInterface: + Enabled: true + IPv4: + DHCP: false + NetworkProtocols: + NetworkProtocols: + - Name: HTTP + Enabled: true + Port: 80 + NetworkDefaultGateway: + IPv4Address: 192.168.12.1 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '200': *id006 - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SystemReboot - description: This operation reboots the device. - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurations: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + type: object + example: + apiVersion: v2 + statusCode: 200 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeviceInformation: get: tags: - - Metadata Configuration - summary: MetadataConfigurations + - System Function + summary: 'Device: GetDeviceInformation' description: |- - This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command. + This operation gets basic device information from the device.
Tested Camera Models @@ -1248,7 +1255,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -1276,27 +1283,31 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetMetadataConfigurationsResponse' + $ref: '#/components/schemas/device_GetDeviceInformationResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 1acba723-b1b1-4790-8e80-9d554cacaedc + id: a025e1b1-7e2b-4db8-95b6-7dac978e9c97 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: MetadataConfigurations - origin: 1659659180814799600 + sourceName: DeviceInformation + origin: 1659672857568971800 readings: - - id: 8c59a3a8-401b-4e18-8af5-9a98efe7f410 - origin: 1659659180814799600 + - id: 3039ffbc-165a-46ef-849b-95c7df9aacfa + origin: 1659672857568971800 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: MetadataConfigurations + resourceName: DeviceInformation profileName: onvif-camera valueType: Object value: '' objectValue: - Configurations: {} + FirmwareVersion: 1.1.16 Build 211209 Rel.37726n(4555) + HardwareId: '1.0' + Manufacturer: TP-Link + Model: C200 + SerialNumber: 00c20000 '400': *id001 '404': *id002 '423': *id003 @@ -1304,14 +1315,16 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurations - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfiguration: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDeviceInformation + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemDateAndTime: get: tags: - - Metadata Configuration - summary: MetadataConfiguration + - System Function + summary: 'Device: GetSystemDateAndTime' description: |- - The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. + 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.
Tested Camera Models @@ -1321,33 +1334,11 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
parameters: - - name: jsonObject - in: query - schema: - type: string - example: '' - description: | - **Format:**
- This field is a Base64 encoded json string. - - **JSON Schema:** - ```yaml - { - "ConfigurationToken": "" - } - ``` - - **Field Descriptions:** - - **ConfigurationToken** _[string]_ -
Token of the requested metadata configuration. - - - **Schema Reference:** [media_GetMetadataConfiguration](#media_GetMetadataConfiguration) - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': @@ -1371,27 +1362,51 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetMetadataConfigurationResponse' + $ref: '#/components/schemas/device_GetSystemDateAndTimeResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 53480499-ece4-4437-b795-0ff4f57a564a - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + id: da6f552e-e4b3-4d75-a2ce-989745b8ef7b + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: MetadataConfiguration - origin: 1663974689815368400 + sourceName: SystemDateAndTime + origin: 1659672865881317600 readings: - - id: b6cda316-6a50-4990-8279-e2777be95c79 - origin: 1663974689815368400 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 - resourceName: MetadataConfiguration + - id: aa61a541-beb5-4be0-bb7a-625ce60a980e + origin: 1659672865881317600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: SystemDateAndTime profileName: onvif-camera valueType: Object value: '' objectValue: - Configuration: {} + SystemDateAndTime: + DateTimeType: NTP + DaylightSavings: true + Extension: '' + LocalDateTime: + Date: + Month: '8' + Year: '2022' + Day: '11' + Time: + Hour: '21' + Minute: '14' + Second: '25' + TimeZone: + TZ: > + GMT+08:00DST+07:00,M3.2.0/02:00:00,M11.1.0/02:00:00 + UTCDateTime: + Date: + Month: '8' + Year: '2022' + Day: '11' + Time: + Hour: '4' + Minute: '14' + Second: '25' '400': *id001 '404': *id002 '423': *id003 @@ -1399,13 +1414,19 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfiguration + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetSystemDateAndTime put: tags: - - Metadata Configuration - summary: SetMetadataConfiguration + - System Function + summary: 'Device: SetSystemDateAndTime' 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. + 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.
Tested Camera Models @@ -1415,7 +1436,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | Tapo does not support setting the `DaylightSavings` field to `false`. Regardless of the setting, the camera will always use daylight savings time. | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -1424,17 +1445,24 @@ paths: application/json: schema: properties: - MetadataConfiguration: - $ref: '#/components/schemas/media_SetMetadataConfiguration' + SystemDateAndTime: + $ref: '#/components/schemas/device_SetSystemDateAndTime' required: - - MetadataConfiguration + - SystemDateAndTime type: object example: - MetadataConfiguration: - ForcePersistence: true - Configuration: - token: '{{MEDIA_CONFIG_TOKEN}}' - Analytics: true + SystemDateAndTime: + DateTimeType: Manual + DaylightSavings: false + UTCDateTime: + Date: + Month: 12 + Year: 2021 + Day: 11 + Time: + Hour: 5 + Minute: 48 + Second: 20 parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -1446,14 +1474,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetMetadataConfiguration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CompatibleMetadataConfigurations: - get: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemDateAndTime + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SetSystemFactoryDefault: + put: tags: - - Metadata Configuration - summary: CompatibleMetadataConfigurations + - System Function + summary: 'Device: SetSystemFactoryDefault' 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. + This operation reloads the parameters on the device to their factory default values.
Tested Camera Models @@ -1463,42 +1491,44 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
+ requestBody: + content: + application/json: + schema: + properties: + SetSystemFactoryDefault: + $ref: '#/components/schemas/device_SetSystemFactoryDefault' + required: + - SetSystemFactoryDefault + type: object + example: + SetSystemFactoryDefault: + FactoryDefault: Soft + parameters: + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetSystemFactoryDefault + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RebootNeeded: + get: + tags: + - System Function + summary: RebootNeeded + description: >- + Indicates whether or not a reboot is required after configuration + updates. parameters: - - name: jsonObject - in: query - schema: - type: string - example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== - description: | - **Format:**
- This field is a Base64 encoded json string. - - **JSON Schema:** - ```yaml - { - "ProfileToken": "" - } - ``` - - **Field Descriptions:** - - **ProfileToken** _[string]_ -
Contains the token of an existing media profile the configurations shall be compatible with. - - - **Schema Reference:** [media_GetCompatibleMetadataConfigurations](#media_GetCompatibleMetadataConfigurations) - - **Example JSON:**
- > _Note: This value must be encoded to base64!_ - - ```json - { - "ProfileToken": "profile_1" - } - ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': @@ -1513,36 +1543,51 @@ paths: content: application/json: schema: - allOf: - - $ref: '#/components/schemas/ObjectEventResponse' - - properties: - event: - properties: - readings: - items: - properties: - objectValue: - $ref: '#/components/schemas/media_GetCompatibleMetadataConfigurationsResponse' + $ref: '#/components/schemas/BoolEventResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 410b5658-82d9-488c-a5c4-c69f0ff6d273 + id: cb3b3a49-86e4-44e3-b2a0-426b08168ae1 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: CompatibleMetadataConfigurations - origin: 1659659188300470500 + sourceName: RebootNeeded + origin: 1659672882772484400 readings: - - id: 86aa4298-c8ee-4c74-afc9-73104bb3cd11 - origin: 1659659188300470500 + - id: f56f48df-d664-4179-98d1-abcb496f07bc + origin: 1659672882772484400 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: CompatibleMetadataConfigurations + resourceName: RebootNeeded profileName: onvif-camera - valueType: Object - value: '' - objectValue: - Configurations: {} + valueType: Bool + value: 'false' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/SystemReboot: + put: + tags: + - System Function + summary: 'Device: SystemReboot' + requestBody: + content: + application/json: + schema: + properties: + SystemReboot: + $ref: '#/components/schemas/device_SystemReboot' + required: + - SystemReboot + type: object + example: + SystemReboot: {} + parameters: + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' + responses: + '200': *id006 '400': *id001 '404': *id002 '423': *id003 @@ -1550,14 +1595,15 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetCompatibleMetadataConfigurations - /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurationOptions: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SystemReboot + description: This operation reboots the device. + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Users: get: tags: - - Metadata Configuration - summary: MetadataConfigurationOptions + - User Handling + summary: 'Device: GetUsers' description: |- - This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. + 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.
Tested Camera Models @@ -1567,45 +1613,11 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
parameters: - - name: jsonObject - in: query - schema: - type: string - example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== - description: | - **Format:**
- This field is a Base64 encoded json string. - - **JSON Schema:** - ```yaml - { - "ConfigurationToken": "", - "ProfileToken": "" - } - ``` - - **Field Descriptions:** - - **ConfigurationToken** _[string]_ -
Optional metadata configuration token that specifies an existing configuration that the options are intended for. - - **ProfileToken** _[string]_ -
Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. - - - **Schema Reference:** [media_GetMetadataConfigurationOptions](#media_GetMetadataConfigurationOptions) - - **Example JSON:**
- > _Note: This value must be encoded to base64!_ - - ```json - { - "ProfileToken": "profile_1" - } - ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': @@ -1629,27 +1641,31 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetMetadataConfigurationOptionsResponse' + $ref: '#/components/schemas/device_GetUsersResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: f296e8b5-707f-4e66-9388-918821b83a19 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: 8e524ecd-674d-4dd8-b728-de78b8245189 + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 profileName: onvif-camera - sourceName: MetadataConfigurationOptions - origin: 1659659194429862100 + sourceName: Users + origin: 1664077238993899500 readings: - - id: f8efa15a-612d-4532-b40b-4e895cecb3bd - origin: 1659659194429862100 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: MetadataConfigurationOptions + - id: f5086b88-9876-4627-91d5-7ce39431652e + origin: 1664077238993899500 + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + resourceName: Users profileName: onvif-camera valueType: Object value: '' objectValue: - Options: {} + User: + - UserLevel: Administrator + Username: admin + - UserLevel: User + Username: user '400': *id001 '404': *id002 '423': *id003 @@ -1657,14 +1673,15 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurationOptions - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddMetadataConfiguration: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetUsers put: tags: - - Metadata Configuration - summary: AddMetadataConfiguration + - User Handling + summary: 'Device: SetUser' 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. + 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.
Tested Camera Models @@ -1674,7 +1691,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -1683,15 +1700,20 @@ paths: application/json: schema: properties: - AddMetadataConfiguration: - $ref: '#/components/schemas/media_AddMetadataConfiguration' + Users: + $ref: '#/components/schemas/device_SetUser' required: - - AddMetadataConfiguration + - Users type: object example: - AddMetadataConfiguration: - ProfileToken: profile_1 - ConfigurationToken: '{{MEDIA_CONFIG_TOKEN}}' + Users: + User: + - Username: user1 + Password: Password1! + UserLevel: Administrator + - Username: user2 + Password: Password1! + UserLevel: Operator parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -1703,14 +1725,16 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.AddMetadataConfiguration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveMetadataConfiguration: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetUser + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateUsers: put: tags: - - Metadata Configuration - summary: RemoveMetadataConfiguration + - User Handling + summary: 'Device: CreateUsers' 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. + 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.
Tested Camera Models @@ -1720,7 +1744,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -1729,14 +1753,20 @@ paths: application/json: schema: properties: - RemoveMetadataConfiguration: - $ref: '#/components/schemas/media_RemoveMetadataConfiguration' + CreateUsers: + $ref: '#/components/schemas/device_CreateUsers' required: - - RemoveMetadataConfiguration + - CreateUsers type: object example: - RemoveMetadataConfiguration: - ProfileToken: profile_1 + CreateUsers: + User: + - Username: user1 + Password: Password1! + UserLevel: User + - Username: user2 + Password: Password1! + UserLevel: User parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -1748,14 +1778,61 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.RemoveMetadataConfiguration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Profiles: + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.CreateUsers + /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteUsers: + put: + tags: + - User Handling + summary: 'Device: DeleteUsers' + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
+ requestBody: + content: + application/json: + schema: + properties: + DeleteUsers: + $ref: '#/components/schemas/device_DeleteUsers' + required: + - DeleteUsers + type: object + example: + DeleteUsers: + Username: + - user1 + - user2 + parameters: + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' + responses: + '200': *id006 + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.DeleteUsers + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurations: get: tags: - - Video Streaming - summary: Profiles + - Metadata Configuration + summary: 'Media: GetMetadataConfigurations' 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. + This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command.
Tested Camera Models @@ -1765,7 +1842,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -1793,259 +1870,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetProfilesResponse' + $ref: '#/components/schemas/media_GetMetadataConfigurationsResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: e6560b52-1952-4d66-9f53-3cf27d48b3c0 + id: 1acba723-b1b1-4790-8e80-9d554cacaedc deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: Profiles - origin: 1659656314715442700 + sourceName: MetadataConfigurations + origin: 1659659180814799600 readings: - - id: 5c7bc03c-308f-4b2c-8bc9-2e59da7d6f65 - origin: 1659656314715442700 + - id: 8c59a3a8-401b-4e18-8af5-9a98efe7f410 + origin: 1659659180814799600 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: Profiles + resourceName: MetadataConfigurations profileName: onvif-camera valueType: Object value: '' objectValue: - Profiles: - - AudioEncoderConfiguration: - Bitrate: 131072 - Encoding: G711 - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: AudioEncoder_1 - SampleRate: 8000 - SessionTimeout: PT0H1M5S - Token: microphone - UseCount: 2 - AudioSourceConfiguration: - Name: AudioSourceConfig - SourceToken: raw_as1 - Token: asconf - UseCount: 2 - Extension: - Fixed: true - MetadataConfiguration: - Name: mainStream - PTZConfiguration: - DefaultAbsolutePantTiltPositionSpace: >- - http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - DefaultContinuousPanTiltVelocitySpace: >- - http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - DefaultPTZSpeed: {} - DefaultPTZTimeout: PT0H0M20S - DefaultRelativePanTiltTranslationSpace: >- - http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - PanTiltLimits: - Range: - URI: '' - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: PTZConfiguration0 - Token: profile_1 - VideoAnalyticsConfiguration: - AnalyticsEngineConfiguration: - AnalyticsModule: - - Name: MyCellMotionModule - Parameters: - ElementItem: - - Name: Layout - SimpleItem: - - Name: Sensitivity - Value: medium - - Name: Enabled - Value: off - Type: tt:CellMotionEngine - - Name: MyTamperDetecModule - Parameters: - SimpleItem: - - Name: Sensitivity - - Name: Enabled - Type: tt:TamperEngine - Name: VideoAnalyticsName - RuleEngineConfiguration: - Rule: - Name: MyTamperDetectorRule - Parameters: - SimpleItem: - - Name: ActiveCells - Value: 0P8A8A== - - Name: MinCount - Value: '5' - - Name: AlarmOnDelay - Value: '1000' - - Name: AlarmOffDelay - Value: '1000' - Type: tt:TamperDetector - Token: VideoAnalyticsToken - UseCount: 2 - VideoEncoderConfiguration: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_1 - Quality: 3 - RateControl: - BitrateLimit: 1024 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 1080 - Width: 1920 - SessionTimeout: PT0H1M5S - Token: main - UseCount: 1 - VideoSourceConfiguration: - Bounds: - Height: 720 - Width: 1280 - X: 0 - Y: 0 - Extension: - Name: VideoSourceConfig - SourceToken: raw_vs1 - Token: vsconf - UseCount: 2 - ViewMode: '' - - AudioEncoderConfiguration: - Bitrate: 131072 - Encoding: G711 - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: AudioEncoder_1 - SampleRate: 8000 - SessionTimeout: PT0H1M5S - Token: microphone - UseCount: 2 - AudioSourceConfiguration: - Name: AudioSourceConfig - SourceToken: raw_as1 - Token: asconf - UseCount: 2 - Extension: - Fixed: true - MetadataConfiguration: - Name: minorStream - PTZConfiguration: - DefaultAbsolutePantTiltPositionSpace: >- - http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace - DefaultContinuousPanTiltVelocitySpace: >- - http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace - DefaultPTZSpeed: {} - DefaultPTZTimeout: PT0H0M20S - DefaultRelativePanTiltTranslationSpace: >- - http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace - PanTiltLimits: - Range: - URI: '' - XRange: - Max: 170 - Min: -170 - YRange: - Max: 35 - Min: -32 - Token: PTZConfiguration0 - Token: profile_2 - VideoAnalyticsConfiguration: - AnalyticsEngineConfiguration: - AnalyticsModule: - - Name: MyCellMotionModule - Parameters: - ElementItem: - - Name: Layout - SimpleItem: - - Name: Sensitivity - Value: medium - - Name: Enabled - Value: off - Type: tt:CellMotionEngine - - Name: MyTamperDetecModule - Parameters: - SimpleItem: - - Name: Sensitivity - - Name: Enabled - Type: tt:TamperEngine - Name: VideoAnalyticsName - RuleEngineConfiguration: - Rule: - Name: MyTamperDetectorRule - Parameters: - SimpleItem: - - Name: ActiveCells - Value: 0P8A8A== - - Name: MinCount - Value: '5' - - Name: AlarmOnDelay - Value: '1000' - - Name: AlarmOffDelay - Value: '1000' - Type: tt:TamperDetector - Token: VideoAnalyticsToken - UseCount: 2 - VideoEncoderConfiguration: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_2 - Quality: 3 - RateControl: - BitrateLimit: 256 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 360 - Width: 640 - SessionTimeout: PT0H1M5S - Token: minor - UseCount: 1 - VideoSourceConfiguration: - Bounds: - Height: 720 - Width: 1280 - X: 0 - Y: 0 - Extension: - Name: VideoSourceConfig - SourceToken: raw_vs1 - Token: vsconf - UseCount: 2 - ViewMode: '' + Configurations: {} '400': *id001 '404': *id002 '423': *id003 @@ -2053,23 +1898,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetProfiles - /api/v2/device/name/{EDGEX_DEVICE_NAME}/StreamUri: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfiguration: get: tags: - - Video Streaming - summary: StreamUri + - Metadata Configuration + summary: 'Media: GetMetadataConfiguration' 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. + The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known.
Tested Camera Models @@ -2079,7 +1915,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -2088,7 +1924,7 @@ paths: in: query schema: type: string - example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJTdHJlYW1TZXR1cCI6eyJTdHJlYW0iOiJSVFAtVW5pY2FzdCIsIlRyYW5zcG9ydCI6eyJQcm90b2NvbCI6IlJUU1AifX19 + example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiMSJ9 description: | **Format:**
This field is a Base64 encoded json string. @@ -2096,47 +1932,23 @@ paths: **JSON Schema:** ```yaml { - "ProfileToken": "", - "StreamSetup": { - "Stream": "RTP-Unicast|RTP-Multicast", - "Transport": { - "Protocol": "UDP|TCP|RTSP|HTTP", - "Tunnel": { $ref: onvif_Transport } - } - } + "ConfigurationToken": "" } ``` **Field Descriptions:** - - **ProfileToken** _[string]_ -
The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. - - **StreamSetup** _[object]_ -
Stream Setup that should be used with the uri - - **Stream** _[string]_ -
Defines if a multicast or unicast stream is requested -
_Enum: ['RTP-Unicast', 'RTP-Multicast']_ - - **Transport** _[object]_ - - **Protocol** _[string]_ -
Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP -
_Enum: ['UDP', 'TCP', 'RTSP', 'HTTP']_ - - **Tunnel** _[Recursive object of type [onvif_Transport](#onvif_Transport)]_ -
Optional element to describe further tunnel options. This element is normally not needed + - **ConfigurationToken** _[string]_ +
Token of the requested metadata configuration. - **Schema Reference:** [media_GetStreamUri](#media_GetStreamUri) + **Schema Reference:** [media_GetMetadataConfiguration](#media_GetMetadataConfiguration) **Example JSON:**
> _Note: This value must be encoded to base64!_ ```json { - "ProfileToken": "profile_1", - "StreamSetup": { - "Stream": "RTP-Unicast", - "Transport": { - "Protocol": "RTSP" - } - } + "ConfigurationToken": "1" } ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' @@ -2162,31 +1974,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetStreamUriResponse' + $ref: '#/components/schemas/media_GetMetadataConfigurationResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 0ef64d9b-ba26-49a9-9a9f-5ec6f7b47190 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: 53480499-ece4-4437-b795-0ff4f57a564a + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 profileName: onvif-camera - sourceName: StreamUri - origin: 1659656323588827000 + sourceName: MetadataConfiguration + origin: 1663974689815368400 readings: - - id: 255085ba-4399-489d-aa34-cab5e1379281 - origin: 1659656323588827000 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: StreamUri + - id: b6cda316-6a50-4990-8279-e2777be95c79 + origin: 1663974689815368400 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + resourceName: MetadataConfiguration profileName: onvif-camera valueType: Object value: '' objectValue: - MediaUri: - InvalidAfterConnect: false - InvalidAfterReboot: false - Timeout: PT0H0M2S - Uri: rtsp://10.0.0.188:554/stream1 + Configuration: {} '400': *id001 '404': *id002 '423': *id003 @@ -2194,16 +2002,13 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetStreamUri - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Snapshot: - get: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfiguration + put: tags: - - Video Streaming - summary: Snapshot + - Metadata Configuration + summary: 'Media: SetMetadataConfiguration' description: |- - This request returns a snapshot of the video stream at the time the command is given. - - It is returned in a binary format. + 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.
Tested Camera Models @@ -2214,62 +2019,89 @@ paths: |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | | **Tapo C200** | ❌ | | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | You must use `Digest Auth` or `Both` as the Auth-Mode in order for this to work. | - | **GeoVision GV-BX8700** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | |
+ requestBody: + content: + application/json: + schema: + properties: + MetadataConfiguration: + $ref: '#/components/schemas/media_SetMetadataConfiguration' + required: + - MetadataConfiguration + type: object + example: + MetadataConfiguration: + ForcePersistence: true + Configuration: + token: '1' + Analytics: true parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '200': - description: OK - headers: - Content-Type: - schema: - type: string - example: application/json - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - $ref: '#/components/schemas/BinaryEventResponse' - example: - apiVersion: v2 - statusCode: 200 - event: - apiVersion: v2 - id: 5fdf593f-2a92-4a71-b08c-791d7a27fdff - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - profileName: onvif-camera - sourceName: Snapshot - origin: 1665415500727830500 - readings: - - id: d04a9dad-feb9-4099-a524-8a4b4cf2cc37 - origin: 1665415500727830500 - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - resourceName: Snapshot - profileName: onvif-camera - valueType: Binary - binaryValue: >- - /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACAAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDzGwiBtoGx/wAs1/kK0BGPSotPH+g23/XFP5CreKxOyOwxVqTYuOlAWn7eKQFd1VQDtH3hUgtoz1QUsq/u2PoM1PikBCLWL+4KelkhOQSAOp3dKoX+sQWalVO+X0HasB9bumOfMP0oDmR2T6c/klt/4d/5VRvNOkhxvQrkcblH4/rmsaz8TT25bzP3qMCNp7Z9K3IvGcU0C211F5kROTnG4dOh7dKYXTMPysXeMV0MKgDpVC4+xTXiy2QkMXPDNuI4rRgGcUBYsqgFSgUiLUoFMmwzbU8a0wLzVmMAimMlij713+h2a2lhEpX52G5vxrj9Nthc3kUJGQx5HtXoUaYFBUELIgYZ2ivLviHKJ47tAoxDAyj8ia9TkkWGF5HOFUc15H4oJm03UZW5LQyH9DTiKo9DmdPQ/YbbH/PFP5CrgWoNNP8AxLbX/rin8hVwVIR2GBacFp4UU8LSAryL8hqrqF4LTTTICN54XNaEi/Ka5LXpi8kcfZF6e5oAxXcscmoy1KetMaqSMGLuGacGqIU8A02gNK0vWhTAJByDXX6bMLiFXXvXBxiur8NSMZBGx+X0rKRvTd3Y6VBUyjirM1uoCOg4bP5j/IqMJirTHKNhgFSxjmgJTo1IamSdL4Xh3X5fH3Vrs8Yrl/Csf7yZ/Yf1rqyKGaIyddlMemOF43naa8419c6HqJx/y7Sf+gmvQPExItIVHQuc/lXB6+MeH9SP/TtJ/wCgmtYGFU5jTVH9mWn/AFxT+Qq2FqjppP8AZ1qP+mKfyFaS9KxNI7ABTgKUCngDFICMjiuG1cEXsoPrXdtiuP8AEUW25V/7wNBMjnj1ptPbrTcc1Zix8MZedR2zzVuWEKpUDBBp1lDj5z+FWbiA7t46GspT1OmnT0uVbOHfLg9K9G0Lw8xtYLuAr5chYZZuflxk1wtpFtkz2r03w5K7aBdRXczrHbyRNGuBwH3A4+vH6UblU9GdHe2sP2Nx5iBtxK57np/9euaxTjfSSjBOBTQaqBdRp7CgU9Rg01aeOtUYnV+FjzN9BXUiuS8Ln/SWX1WuvUc0MtGJ4nQ/Z7Y44yf6VwfiEY8P6l/17Sf+gmvR/ESb9MiOORJ/MH/CvP8AxGn/ABT2pHt9lk/9BNbwOeocPp0MzWFqwdR+5T+Qq4ILr+8lJpqj+zbP/rhH/wCg1eVaxNY7FURXX95Kf9nu/wC+lWwKkAqWhmU7XKnBWsvWIxJYuzD5lwRXTyRFkIUZasPVrO5Ns6LBISeOmR+lAmjidhJp6QMx6VrLpk0Ry8R/KmPHtbGMVnKdg5CONdiYFWuGhwagqzEm5BWL1N4qxNZoN4wK9C1R/M0jSQEVWNth2A5faxVc/QAVwtpGVbPpXpviH+zrTR9Ks1niFxDHlgvcNz/P+daxYmjnIweKsqKbGqkDBzU6rWyMhB0p69aAlSpHVNEm1oD7L+L3OK7pBXnunnyriJ/Rga9CRuhpFplTWofM05sdVIavPfEq48Nap/16S/8AoBr064QTwPGf4gRXm/iZMeGtVyOlpLn/AL5NaQdkY1Fc4fTR/wASyz/64R/+gitFU4qrpUQ/sqyZ8qot48+v3RVpbiVFkiixhxg5QE/gSMj8KzNI7DguFLZGB1yRU9ncWRLLc7xgfK688+mPSs1oHbr+tK6i3i3NwPWpGaUVxam4wqMAOjMe/wBKW8vbSGM+dIq56AnrXPPeSSf8e2UTvIR/IUiwRiOS6nbeQPvSck0mxsklubedW8mVW9s1nOFOeBVS65BuYE8tg33R3FSRP5ihgeDUNDI3t1ZvkGCe1WLa3YcEVNboplBIq/GirIDjjvUuJdN62Io4SozViOEzq4X74rUisEnjPkgucZwAc04RQ2MrJEfMZ12yHHAPfFZ6nZaJjQve2hyrnGehGQa7BrcMsUsQIiliWQE+pHI/A5H4VkSxqyHI6dvSum0TbqPh2W3zmeyJdB3MZ64+h5/GtoHNWguhnhcdadkZ4pWpoHNanMWYeor0G1ffBG2eqivPYuldxob79PXnOKBo0+1cL42h8rQ9ZHrZyn/xw13ijNcj4/hx4c1WT1sZh+SGriRI820qEyaZp/p9mj/9BFX/ALKELEjHyk1Z0qK3g8M6bPMQo+yQkk+6CqNzJc3zYhR0i6Db94/X0qTSOxBcXKR/u41MkvoOg+pqolpNeEGYb8fgo/DvWpDpSR7TIM8Z254/+vV4g8jtxxQBhLZbPv8AJxj2rO1k+UkcC/Vh/KukkT94KwdcXzbmCJRl8HP41IGBGXkcKo9eKfYj9y6n7ytW9Y6X9nUtImZT+lZWwWepTQkYWTFS0ImgilyCBVxGYfeHNWEgCqAKUw07DLNrfvAwaGRo3HQqcVNJ4j1JeWuBKAc/vYlfH0yKzfLxUU/EJpWK5mbNv4kt7ydY9StIgrHDS267Hx/ujg/lWnaXn/CO67b3sJM9jJkpIoIEsZ4I+o9PUVwg4OeldZ4d1GC7h/si+ZVhIzDKesT+v0PQ/wD1qaQc76nS3doslst/asj28nQK2Sh9D+uKoVZ0OO7sdSksJ4d0E64kiZlyfQqSeTyDx1pLu0ksrh4ZR8ynGexHqKohjI+ldd4ZkzbyR+hBrkYq6Xw04W4ZP7woBHVKOK5vx9Hu8Fas392zm/8AQDXTAVheN03+BtcA6ixmP/jhoTJkeZeHLO717TtOjJKWsFtEq8dwgGa6+TSI7WFYoo8d/c1ifDS8M1ra2RXIS3VgfbA6/mK7u5T94D6AD880zWOxxU0Oxm44BqnIPmf6VuXsWC59WNY7rjf+FANFJxjrWNEq3XiBuMiPp9f8mtq6bylZj0GKo+H7cOs923LSNwfYf/XzQKxcljwM4rkNfQpepMBkcV2tyMRmuU1yJpIjjtzQFjT2DaCPTNMJpdOzLpcUjctt5PrSN1pNA0Rmqs/3TVo1Vn+6akCi9EZ/eDmnPUaffBpCO80u7l1fTWtnAluI1zbydHXH8Oe4PTnuRWvaX8eu2yQ3Mu27hG1JG4Dj0Y/ng/nWH4UMQdAW2kNuVj0Hrn/Pb61P4gtRo2us8OPKb54+OxP9Dx+FaDZfMTRMVdSpBxg1q6LKIr6LJwCcU2yceIbMTmBI5EGxpI3ySccbl9Kr2hMcqHuDQQeg1i+M/wDkR9e/7B8//otq2QQyhhyCMg1jeMv+RH1//sHT/wDotqhEyPK/BVzNptnZ6pAhkighjS6XuFIHP0+6fqK9ZiCXUMkqOGVgpUjuMZz+teWeE3XTH0l35tru0ijnB6cxjr7cg13VnIfDepCwlY/2bdHNu78+W3dCfx4qzaOwavCqwu4HaudnGE3Y9K7PVYF+zyrjI25FchIM24GOQcH8KCjn9dfZa3PbGz9RV7TrT7JYRRbcYHP1qjrdu1zfQQJ/y3Khh64P+Ga2ieKDMqXY+Suc1FC6sAOororr7hrHukySfagaZR0K7zpzI3WJsEexq64RvmQ9e1ZGiyiLUrq2b+Mfyz/jWq8TQZK8x9vagZC/ANUZjk1cnOY2+lZrNkVBJHIeaYpwaefmBpi9aQjc0q+e2ZSDxmuo1S5i1rTkjRv9Ig+aMqOq/wAQ/kR9CPSuDSUoKtW+rzWjAxvg1SYzsfD815YKZIbqAQvjzY2BLcfh/UVsEICrxNlHG9T/AD/XIrz2PV5RNuAVAeyjArqfD9691DJGzjMeHUH0PDY/Hb+tO4HpumS+bpsDbs8YNUPGX/Ij6/8A9g6f/wBFtS+HHLWTgn7r8UnjL/kR9f8A+wdP/wCi2oM5H//Z - mediaType: image/jpeg - value: '' + '200': *id006 '400': *id001 '404': *id002 '423': *id003 '500': *id004 '503': *id005 - /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetVideoEncoderConfigurations: + externalDocs: + description: Onvif Specification + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetMetadataConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/CompatibleMetadataConfigurations: get: tags: - - Video Encoder Configuration - summary: VideoEncoderConfigurations - 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. + - Metadata Configuration + summary: 'Media: GetCompatibleMetadataConfigurations' + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Hikvision DFI6256TE** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | + | **GeoVision GV-BX8700** | ✔️ | | +
parameters: + - name: jsonObject + in: query + schema: + type: string + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ProfileToken** _[string]_ +
Contains the token of an existing media profile the configurations shall be compatible with. + + + **Schema Reference:** [media_GetCompatibleMetadataConfigurations](#media_GetCompatibleMetadataConfigurations) + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ProfileToken": "profile_1" + } + ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': @@ -2293,50 +2125,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetVideoEncoderConfigurationsResponse' + $ref: '#/components/schemas/media_GetCompatibleMetadataConfigurationsResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 1ee4ca7f-fb95-46b3-8e6d-8542b45b22d4 + id: 410b5658-82d9-488c-a5c4-c69f0ff6d273 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: GetVideoEncoderConfigurations - origin: 1659659203023412500 + sourceName: CompatibleMetadataConfigurations + origin: 1659659188300470500 readings: - - id: dd2b4e0e-9a62-49bc-a80b-071d4b1ed8e1 - origin: 1659659203023412500 + - id: 86aa4298-c8ee-4c74-afc9-73104bb3cd11 + origin: 1659659188300470500 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: GetVideoEncoderConfigurations + resourceName: CompatibleMetadataConfigurations profileName: onvif-camera valueType: Object value: '' objectValue: - Configurations: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_2 - Quality: 3 - RateControl: - BitrateLimit: 256 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 360 - Width: 640 - SessionTimeout: PT0H1M5S - Token: minor - UseCount: 1 + Configurations: {} '400': *id001 '404': *id002 '423': *id003 @@ -2344,14 +2153,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurations - /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfiguration: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetCompatibleMetadataConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/MetadataConfigurationOptions: get: tags: - - Video Encoder Configuration - summary: VideoEncoderConfiguration + - Metadata Configuration + summary: 'Media: GetMetadataConfigurationOptions' description: |- - If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. + This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration.
Tested Camera Models @@ -2361,7 +2170,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -2370,7 +2179,7 @@ paths: in: query schema: type: string - example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0= + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEifQ== description: | **Format:**
This field is a Base64 encoded json string. @@ -2378,23 +2187,26 @@ paths: **JSON Schema:** ```yaml { - "ConfigurationToken": "" + "ConfigurationToken": "", + "ProfileToken": "" } ``` **Field Descriptions:** - **ConfigurationToken** _[string]_ -
Token of the requested video encoder configuration. +
Optional metadata configuration token that specifies an existing configuration that the options are intended for. + - **ProfileToken** _[string]_ +
Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. - **Schema Reference:** [media_GetVideoEncoderConfiguration](#media_GetVideoEncoderConfiguration) + **Schema Reference:** [media_GetMetadataConfigurationOptions](#media_GetMetadataConfigurationOptions) **Example JSON:**
> _Note: This value must be encoded to base64!_ ```json { - "ConfigurationToken": "main" + "ProfileToken": "profile_1" } ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' @@ -2420,50 +2232,27 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/media_GetVideoEncoderConfigurationResponse' + $ref: '#/components/schemas/media_GetMetadataConfigurationOptionsResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 598079d0-d169-4385-86f3-cb7a106345a5 + id: f296e8b5-707f-4e66-9388-918821b83a19 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: VideoEncoderConfiguration - origin: 1659659207626081000 + sourceName: MetadataConfigurationOptions + origin: 1659659194429862100 readings: - - id: 86aed436-65cb-4162-b3e6-14def8e4e4d3 - origin: 1659659207626081000 + - id: f8efa15a-612d-4532-b40b-4e895cecb3bd + origin: 1659659194429862100 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: VideoEncoderConfiguration + resourceName: MetadataConfigurationOptions profileName: onvif-camera valueType: Object value: '' objectValue: - Configuration: - Encoding: H264 - H264: - GovLength: 25 - H264Profile: Main - Multicast: - Address: - IPv4Address: 0.0.0.0 - Type: IPv4 - AutoStart: false - Port: 0 - TTL: 0 - Name: VideoEncoder_1 - Quality: 3 - RateControl: - BitrateLimit: 1024 - EncodingInterval: 1 - FrameRateLimit: 15 - Resolution: - Height: 1080 - Width: 1920 - SessionTimeout: PT0H1M5S - Token: main - UseCount: 1 + Options: {} '400': *id001 '404': *id002 '423': *id003 @@ -2471,15 +2260,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfiguration + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetMetadataConfigurationOptions + /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddMetadataConfiguration: put: tags: - - Video Encoder Configuration - summary: SetVideoEncoderConfiguration + - Metadata Configuration + summary: 'Media: AddMetadataConfiguration' 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. + 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.
Tested Camera Models @@ -2498,76 +2286,34 @@ paths: application/json: schema: properties: - VideoEncoderConfiguration: - $ref: '#/components/schemas/media_SetVideoEncoderConfiguration' + AddMetadataConfiguration: + $ref: '#/components/schemas/media_AddMetadataConfiguration' required: - - VideoEncoderConfiguration + - AddMetadataConfiguration type: object example: - VideoEncoderConfiguration: - ForcePersistence: false - Configuration: - token: main - Encoding: H264 - Quality: 3 - Resolution: - Width: 1920 - Height: 1080 - Multicast: - Address: - Type: IPv4 - IPv4Address: 0.0.0.0 - Port: 8860 - TTL: 1 - AutoStart: false + AddMetadataConfiguration: + ProfileToken: profile_1 + ConfigurationToken: '1' parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '500': - description: Internal Server Error - headers: - Content-Type: - schema: - type: string - example: application/json - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - type: object - example: - apiVersion: v2 - message: >- - request failed, status code: 500, err: - {"apiVersion":"v2","message":"error writing DeviceResourece - VideoEncoderConfiguration for - TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e - failed to execute write command, \u003cnil\u003e -\u003e - invalid request for the function - 'SetVideoEncoderConfiguration' of web service 'Media'. Onvif - error: fault reason: , fault detail: , fault code: - SOAP-ENV:Sender ","statusCode":500} - statusCode: 500 '200': *id006 '400': *id001 '404': *id002 '423': *id003 + '500': *id004 '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetVideoEncoderConfiguration - /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfigurationOptions: - get: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.AddMetadataConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveMetadataConfiguration: + put: tags: - - Video Encoder Configuration - summary: VideoEncoderConfigurationOptions + - Metadata Configuration + summary: 'Media: RemoveMetadataConfiguration' 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. + 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.
Tested Camera Models @@ -2577,135 +2323,27 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
- parameters: - - name: jsonObject - in: query - schema: - type: string - example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0= - description: | - **Format:**
- This field is a Base64 encoded json string. - - **JSON Schema:** - ```yaml - { - "ConfigurationToken": "", - "ProfileToken": "" - } - ``` - - **Field Descriptions:** - - **ConfigurationToken** _[string]_ -
Optional video encoder configuration token that specifies an existing configuration that the options are intended for. - - **ProfileToken** _[string]_ -
Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. - - - **Schema Reference:** [media_GetVideoEncoderConfigurationOptions](#media_GetVideoEncoderConfigurationOptions) - - **Example JSON:**
- > _Note: This value must be encoded to base64!_ - - ```json - { - "ProfileToken": "profile_1", - "ConfigurationToken": "main" - } - ``` + requestBody: + content: + application/json: + schema: + properties: + RemoveMetadataConfiguration: + $ref: '#/components/schemas/media_RemoveMetadataConfiguration' + required: + - RemoveMetadataConfiguration + type: object + example: + RemoveMetadataConfiguration: + ProfileToken: profile_1 + parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '200': - description: OK - headers: - Content-Type: - schema: - type: string - example: application/json - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - allOf: - - $ref: '#/components/schemas/ObjectEventResponse' - - properties: - event: - properties: - readings: - items: - properties: - objectValue: - $ref: '#/components/schemas/media_GetVideoEncoderConfigurationOptionsResponse' - example: - apiVersion: v2 - statusCode: 200 - event: - apiVersion: v2 - id: 187b2e94-6efe-421f-b618-186a20fd41df - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - profileName: onvif-camera - sourceName: VideoEncoderConfigurationOptions - origin: 1659659212171416600 - readings: - - id: 0b709715-f644-4cf0-a477-dcc3b5ef218c - origin: 1659659212171416600 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: VideoEncoderConfigurationOptions - profileName: onvif-camera - valueType: Object - value: '' - objectValue: - Options: - Extension: - H264: - BitrateRange: - Max: 1024 - Min: 256 - EncodingIntervalRange: - Max: 1 - Min: 1 - FrameRateRange: - Max: 15 - Min: 1 - GovLengthRange: - Max: 25 - Min: 25 - H264ProfilesSupported: - - Main - ResolutionsAvailable: - - Height: 1080 - Width: 1920 - - Height: 720 - Width: 1280 - - Height: 360 - Width: 640 - H264: - EncodingIntervalRange: - Max: 1 - Min: 1 - FrameRateRange: - Max: 15 - Min: 1 - GovLengthRange: - Max: 25 - Min: 25 - H264ProfilesSupported: - - Main - ResolutionsAvailable: - - Height: 1080 - Width: 1920 - - Height: 720 - Width: 1280 - - Height: 360 - Width: 640 - QualityRange: - Max: 5 - Min: 1 + '200': *id006 '400': *id001 '404': *id002 '423': *id003 @@ -2713,14 +2351,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurationOptions - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Users: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.RemoveMetadataConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Profiles: get: tags: - - User Handling - summary: Get users + - Video Streaming + summary: 'Media: GetProfiles' 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. + 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.
Tested Camera Models @@ -2730,7 +2368,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -2758,136 +2396,259 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetUsersResponse' + $ref: '#/components/schemas/media_GetProfilesResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 8e524ecd-674d-4dd8-b728-de78b8245189 - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + id: e6560b52-1952-4d66-9f53-3cf27d48b3c0 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: Users - origin: 1664077238993899500 + sourceName: Profiles + origin: 1659656314715442700 readings: - - id: f5086b88-9876-4627-91d5-7ce39431652e - origin: 1664077238993899500 - deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 - resourceName: Users + - id: 5c7bc03c-308f-4b2c-8bc9-2e59da7d6f65 + origin: 1659656314715442700 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: Profiles profileName: onvif-camera valueType: Object value: '' objectValue: - User: - - UserLevel: Administrator - Username: admin - - UserLevel: User - Username: user - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetUsers - put: - tags: - - User Handling - summary: Set users - 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. - -
- Tested Camera Models - - Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - - | Camera | Supported?    | Notes | - |--------|:------------|-------| - | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | -
- requestBody: - content: - application/json: - schema: - properties: - Users: - $ref: '#/components/schemas/device_SetUser' - required: - - Users - type: object - example: - Users: - User: - - Username: user1 - Password: Password1! - UserLevel: Administrator - - Username: user2 - Password: Password1! - UserLevel: Operator - parameters: - - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' - responses: - '200': *id006 - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetUser - /api/v2/device/name/{EDGEX_DEVICE_NAME}/CreateUsers: - put: - tags: - - User Handling - summary: Create Users - 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. - -
- Tested Camera Models - - Below is a list of camera models that this command has been tested against, and whether or not the command is supported. - - | Camera | Supported?    | Notes | - |--------|:------------|-------| - | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | -
- requestBody: - content: - application/json: - schema: - properties: - CreateUsers: - $ref: '#/components/schemas/device_CreateUsers' - required: - - CreateUsers - type: object - example: - CreateUsers: - User: - - Username: user1 - Password: Password1! - UserLevel: User - - Username: user2 - Password: Password1! - UserLevel: User - parameters: - - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' - responses: - '200': *id006 + Profiles: + - AudioEncoderConfiguration: + Bitrate: 131072 + Encoding: G711 + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: AudioEncoder_1 + SampleRate: 8000 + SessionTimeout: PT0H1M5S + Token: microphone + UseCount: 2 + AudioSourceConfiguration: + Name: AudioSourceConfig + SourceToken: raw_as1 + Token: asconf + UseCount: 2 + Extension: + Fixed: true + MetadataConfiguration: + Name: mainStream + PTZConfiguration: + DefaultAbsolutePantTiltPositionSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + DefaultContinuousPanTiltVelocitySpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + DefaultPTZSpeed: {} + DefaultPTZTimeout: PT0H0M20S + DefaultRelativePanTiltTranslationSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + PanTiltLimits: + Range: + URI: '' + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + Token: PTZConfiguration0 + Token: profile_1 + VideoAnalyticsConfiguration: + AnalyticsEngineConfiguration: + AnalyticsModule: + - Name: MyCellMotionModule + Parameters: + ElementItem: + - Name: Layout + SimpleItem: + - Name: Sensitivity + Value: medium + - Name: Enabled + Value: off + Type: tt:CellMotionEngine + - Name: MyTamperDetecModule + Parameters: + SimpleItem: + - Name: Sensitivity + - Name: Enabled + Type: tt:TamperEngine + Name: VideoAnalyticsName + RuleEngineConfiguration: + Rule: + Name: MyTamperDetectorRule + Parameters: + SimpleItem: + - Name: ActiveCells + Value: 0P8A8A== + - Name: MinCount + Value: '5' + - Name: AlarmOnDelay + Value: '1000' + - Name: AlarmOffDelay + Value: '1000' + Type: tt:TamperDetector + Token: VideoAnalyticsToken + UseCount: 2 + VideoEncoderConfiguration: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_1 + Quality: 3 + RateControl: + BitrateLimit: 1024 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 1080 + Width: 1920 + SessionTimeout: PT0H1M5S + Token: main + UseCount: 1 + VideoSourceConfiguration: + Bounds: + Height: 720 + Width: 1280 + X: 0 + Y: 0 + Extension: + Name: VideoSourceConfig + SourceToken: raw_vs1 + Token: vsconf + UseCount: 2 + ViewMode: '' + - AudioEncoderConfiguration: + Bitrate: 131072 + Encoding: G711 + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: AudioEncoder_1 + SampleRate: 8000 + SessionTimeout: PT0H1M5S + Token: microphone + UseCount: 2 + AudioSourceConfiguration: + Name: AudioSourceConfig + SourceToken: raw_as1 + Token: asconf + UseCount: 2 + Extension: + Fixed: true + MetadataConfiguration: + Name: minorStream + PTZConfiguration: + DefaultAbsolutePantTiltPositionSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace + DefaultContinuousPanTiltVelocitySpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace + DefaultPTZSpeed: {} + DefaultPTZTimeout: PT0H0M20S + DefaultRelativePanTiltTranslationSpace: >- + http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace + PanTiltLimits: + Range: + URI: '' + XRange: + Max: 170 + Min: -170 + YRange: + Max: 35 + Min: -32 + Token: PTZConfiguration0 + Token: profile_2 + VideoAnalyticsConfiguration: + AnalyticsEngineConfiguration: + AnalyticsModule: + - Name: MyCellMotionModule + Parameters: + ElementItem: + - Name: Layout + SimpleItem: + - Name: Sensitivity + Value: medium + - Name: Enabled + Value: off + Type: tt:CellMotionEngine + - Name: MyTamperDetecModule + Parameters: + SimpleItem: + - Name: Sensitivity + - Name: Enabled + Type: tt:TamperEngine + Name: VideoAnalyticsName + RuleEngineConfiguration: + Rule: + Name: MyTamperDetectorRule + Parameters: + SimpleItem: + - Name: ActiveCells + Value: 0P8A8A== + - Name: MinCount + Value: '5' + - Name: AlarmOnDelay + Value: '1000' + - Name: AlarmOffDelay + Value: '1000' + Type: tt:TamperDetector + Token: VideoAnalyticsToken + UseCount: 2 + VideoEncoderConfiguration: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_2 + Quality: 3 + RateControl: + BitrateLimit: 256 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 360 + Width: 640 + SessionTimeout: PT0H1M5S + Token: minor + UseCount: 1 + VideoSourceConfiguration: + Bounds: + Height: 720 + Width: 1280 + X: 0 + Y: 0 + Extension: + Name: VideoSourceConfig + SourceToken: raw_vs1 + Token: vsconf + UseCount: 2 + ViewMode: '' '400': *id001 '404': *id002 '423': *id003 @@ -2895,14 +2656,23 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.CreateUsers - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DeleteUsers: - put: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetProfiles + /api/v2/device/name/{EDGEX_DEVICE_NAME}/StreamUri: + get: tags: - - User Handling - summary: Delete users + - Video Streaming + summary: 'Media: GetStreamUri' 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. + 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.
Tested Camera Models @@ -2912,29 +2682,114 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | Tapo returns `200 OK` for all User Management commands, but none of them actually do anything. The only way to modify the users is through the Tapo app. | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
- requestBody: - content: - application/json: - schema: - properties: - DeleteUsers: - $ref: '#/components/schemas/device_DeleteUsers' - required: - - DeleteUsers - type: object - example: - DeleteUsers: - Username: - - user1 - - user2 parameters: + - name: jsonObject + in: query + schema: + type: string + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJTdHJlYW1TZXR1cCI6eyJTdHJlYW0iOiJSVFAtVW5pY2FzdCIsIlRyYW5zcG9ydCI6eyJQcm90b2NvbCI6IlJUU1AifX19 + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ProfileToken": "", + "StreamSetup": { + "Stream": "RTP-Unicast|RTP-Multicast", + "Transport": { + "Protocol": "UDP|TCP|RTSP|HTTP", + "Tunnel": { $ref: onvif_Transport } + } + } + } + ``` + + **Field Descriptions:** + - **ProfileToken** _[string]_ +
The ProfileToken element indicates the media profile to use and will define the configuration of the content of the stream. + - **StreamSetup** _[object]_ +
Stream Setup that should be used with the uri + - **Stream** _[string]_ +
Defines if a multicast or unicast stream is requested +
_Enum: ['RTP-Unicast', 'RTP-Multicast']_ + - **Transport** _[object]_ + - **Protocol** _[string]_ +
Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TCP or HTTP=RTP/RTSP/HTTP/TCP +
_Enum: ['UDP', 'TCP', 'RTSP', 'HTTP']_ + - **Tunnel** _[Recursive object of type [onvif_Transport](#onvif_Transport)]_ +
Optional element to describe further tunnel options. This element is normally not needed + + + **Schema Reference:** [media_GetStreamUri](#media_GetStreamUri) + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ProfileToken": "profile_1", + "StreamSetup": { + "Stream": "RTP-Unicast", + "Transport": { + "Protocol": "RTSP" + } + } + } + ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '200': *id006 + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetStreamUriResponse' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 0ef64d9b-ba26-49a9-9a9f-5ec6f7b47190 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: StreamUri + origin: 1659656323588827000 + readings: + - id: 255085ba-4399-489d-aa34-cab5e1379281 + origin: 1659656323588827000 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: StreamUri + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + MediaUri: + InvalidAfterConnect: false + InvalidAfterReboot: false + Timeout: PT0H0M2S + Uri: rtsp://10.0.0.188:554/stream1 '400': *id001 '404': *id002 '423': *id003 @@ -2942,14 +2797,16 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.DeleteUsers - /api/v2/device/name/{EDGEX_DEVICE_NAME}/DiscoveryMode: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetStreamUri + /api/v2/device/name/{EDGEX_DEVICE_NAME}/Snapshot: get: tags: - - Auto Discovery - summary: GetDiscoveryMode + - Video Streaming + summary: Snapshot 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. + This request returns a snapshot of the video stream at the time the command is given. + + It is returned in a binary format.
Tested Camera Models @@ -2959,12 +2816,64 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | + | **Tapo C200** | ❌ | | + | **BOSCH DINION IP starlight 6000 HD** | ✔️ | You must use `Digest Auth` or `Both` as the Auth-Mode in order for this to work. | + | **GeoVision GV-BX8700** | ❌ | |
parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' + responses: + '200': + description: OK + headers: + Content-Type: + schema: + type: string + example: application/json + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + $ref: '#/components/schemas/BinaryEventResponse' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 5fdf593f-2a92-4a71-b08c-791d7a27fdff + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + profileName: onvif-camera + sourceName: Snapshot + origin: 1665415500727830500 + readings: + - id: d04a9dad-feb9-4099-a524-8a4b4cf2cc37 + origin: 1665415500727830500 + deviceName: Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 + resourceName: Snapshot + profileName: onvif-camera + valueType: Binary + binaryValue: >- + /9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACAAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDzGwiBtoGx/wAs1/kK0BGPSotPH+g23/XFP5CreKxOyOwxVqTYuOlAWn7eKQFd1VQDtH3hUgtoz1QUsq/u2PoM1PikBCLWL+4KelkhOQSAOp3dKoX+sQWalVO+X0HasB9bumOfMP0oDmR2T6c/klt/4d/5VRvNOkhxvQrkcblH4/rmsaz8TT25bzP3qMCNp7Z9K3IvGcU0C211F5kROTnG4dOh7dKYXTMPysXeMV0MKgDpVC4+xTXiy2QkMXPDNuI4rRgGcUBYsqgFSgUiLUoFMmwzbU8a0wLzVmMAimMlij713+h2a2lhEpX52G5vxrj9Nthc3kUJGQx5HtXoUaYFBUELIgYZ2ivLviHKJ47tAoxDAyj8ia9TkkWGF5HOFUc15H4oJm03UZW5LQyH9DTiKo9DmdPQ/YbbH/PFP5CrgWoNNP8AxLbX/rin8hVwVIR2GBacFp4UU8LSAryL8hqrqF4LTTTICN54XNaEi/Ka5LXpi8kcfZF6e5oAxXcscmoy1KetMaqSMGLuGacGqIU8A02gNK0vWhTAJByDXX6bMLiFXXvXBxiur8NSMZBGx+X0rKRvTd3Y6VBUyjirM1uoCOg4bP5j/IqMJirTHKNhgFSxjmgJTo1IamSdL4Xh3X5fH3Vrs8Yrl/Csf7yZ/Yf1rqyKGaIyddlMemOF43naa8419c6HqJx/y7Sf+gmvQPExItIVHQuc/lXB6+MeH9SP/TtJ/wCgmtYGFU5jTVH9mWn/AFxT+Qq2FqjppP8AZ1qP+mKfyFaS9KxNI7ABTgKUCngDFICMjiuG1cEXsoPrXdtiuP8AEUW25V/7wNBMjnj1ptPbrTcc1Zix8MZedR2zzVuWEKpUDBBp1lDj5z+FWbiA7t46GspT1OmnT0uVbOHfLg9K9G0Lw8xtYLuAr5chYZZuflxk1wtpFtkz2r03w5K7aBdRXczrHbyRNGuBwH3A4+vH6UblU9GdHe2sP2Nx5iBtxK57np/9euaxTjfSSjBOBTQaqBdRp7CgU9Rg01aeOtUYnV+FjzN9BXUiuS8Ln/SWX1WuvUc0MtGJ4nQ/Z7Y44yf6VwfiEY8P6l/17Sf+gmvR/ESb9MiOORJ/MH/CvP8AxGn/ABT2pHt9lk/9BNbwOeocPp0MzWFqwdR+5T+Qq4ILr+8lJpqj+zbP/rhH/wCg1eVaxNY7FURXX95Kf9nu/wC+lWwKkAqWhmU7XKnBWsvWIxJYuzD5lwRXTyRFkIUZasPVrO5Ns6LBISeOmR+lAmjidhJp6QMx6VrLpk0Ry8R/KmPHtbGMVnKdg5CONdiYFWuGhwagqzEm5BWL1N4qxNZoN4wK9C1R/M0jSQEVWNth2A5faxVc/QAVwtpGVbPpXpviH+zrTR9Ks1niFxDHlgvcNz/P+daxYmjnIweKsqKbGqkDBzU6rWyMhB0p69aAlSpHVNEm1oD7L+L3OK7pBXnunnyriJ/Rga9CRuhpFplTWofM05sdVIavPfEq48Nap/16S/8AoBr064QTwPGf4gRXm/iZMeGtVyOlpLn/AL5NaQdkY1Fc4fTR/wASyz/64R/+gitFU4qrpUQ/sqyZ8qot48+v3RVpbiVFkiixhxg5QE/gSMj8KzNI7DguFLZGB1yRU9ncWRLLc7xgfK688+mPSs1oHbr+tK6i3i3NwPWpGaUVxam4wqMAOjMe/wBKW8vbSGM+dIq56AnrXPPeSSf8e2UTvIR/IUiwRiOS6nbeQPvSck0mxsklubedW8mVW9s1nOFOeBVS65BuYE8tg33R3FSRP5ihgeDUNDI3t1ZvkGCe1WLa3YcEVNboplBIq/GirIDjjvUuJdN62Io4SozViOEzq4X74rUisEnjPkgucZwAc04RQ2MrJEfMZ12yHHAPfFZ6nZaJjQve2hyrnGehGQa7BrcMsUsQIiliWQE+pHI/A5H4VkSxqyHI6dvSum0TbqPh2W3zmeyJdB3MZ64+h5/GtoHNWguhnhcdadkZ4pWpoHNanMWYeor0G1ffBG2eqivPYuldxob79PXnOKBo0+1cL42h8rQ9ZHrZyn/xw13ijNcj4/hx4c1WT1sZh+SGriRI820qEyaZp/p9mj/9BFX/ALKELEjHyk1Z0qK3g8M6bPMQo+yQkk+6CqNzJc3zYhR0i6Db94/X0qTSOxBcXKR/u41MkvoOg+pqolpNeEGYb8fgo/DvWpDpSR7TIM8Z254/+vV4g8jtxxQBhLZbPv8AJxj2rO1k+UkcC/Vh/KukkT94KwdcXzbmCJRl8HP41IGBGXkcKo9eKfYj9y6n7ytW9Y6X9nUtImZT+lZWwWepTQkYWTFS0ImgilyCBVxGYfeHNWEgCqAKUw07DLNrfvAwaGRo3HQqcVNJ4j1JeWuBKAc/vYlfH0yKzfLxUU/EJpWK5mbNv4kt7ydY9StIgrHDS267Hx/ujg/lWnaXn/CO67b3sJM9jJkpIoIEsZ4I+o9PUVwg4OeldZ4d1GC7h/si+ZVhIzDKesT+v0PQ/wD1qaQc76nS3doslst/asj28nQK2Sh9D+uKoVZ0OO7sdSksJ4d0E64kiZlyfQqSeTyDx1pLu0ksrh4ZR8ynGexHqKohjI+ldd4ZkzbyR+hBrkYq6Xw04W4ZP7woBHVKOK5vx9Hu8Fas392zm/8AQDXTAVheN03+BtcA6ixmP/jhoTJkeZeHLO717TtOjJKWsFtEq8dwgGa6+TSI7WFYoo8d/c1ifDS8M1ra2RXIS3VgfbA6/mK7u5T94D6AD880zWOxxU0Oxm44BqnIPmf6VuXsWC59WNY7rjf+FANFJxjrWNEq3XiBuMiPp9f8mtq6bylZj0GKo+H7cOs923LSNwfYf/XzQKxcljwM4rkNfQpepMBkcV2tyMRmuU1yJpIjjtzQFjT2DaCPTNMJpdOzLpcUjctt5PrSN1pNA0Rmqs/3TVo1Vn+6akCi9EZ/eDmnPUaffBpCO80u7l1fTWtnAluI1zbydHXH8Oe4PTnuRWvaX8eu2yQ3Mu27hG1JG4Dj0Y/ng/nWH4UMQdAW2kNuVj0Hrn/Pb61P4gtRo2us8OPKb54+OxP9Dx+FaDZfMTRMVdSpBxg1q6LKIr6LJwCcU2yceIbMTmBI5EGxpI3ySccbl9Kr2hMcqHuDQQeg1i+M/wDkR9e/7B8//otq2QQyhhyCMg1jeMv+RH1//sHT/wDotqhEyPK/BVzNptnZ6pAhkighjS6XuFIHP0+6fqK9ZiCXUMkqOGVgpUjuMZz+teWeE3XTH0l35tru0ijnB6cxjr7cg13VnIfDepCwlY/2bdHNu78+W3dCfx4qzaOwavCqwu4HaudnGE3Y9K7PVYF+zyrjI25FchIM24GOQcH8KCjn9dfZa3PbGz9RV7TrT7JYRRbcYHP1qjrdu1zfQQJ/y3Khh64P+Ga2ieKDMqXY+Suc1FC6sAOororr7hrHukySfagaZR0K7zpzI3WJsEexq64RvmQ9e1ZGiyiLUrq2b+Mfyz/jWq8TQZK8x9vagZC/ANUZjk1cnOY2+lZrNkVBJHIeaYpwaefmBpi9aQjc0q+e2ZSDxmuo1S5i1rTkjRv9Ig+aMqOq/wAQ/kR9CPSuDSUoKtW+rzWjAxvg1SYzsfD815YKZIbqAQvjzY2BLcfh/UVsEICrxNlHG9T/AD/XIrz2PV5RNuAVAeyjArqfD9691DJGzjMeHUH0PDY/Hb+tO4HpumS+bpsDbs8YNUPGX/Ij6/8A9g6f/wBFtS+HHLWTgn7r8UnjL/kR9f8A+wdP/wCi2oM5H//Z + mediaType: image/jpeg + value: '' + '400': *id001 + '404': *id002 + '423': *id003 + '500': *id004 + '503': *id005 + /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetVideoEncoderConfigurations: + get: + tags: + - Video Encoder Configuration + summary: 'Media: GetVideoEncoderConfigurations' + 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. + parameters: + - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': description: OK @@ -2987,27 +2896,50 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetDiscoveryModeResponse' + $ref: '#/components/schemas/media_GetVideoEncoderConfigurationsResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 8155efce-41b5-412f-a25d-b63bed015d63 + id: 1ee4ca7f-fb95-46b3-8e6d-8542b45b22d4 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: DiscoveryMode - origin: 1659656339306907600 + sourceName: GetVideoEncoderConfigurations + origin: 1659659203023412500 readings: - - id: 099efd6b-d5fa-44a3-98f2-67eb72a1659f - origin: 1659656339306907600 + - id: dd2b4e0e-9a62-49bc-a80b-071d4b1ed8e1 + origin: 1659659203023412500 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: DiscoveryMode + resourceName: GetVideoEncoderConfigurations profileName: onvif-camera valueType: Object value: '' objectValue: - DiscoveryMode: Discoverable + Configurations: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_2 + Quality: 3 + RateControl: + BitrateLimit: 256 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 360 + Width: 640 + SessionTimeout: PT0H1M5S + Token: minor + UseCount: 1 '400': *id001 '404': *id002 '423': *id003 @@ -3015,13 +2947,14 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetDiscoveryMode - put: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurations + /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfiguration: + get: tags: - - Auto Discovery - summary: Set DiscoveryMode + - Video Encoder Configuration + summary: 'Media: GetVideoEncoderConfiguration' 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. + If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command.
Tested Camera Models @@ -3035,101 +2968,38 @@ paths: | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
- requestBody: - content: - application/json: - schema: - properties: - DiscoveryMode: - $ref: '#/components/schemas/device_SetDiscoveryMode' - required: - - DiscoveryMode - type: object - example: - DiscoveryMode: - DiscoveryMode: Discoverable parameters: - - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' - responses: - '200': *id006 - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetDiscoveryMode - /api/v2/device/name/{EDGEX_DEVICE_NAME}/AddScopes: - put: - tags: - - Auto Discovery - summary: Add Scopes - 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. + - name: jsonObject + in: query + schema: + type: string + example: eyJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0= + description: | + **Format:**
+ This field is a Base64 encoded json string. -
- Tested Camera Models + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "" + } + ``` - Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Token of the requested video encoder configuration. - | Camera | Supported?    | Notes | - |--------|:------------|-------| - | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | -
- requestBody: - content: - application/json: - schema: - properties: - AddScopes: - $ref: '#/components/schemas/device_AddScopes' - required: - - AddScopes - type: object - example: - AddScopes: - ScopeItem: - - http//:123 - parameters: - - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' - responses: - '200': *id006 - '400': *id001 - '404': *id002 - '423': *id003 - '500': *id004 - '503': *id005 - externalDocs: - description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.AddScopes - /api/v2/device/name/{EDGEX_DEVICE_NAME}/Scopes: - get: - tags: - - Auto Discovery - summary: Get Scopes - 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. -
- Tested Camera Models + **Schema Reference:** [media_GetVideoEncoderConfiguration](#media_GetVideoEncoderConfiguration) - Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ - | Camera | Supported?    | Notes | - |--------|:------------|-------| - | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | - | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | - | **GeoVision GV-BX8700** | ✔️ | | -
- parameters: + ```json + { + "ConfigurationToken": "main" + } + ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: '200': @@ -3153,37 +3023,50 @@ paths: items: properties: objectValue: - $ref: '#/components/schemas/device_GetScopesResponse' + $ref: '#/components/schemas/media_GetVideoEncoderConfigurationResponse' example: apiVersion: v2 statusCode: 200 event: apiVersion: v2 - id: 05f573f4-0836-45ad-b9ba-c393f9927586 + id: 598079d0-d169-4385-86f3-cb7a106345a5 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 profileName: onvif-camera - sourceName: Scopes - origin: 1659659228090509000 + sourceName: VideoEncoderConfiguration + origin: 1659659207626081000 readings: - - id: ea858652-cb16-432c-bf45-f9785cd00d85 - origin: 1659659228090509000 + - id: 86aed436-65cb-4162-b3e6-14def8e4e4d3 + origin: 1659659207626081000 deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 - resourceName: Scopes + resourceName: VideoEncoderConfiguration profileName: onvif-camera valueType: Object value: '' objectValue: - Scopes: - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/name/TP-IPC - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/hardware/MODEL - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/Profile/Streaming - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/location/ShenZhen - - ScopeDef: Fixed - ScopeItem: onvif://www.onvif.org/type/NetworkVideoTransmitter + Configuration: + Encoding: H264 + H264: + GovLength: 25 + H264Profile: Main + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 0 + TTL: 0 + Name: VideoEncoder_1 + Quality: 3 + RateControl: + BitrateLimit: 1024 + EncodingInterval: 1 + FrameRateLimit: 15 + Resolution: + Height: 1080 + Width: 1920 + SessionTimeout: PT0H1M5S + Token: main + UseCount: 1 '400': *id001 '404': *id002 '423': *id003 @@ -3191,13 +3074,15 @@ paths: '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.GetScopes + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfiguration put: tags: - - Auto Discovery - summary: Put Scopes + - Video Encoder Configuration + summary: 'Media: SetVideoEncoderConfiguration' 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. + 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.
Tested Camera Models @@ -3207,7 +3092,7 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ✔️ | | + | **Tapo C200** | ❌ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
@@ -3216,34 +3101,76 @@ paths: application/json: schema: properties: - Scopes: - $ref: '#/components/schemas/device_SetScopes' + VideoEncoderConfiguration: + $ref: '#/components/schemas/media_SetVideoEncoderConfiguration' required: - - Scopes + - VideoEncoderConfiguration type: object example: - Scopes: - Scopes: - - http//:123 + VideoEncoderConfiguration: + ForcePersistence: false + Configuration: + token: main + Encoding: H264 + Quality: 3 + Resolution: + Width: 1920 + Height: 1080 + Multicast: + Address: + Type: IPv4 + IPv4Address: 0.0.0.0 + Port: 8860 + TTL: 1 + AutoStart: false parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: + '500': + description: Internal Server Error + headers: + Content-Type: + schema: + type: string + example: application/json + X-Correlation-Id: + $ref: '#/components/headers/correlatedResponseHeader' + content: + application/json: + schema: + type: object + example: + apiVersion: v2 + message: >- + request failed, status code: 500, err: + {"apiVersion":"v2","message":"error writing DeviceResourece + VideoEncoderConfiguration for + TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e + failed to execute write command, \u003cnil\u003e -\u003e + invalid request for the function + 'SetVideoEncoderConfiguration' of web service 'Media'. Onvif + error: fault reason: , fault detail: , fault code: + SOAP-ENV:Sender ","statusCode":500} + statusCode: 500 '200': *id006 '400': *id001 '404': *id002 '423': *id003 - '500': *id004 '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.SetScopes - /api/v2/device/name/{EDGEX_DEVICE_NAME}/RemoveScopes: - put: + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.SetVideoEncoderConfiguration + /api/v2/device/name/{EDGEX_DEVICE_NAME}/VideoEncoderConfigurationOptions: + get: tags: - - Auto Discovery - summary: Remove Scopes + - Video Encoder Configuration + summary: 'Media: GetVideoEncoderConfigurationOptions' 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 + 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.
Tested Camera Models @@ -3253,29 +3180,50 @@ paths: | Camera | Supported?    | Notes | |--------|:------------|-------| | **Hikvision DFI6256TE** | ✔️ | | - | **Tapo C200** | ❌ | | + | **Tapo C200** | ✔️ | | | **BOSCH DINION IP starlight 6000 HD** | ✔️ | | | **GeoVision GV-BX8700** | ✔️ | |
- requestBody: - content: - application/json: - schema: - properties: - RemoveScopes: - $ref: '#/components/schemas/device_RemoveScopes' - required: - - RemoveScopes - type: object - example: - RemoveScopes: - ScopeItem: - - onvif://www.onvif.org/name/Geovision parameters: + - name: jsonObject + in: query + schema: + type: string + example: eyJQcm9maWxlVG9rZW4iOiJwcm9maWxlXzEiLCJDb25maWd1cmF0aW9uVG9rZW4iOiJtYWluIn0= + description: | + **Format:**
+ This field is a Base64 encoded json string. + + **JSON Schema:** + ```yaml + { + "ConfigurationToken": "", + "ProfileToken": "" + } + ``` + + **Field Descriptions:** + - **ConfigurationToken** _[string]_ +
Optional video encoder configuration token that specifies an existing configuration that the options are intended for. + - **ProfileToken** _[string]_ +
Optional ProfileToken that specifies an existing media profile that the options shall be compatible with. + + + **Schema Reference:** [media_GetVideoEncoderConfigurationOptions](#media_GetVideoEncoderConfigurationOptions) + + **Example JSON:**
+ > _Note: This value must be encoded to base64!_ + + ```json + { + "ProfileToken": "profile_1", + "ConfigurationToken": "main" + } + ``` - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '500': - description: Internal Server Error + '200': + description: OK headers: Content-Type: schema: @@ -3286,33 +3234,94 @@ paths: content: application/json: schema: - type: object + allOf: + - $ref: '#/components/schemas/ObjectEventResponse' + - properties: + event: + properties: + readings: + items: + properties: + objectValue: + $ref: '#/components/schemas/media_GetVideoEncoderConfigurationOptionsResponse' example: apiVersion: v2 - message: >- - request failed, status code: 500, err: - {"apiVersion":"v2","message":"error writing DeviceResourece - RemoveScopes for - Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 -\u003e - failed to execute write command, \u003cnil\u003e -\u003e - invalid request for the function 'RemoveScopes' of web service - 'Device'. Onvif error: fault reason: Trying to Remove scope - which does not exist, fault detail: , fault code: s:Sender - ter:InvalidArgVal ter:NoScope","statusCode":500} - statusCode: 500 - '200': *id006 + statusCode: 200 + event: + apiVersion: v2 + id: 187b2e94-6efe-421f-b618-186a20fd41df + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + profileName: onvif-camera + sourceName: VideoEncoderConfigurationOptions + origin: 1659659212171416600 + readings: + - id: 0b709715-f644-4cf0-a477-dcc3b5ef218c + origin: 1659659212171416600 + deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + resourceName: VideoEncoderConfigurationOptions + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Options: + Extension: + H264: + BitrateRange: + Max: 1024 + Min: 256 + EncodingIntervalRange: + Max: 1 + Min: 1 + FrameRateRange: + Max: 15 + Min: 1 + GovLengthRange: + Max: 25 + Min: 25 + H264ProfilesSupported: + - Main + ResolutionsAvailable: + - Height: 1080 + Width: 1920 + - Height: 720 + Width: 1280 + - Height: 360 + Width: 640 + H264: + EncodingIntervalRange: + Max: 1 + Min: 1 + FrameRateRange: + Max: 15 + Min: 1 + GovLengthRange: + Max: 25 + Min: 25 + H264ProfilesSupported: + - Main + ResolutionsAvailable: + - Height: 1080 + Width: 1920 + - Height: 720 + Width: 1280 + - Height: 360 + Width: 640 + QualityRange: + Max: 5 + Min: 1 '400': *id001 '404': *id002 '423': *id003 + '500': *id004 '503': *id005 externalDocs: description: Onvif Specification - url: https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl#op.RemoveScopes + url: https://www.onvif.org/ver10/media/wsdl/media.wsdl#op.GetVideoEncoderConfigurationOptions /api/v2/device/name/{EDGEX_DEVICE_NAME}/GetNodes: get: tags: - PTZ - Capabilities - summary: GetNodes + summary: 'PTZ: GetNodes' description: |- Get the descriptions of the available PTZ Nodes. @@ -3445,7 +3454,7 @@ paths: get: tags: - PTZ - Capabilities - summary: GetNode + summary: 'PTZ: GetNode' description: |- Get a specific PTZ Node identified by a reference token or a name. @@ -3607,7 +3616,7 @@ paths: get: tags: - PTZ - Configuration - summary: GetConfigurations + summary: 'PTZ: GetConfigurations' 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. @@ -3700,7 +3709,7 @@ paths: get: tags: - PTZ - Configuration - summary: GetConfiguration + summary: 'PTZ: GetConfiguration' description: |- Get a specific PTZconfiguration from the device, identified by its reference token or name. @@ -3825,7 +3834,7 @@ paths: put: tags: - PTZ - Configuration - summary: SetConfiguration + summary: 'PTZ: SetConfiguration' description: |- Set/update a existing PTZConfiguration on the device. @@ -3880,7 +3889,7 @@ paths: get: tags: - PTZ - Configuration - summary: GetConfigurationOptions + summary: 'PTZ: GetConfigurationOptions' 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. @@ -4042,7 +4051,7 @@ paths: put: tags: - PTZ - Configuration - summary: AddPTZConfiguration + summary: 'Media: AddPTZConfiguration' description: |- Add a new PTZConfiguration on the device. @@ -4088,7 +4097,7 @@ paths: put: tags: - PTZ - Configuration - summary: RemovePTZConfiguration + summary: 'Media: RemovePTZConfiguration' description: |- Remove a PTZConfiguration on the device. @@ -4133,7 +4142,7 @@ paths: put: tags: - PTZ - Actuation - summary: AbsoluteMove + summary: 'PTZ: AbsoluteMove' description: |- Operation to move pan,tilt or zoom to a absolute destination. @@ -4184,7 +4193,7 @@ paths: put: tags: - PTZ - Actuation - summary: RelativeMove + summary: 'PTZ: RelativeMove' 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. @@ -4235,7 +4244,7 @@ paths: put: tags: - PTZ - Actuation - summary: ContinuousMove + summary: 'PTZ: ContinuousMove' 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. @@ -4284,7 +4293,7 @@ paths: get: tags: - PTZ - Actuation - summary: GetStatus + summary: 'PTZ: GetStatus' description: |- Operation to request PTZ status for the Node in the selected profile. @@ -4397,7 +4406,7 @@ paths: put: tags: - PTZ - Actuation - summary: Stop + summary: 'PTZ: Stop' 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. @@ -4443,7 +4452,7 @@ paths: put: tags: - PTZ - Preset - summary: SetPreset + summary: 'PTZ: SetPreset' 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. @@ -4489,7 +4498,7 @@ paths: get: tags: - PTZ - Preset - summary: GetPresets + summary: 'PTZ: GetPresets' 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. @@ -4617,7 +4626,7 @@ paths: put: tags: - PTZ - Preset - summary: GotoPreset + summary: 'PTZ: GotoPreset' 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. @@ -4663,7 +4672,7 @@ paths: put: tags: - PTZ - Preset - summary: RemovePreset + summary: 'PTZ: RemovePreset' 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. @@ -4709,7 +4718,7 @@ paths: put: tags: - PTZ - Home Position - summary: GotoHomePosition + summary: 'PTZ: GotoHomePosition' 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. @@ -4754,7 +4763,7 @@ paths: put: tags: - PTZ - Home Position - summary: SetHomePosition + summary: 'PTZ: SetHomePosition' 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. @@ -4799,7 +4808,7 @@ paths: put: tags: - PTZ - Auxiliary - summary: SendAuxiliaryCommand + summary: 'PTZ: SendAuxiliaryCommand' 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. @@ -4859,14 +4868,19 @@ paths: get: tags: - Event Handling - summary: GetEventProperties - 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. + summary: 'Event: GetEventProperties' + 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. + +
+ Tested Camera Models + + Below is a list of camera models that this command has been tested against, and whether or not the command is supported. + + | Camera | Supported?    | Notes | + |--------|:------------|-------| + | **Tapo C200** | ✔️ | | +
parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -5152,7 +5166,7 @@ paths: get: tags: - Analytics - Profile Configuration - summary: GetProfiles + summary: 'Media2: GetProfiles' 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. @@ -5254,7 +5268,7 @@ paths: get: tags: - Analytics - Profile Configuration - summary: GetAnalyticsConfigurations + summary: 'Media2: GetAnalyticsConfigurations' 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. @@ -5332,7 +5346,7 @@ paths: put: tags: - Analytics - Profile Configuration - summary: AddConfiguration + summary: 'Media2: AddConfiguration' 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. @@ -5382,7 +5396,7 @@ paths: put: tags: - Analytics - Profile Configuration - summary: RemoveConfiguration + summary: 'Media2: RemoveConfiguration' 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. @@ -5430,7 +5444,7 @@ paths: get: tags: - Analytics - Modules - summary: GetSupportedAnalyticsModules + summary: 'Analytics: GetSupportedAnalyticsModules' description: |- List all analytics modules that are supported by the given VideoAnalyticsConfiguration. @@ -5504,7 +5518,7 @@ paths: get: tags: - Analytics - Modules - summary: GetAnalyticsModules + summary: 'Analytics: GetAnalyticsModules' description: |- List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. @@ -5613,7 +5627,7 @@ paths: put: tags: - Analytics - Modules - summary: ModifyAnalyticsModules + summary: 'Analytics: ModifyAnalyticsModules' 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. @@ -5665,7 +5679,7 @@ paths: put: tags: - Analytics - Modules - summary: CreateAnalyticsModules + summary: 'Analytics: CreateAnalyticsModules' 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. @@ -5723,7 +5737,7 @@ paths: put: tags: - Analytics - Modules - summary: DeleteAnalyticsModules + summary: 'Analytics: DeleteAnalyticsModules' description: |- Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names. @@ -5770,7 +5784,7 @@ paths: get: tags: - Analytics - Modules - summary: GetAnalyticsModuleOptions + summary: 'Analytics: GetAnalyticsModuleOptions' description: |- Return the options for the supported analytics modules that specify an Option attribute. @@ -5882,7 +5896,7 @@ paths: get: tags: - Analytics - Rules - summary: GetSupportedRules + summary: 'Analytics: GetSupportedRules' description: |- List all rules that are supported by the given VideoAnalyticsConfiguration. @@ -6138,7 +6152,7 @@ paths: get: tags: - Analytics - Rules - summary: GetRules + summary: 'Analytics: GetRules' description: |- List the currently assigned set of rules of a VideoAnalyticsConfiguration. @@ -6253,7 +6267,7 @@ paths: put: tags: - Analytics - Rules - summary: ModifyRules + summary: 'Analytics: ModifyRules' description: |- Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names. @@ -6305,7 +6319,7 @@ paths: get: tags: - Analytics - Rules - summary: GetRuleOptions + summary: 'Analytics: GetRuleOptions' description: |- Return the options for the supported rules that specify an Option attribute. @@ -6420,7 +6434,7 @@ paths: put: tags: - Analytics - Rules - summary: CreateRules + summary: 'Analytics: CreateRules' 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. @@ -6484,7 +6498,7 @@ paths: put: tags: - Analytics - Rules - summary: DeleteRules + summary: 'Analytics: DeleteRules' description: |- Remove one or more rules from a VideoAnalyticsConfiguration. diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index aeb2ab6c..83ecad8b 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -1,6 +1,6 @@ { "info": { - "_postman_id": "41b06358-d096-4b9b-8735-a0905762330f", + "_postman_id": "b7a70229-560c-41c2-9958-4994c7bd93fc", "name": "device-onvif-camera", "description": "The Open Network Video Interface Forum (ONVIF) Device Service is a microservice created to address the lack of standardization and automation of camera discovery and onboarding. EdgeX Foundry is a flexible microservice-based architecture created to promote the interoperability of multiple device interface combinations at the edge. In an EdgeX deployment, the ONVIF Device Service controls and communicates with ONVIF-compliant cameras, while EdgeX Foundry presents a standard interface to application developers. With normalized connectivity protocols and a vendor-neutral architecture, EdgeX paired with ONVIF Camera Device Service, simplifies deployment of edge camera devices.\n\nUse the ONVIF Device Service to streamline and scale your edge camera device deployment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", @@ -8,15 +8,15 @@ }, "item": [ { - "name": "Network Configuration", + "name": "Auto Discovery", "item": [ { - "name": "Hostname", + "name": "GetDiscoveryMode", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", "protocol": "http", "host": [ "0", @@ -31,19 +31,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Hostname" + "DiscoveryMode" ] }, - "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." + "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." }, "response": [ { - "name": "Hostname", + "name": "GetDiscoveryMode", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", "protocol": "http", "host": [ "0", @@ -58,7 +58,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Hostname" + "DiscoveryMode" ] } }, @@ -72,30 +72,30 @@ }, { "key": "X-Correlation-Id", - "value": "08d01c8d-a9cd-4ece-b8e6-4a052af9e391" + "value": "e81b8fb3-4bc4-4aab-a56f-5ff1ed41c123" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:26:14 GMT" + "value": "Thu, 04 Aug 2022 23:38:59 GMT" }, { "key": "Content-Length", - "value": "571" + "value": "553" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"6ad6d2d6-51af-4084-8a6a-952928942732\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Hostname\",\n \"origin\": 1659655574277981114,\n \"readings\": [\n {\n \"id\": \"b8e4ba90-2aeb-4336-a5ca-923456cff383\",\n \"origin\": 1659655574277981114,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Hostname\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"HostnameInformation\": {\n \"FromDHCP\": false,\n \"Name\": \"hostname\"\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"8155efce-41b5-412f-a25d-b63bed015d63\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DiscoveryMode\",\n \"origin\": 1659656339306907742,\n \"readings\": [\n {\n \"id\": \"099efd6b-d5fa-44a3-98f2-67eb72a1659f\",\n \"origin\": 1659656339306907742,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DiscoveryMode\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DiscoveryMode\": \"Discoverable\"\n }\n }\n ]\n }\n}" } ] }, { - "name": "SetHostname", + "name": "Set DiscoveryMode", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost555\"\n }\n}", + "raw": "{\n \"DiscoveryMode\": {\n \"DiscoveryMode\": \"Discoverable\"\n }\n}", "options": { "raw": { "language": "json" @@ -103,7 +103,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", "protocol": "http", "host": [ "0", @@ -118,20 +118,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Hostname" + "DiscoveryMode" ] }, - "description": "This operation sets the hostname on a device. It shall be possible to set the device hostname configurations through the SetHostname command. \nA device shall accept string formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings." + "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." }, "response": [ { - "name": "SetHostname", + "name": "Set DiscoveryMode", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost555\"\n }\n}", + "raw": "{\n \"DiscoveryMode\": {\n \"DiscoveryMode\": \"Discoverable\"\n }\n}", "options": { "raw": { "language": "json" @@ -139,7 +139,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", "protocol": "http", "host": [ "0", @@ -154,7 +154,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Hostname" + "DiscoveryMode" ] } }, @@ -168,11 +168,11 @@ }, { "key": "X-Correlation-Id", - "value": "8ff7406a-6544-4c19-9205-9c81e24cb090" + "value": "99ed7b8d-81cc-4046-8ac9-ea8dd9013fb2" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 16:18:17 GMT" + "value": "Thu, 04 Aug 2022 23:39:15 GMT" }, { "key": "Content-Length", @@ -185,16 +185,13 @@ ] }, { - "name": "DNS", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, + "name": "Add Scopes", "request": { - "method": "GET", + "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "raw": "{\n \"AddScopes\":{\n \"ScopeItem\":[\n \"http//:123\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -202,7 +199,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddScopes", "protocol": "http", "host": [ "0", @@ -217,19 +214,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DNS" + "AddScopes" ] }, - "description": "This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command." + "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." }, "response": [ { - "name": "DNS", + "name": "Add Scopes", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"AddScopes\":{\n \"ScopeItem\":[\n \"http//:123\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddScopes", "protocol": "http", "host": [ "0", @@ -244,7 +250,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DNS" + "AddScopes" ] } }, @@ -258,38 +264,29 @@ }, { "key": "X-Correlation-Id", - "value": "d1eccd37-33c0-4c5d-bbb3-434b384399d2" + "value": "6c1402e7-4516-4661-9ba7-b486dc20336f" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:59:59 GMT" + "value": "Sun, 25 Sep 2022 03:41:03 GMT" }, { "key": "Content-Length", - "value": "522" + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"d2d2541f-2feb-490f-bf89-b7407d3078d3\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DNS\",\n \"origin\": 1659671999397808427,\n \"readings\": [\n {\n \"id\": \"3ad48fbe-1e98-4c90-a26e-f83a391c4d8c\",\n \"origin\": 1659671999397808427,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DNS\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DNSInformation\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "SetDNS", + "name": "Get Scopes", "request": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"DNS\": {\n \"FromDHCP\": true,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", "protocol": "http", "host": [ "0", @@ -304,28 +301,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DNS" + "Scopes" ] }, - "description": "This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command." + "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: \n\\- Fixed \n\\- Configurable \nFixed 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." }, "response": [ { - "name": "SetDNS", + "name": "Get Scopes", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"DNS\": {\n \"FromDHCP\": true,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", "protocol": "http", "host": [ "0", @@ -340,7 +328,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DNS" + "Scopes" ] } }, @@ -354,29 +342,38 @@ }, { "key": "X-Correlation-Id", - "value": "f596f4f6-812f-4124-a502-f427f3a8ac7b" + "value": "966fc4b2-a648-4bef-91fc-2aaf9f9310a7" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 16:19:16 GMT" + "value": "Fri, 05 Aug 2022 00:27:08 GMT" }, { "key": "Content-Length", - "value": "37" + "value": "896" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"05f573f4-0836-45ad-b9ba-c393f9927586\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Scopes\",\n \"origin\": 1659659228090509033,\n \"readings\": [\n {\n \"id\": \"ea858652-cb16-432c-bf45-f9785cd00d85\",\n \"origin\": 1659659228090509033,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Scopes\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Scopes\": [\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/name/TP-IPC\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/hardware/MODEL\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/Profile/Streaming\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/location/ShenZhen\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/type/NetworkVideoTransmitter\"\n }\n ]\n }\n }\n ]\n }\n}" } ] }, { - "name": "NetworkInterfaces", + "name": "Put Scopes", "request": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"Scopes\":{\n \"Scopes\":[\n \"http//:123\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", "protocol": "http", "host": [ "0", @@ -391,19 +388,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkInterfaces" + "Scopes" ] }, - "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." + "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." }, "response": [ { - "name": "NetworkInterfaces", + "name": "Put Scopes", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"Scopes\":{\n \"Scopes\":[\n \"http//:123\"\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", "protocol": "http", "host": [ "0", @@ -418,7 +424,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkInterfaces" + "Scopes" ] } }, @@ -432,30 +438,30 @@ }, { "key": "X-Correlation-Id", - "value": "241016a3-ff95-4002-9499-81e793002f9c" + "value": "0fa69e08-5b67-4b92-93c8-7cb642c2f43c" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:28:29 GMT" + "value": "Sun, 25 Sep 2022 03:41:08 GMT" }, { "key": "Content-Length", - "value": "748" + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"acc3a74d-852a-4c0c-bf31-dbc06d8a0782\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkInterfaces\",\n \"origin\": 1659655709817960403,\n \"readings\": [\n {\n \"id\": \"74571fe4-731a-4925-99eb-7d4c317834f6\",\n \"origin\": 1659655709817960403,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkInterfaces\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkInterfaces\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"Config\": {\n \"DHCP\": false,\n \"Manual\": {\n \"Address\": \"10.0.0.195\",\n \"PrefixLength\": 24\n }\n },\n \"Enabled\": true\n },\n \"Info\": {\n \"HwAddress\": \"10:27:F5:EA:88:F4\",\n \"MTU\": 1500,\n \"Name\": \"eth0\"\n },\n \"Token\": \"eth0\"\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "SetNetworkInterfaces", + "name": "Remove Scopes", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": true\n }\n }\n \n }\n}", + "raw": "{\n \"RemoveScopes\":{\n \"ScopeItem\":[\n \"onvif://www.onvif.org/name/Geovision\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -463,7 +469,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveScopes", "protocol": "http", "host": [ "0", @@ -478,20 +484,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkInterfaces" + "RemoveScopes" ] }, - "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.\n\nFor 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." + "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" }, "response": [ { - "name": "SetNetworkInterfaces", + "name": "Remove Scopes", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": true\n }\n }\n \n }\n}", + "raw": "{\n \"RemoveScopes\":{\n \"ScopeItem\":[\n \"onvif://www.onvif.org/name/Geovision\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -499,7 +505,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveScopes", "protocol": "http", "host": [ "0", @@ -514,12 +520,12 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkInterfaces" + "RemoveScopes" ] } }, - "status": "OK", - "code": 200, + "status": "Internal Server Error", + "code": 500, "_postman_previewlanguage": "json", "header": [ { @@ -528,29 +534,34 @@ }, { "key": "X-Correlation-Id", - "value": "1ccf5e8a-352b-4a85-8ea7-71f9333a5bf4" + "value": "1585c4fb-963a-4dc2-afa1-057559aedacc" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 16:19:43 GMT" + "value": "Sun, 25 Sep 2022 03:41:12 GMT" }, { "key": "Content-Length", - "value": "37" + "value": "528" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"message\": \"request failed, status code: 500, err: {\\\"apiVersion\\\":\\\"v2\\\",\\\"message\\\":\\\"error writing DeviceResourece RemoveScopes for Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 -\\\\u003e failed to execute write command, \\\\u003cnil\\\\u003e -\\\\u003e invalid request for the function 'RemoveScopes' of web service 'Device'. Onvif error: fault reason: Trying to Remove scope which does not exist, fault detail: , fault code: s:Sender ter:InvalidArgVal ter:NoScope\\\",\\\"statusCode\\\":500}\",\n \"statusCode\": 500\n}" } ] - }, + } + ] + }, + { + "name": "Network Configuration", + "item": [ { - "name": "NetworkProtocols", + "name": "Hostname", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", "protocol": "http", "host": [ "0", @@ -565,19 +576,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkProtocols" + "Hostname" ] }, - "description": "This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols." + "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." }, "response": [ { - "name": "NetworkProtocols", + "name": "Hostname", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", "protocol": "http", "host": [ "0", @@ -592,7 +603,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkProtocols" + "Hostname" ] } }, @@ -606,30 +617,30 @@ }, { "key": "X-Correlation-Id", - "value": "96d41685-1184-43f4-a5bf-580fcb5f7011" + "value": "08d01c8d-a9cd-4ece-b8e6-4a052af9e391" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:59:36 GMT" + "value": "Thu, 04 Aug 2022 23:26:14 GMT" }, { "key": "Content-Length", - "value": "634" + "value": "571" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"193b3677-23c8-4d89-852e-73a1aabf445e\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkProtocols\",\n \"origin\": 1659671976670370385,\n \"readings\": [\n {\n \"id\": \"d3a47ec4-3b43-413a-9a67-42f54487cfa5\",\n \"origin\": 1659671976670370385,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkProtocols\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkProtocols\": [\n {\n \"Enabled\": true,\n \"Name\": \"HTTPS\",\n \"Port\": 443\n },\n {\n \"Enabled\": true,\n \"Name\": \"RTSP\",\n \"Port\": 554\n }\n ]\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"6ad6d2d6-51af-4084-8a6a-952928942732\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Hostname\",\n \"origin\": 1659655574277981114,\n \"readings\": [\n {\n \"id\": \"b8e4ba90-2aeb-4336-a5ca-923456cff383\",\n \"origin\": 1659655574277981114,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Hostname\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"HostnameInformation\": {\n \"FromDHCP\": false,\n \"Name\": \"hostname\"\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "SetNetworkProtocols", + "name": "SetHostname", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 2020\n },\n {\n \"Name\": \"HTTPS\",\n \"Enabled\": false,\n \"Port\": 443\n },\n {\n \"Name\": \"RTSP\",\n \"Enabled\": true,\n \"Port\": 554\n }\n ]\n } \n}", + "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost555\"\n }\n}", "options": { "raw": { "language": "json" @@ -637,7 +648,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", "protocol": "http", "host": [ "0", @@ -652,20 +663,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkProtocols" + "Hostname" ] }, - "description": "This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command." + "description": "This operation sets the hostname on a device. It shall be possible to set the device hostname configurations through the SetHostname command. \nA device shall accept string formatted according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings." }, "response": [ { - "name": "SetNetworkProtocols", + "name": "SetHostname", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 2020\n },\n {\n \"Name\": \"HTTPS\",\n \"Enabled\": false,\n \"Port\": 443\n },\n {\n \"Name\": \"RTSP\",\n \"Enabled\": true,\n \"Port\": 554\n }\n ]\n } \n}", + "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost555\"\n }\n}", "options": { "raw": { "language": "json" @@ -673,7 +684,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Hostname", "protocol": "http", "host": [ "0", @@ -688,7 +699,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkProtocols" + "Hostname" ] } }, @@ -702,11 +713,11 @@ }, { "key": "X-Correlation-Id", - "value": "a7f75e35-bb5c-46b2-a502-c269c574a7b0" + "value": "8ff7406a-6544-4c19-9205-9c81e24cb090" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 16:26:38 GMT" + "value": "Fri, 23 Sep 2022 16:18:17 GMT" }, { "key": "Content-Length", @@ -719,7 +730,7 @@ ] }, { - "name": "NetworkDefaultGateway", + "name": "DNS", "protocolProfileBehavior": { "disableBodyPruning": true }, @@ -736,7 +747,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", "protocol": "http", "host": [ "0", @@ -751,19 +762,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkDefaultGateway" + "DNS" ] }, - "description": "This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es)." + "description": "This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command." }, "response": [ { - "name": "NetworkDefaultGateway", + "name": "DNS", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", "protocol": "http", "host": [ "0", @@ -778,7 +789,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkDefaultGateway" + "DNS" ] } }, @@ -792,30 +803,30 @@ }, { "key": "X-Correlation-Id", - "value": "e24e3e01-1680-40c6-ae25-3151ff5aafef" + "value": "d1eccd37-33c0-4c5d-bbb3-434b384399d2" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:59:47 GMT" + "value": "Fri, 05 Aug 2022 03:59:59 GMT" }, { "key": "Content-Length", - "value": "558" + "value": "522" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"78915210-fab0-4018-a8ed-72f793c2cbc7\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkDefaultGateway\",\n \"origin\": 1659671987813255281,\n \"readings\": [\n {\n \"id\": \"c348128d-0c51-4470-a978-b431302906a0\",\n \"origin\": 1659671987813255281,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkDefaultGateway\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkGateway\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"d2d2541f-2feb-490f-bf89-b7407d3078d3\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DNS\",\n \"origin\": 1659671999397808427,\n \"readings\": [\n {\n \"id\": \"3ad48fbe-1e98-4c90-a26e-f83a391c4d8c\",\n \"origin\": 1659671999397808427,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DNS\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DNSInformation\": {}\n }\n }\n ]\n }\n}" } ] }, { - "name": "SetNetworkDefaultGateway", + "name": "SetDNS", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n } \n}", + "raw": "{\n \"DNS\": {\n \"FromDHCP\": true,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", "options": { "raw": { "language": "json" @@ -823,7 +834,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", "protocol": "http", "host": [ "0", @@ -838,20 +849,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkDefaultGateway" + "DNS" ] }, - "description": "This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command." + "description": "This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command." }, "response": [ { - "name": "SetNetworkDefaultGateway", + "name": "SetDNS", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n } \n}", + "raw": "{\n \"DNS\": {\n \"FromDHCP\": true,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", "options": { "raw": { "language": "json" @@ -859,7 +870,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DNS", "protocol": "http", "host": [ "0", @@ -874,7 +885,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkDefaultGateway" + "DNS" ] } }, @@ -888,11 +899,11 @@ }, { "key": "X-Correlation-Id", - "value": "84ab80db-4334-49e7-a956-e2ce4aab9b99" + "value": "f596f4f6-812f-4124-a502-f427f3a8ac7b" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 16:26:55 GMT" + "value": "Fri, 23 Sep 2022 16:19:16 GMT" }, { "key": "Content-Length", @@ -905,24 +916,12 @@ ] }, { - "name": "NetworkConfiguration", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, + "name": "NetworkInterfaces", "request": { "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", "protocol": "http", "host": [ "0", @@ -937,19 +936,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkConfiguration" + "NetworkInterfaces" ] }, - "description": "Used to retrieve network resources for a device such as Hostname, DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway." + "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." }, "response": [ { - "name": "NetworkConfiguration", + "name": "NetworkInterfaces", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", "protocol": "http", "host": [ "0", @@ -964,7 +963,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkConfiguration" + "NetworkInterfaces" ] } }, @@ -978,30 +977,30 @@ }, { "key": "X-Correlation-Id", - "value": "eef44832-ed52-4799-be75-9d247984114f" + "value": "241016a3-ff95-4002-9499-81e793002f9c" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:42:57 GMT" + "value": "Thu, 04 Aug 2022 23:28:29 GMT" }, { "key": "Content-Length", - "value": "1944" + "value": "748" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"b34fe9d1-78f9-4b49-961b-80a252e084c4\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkConfiguration\",\n \"origin\": 1659656577804929222,\n \"readings\": [\n {\n \"id\": \"67e318f5-4426-48ff-8235-4a2471e47baf\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Hostname\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"HostnameInformation\": {\n \"FromDHCP\": false,\n \"Name\": \"hostname\"\n }\n }\n },\n {\n \"id\": \"76cfd2b5-f178-4d16-88d1-6b04f129a867\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DNS\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DNSInformation\": {}\n }\n },\n {\n \"id\": \"301b79ab-c92d-4a3f-9776-9a71f6c3c340\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkInterfaces\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkInterfaces\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"Config\": {\n \"DHCP\": false,\n \"Manual\": {\n \"Address\": \"10.0.0.188\",\n \"PrefixLength\": 24\n }\n },\n \"Enabled\": true\n },\n \"Info\": {\n \"HwAddress\": \"10:27:F5:EA:88:F4\",\n \"MTU\": 1500,\n \"Name\": \"eth0\"\n },\n \"Token\": \"eth0\"\n }\n }\n },\n {\n \"id\": \"cc1d5230-06a8-4515-822e-187ba07d0efc\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkProtocols\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkProtocols\": [\n {\n \"Enabled\": true,\n \"Name\": \"HTTPS\",\n \"Port\": 443\n },\n {\n \"Enabled\": true,\n \"Name\": \"RTSP\",\n \"Port\": 554\n }\n ]\n }\n },\n {\n \"id\": \"81f9c4e6-1cfd-487a-a05b-b8ea5b39ffcf\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkDefaultGateway\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkGateway\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"acc3a74d-852a-4c0c-bf31-dbc06d8a0782\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkInterfaces\",\n \"origin\": 1659655709817960403,\n \"readings\": [\n {\n \"id\": \"74571fe4-731a-4925-99eb-7d4c317834f6\",\n \"origin\": 1659655709817960403,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkInterfaces\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkInterfaces\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"Config\": {\n \"DHCP\": false,\n \"Manual\": {\n \"Address\": \"10.0.0.195\",\n \"PrefixLength\": 24\n }\n },\n \"Enabled\": true\n },\n \"Info\": {\n \"HwAddress\": \"10:27:F5:EA:88:F4\",\n \"MTU\": 1500,\n \"Name\": \"eth0\"\n },\n \"Token\": \"eth0\"\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "SetNetworkConfiguration", + "name": "SetNetworkInterfaces", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost\"\n },\n \"DNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n },\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": false\n }\n }\n \n },\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [ \n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 80\n }\n ]\n },\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", + "raw": "{\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": true\n }\n }\n \n }\n}", "options": { "raw": { "language": "json" @@ -1009,7 +1008,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", "protocol": "http", "host": [ "0", @@ -1024,20 +1023,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkConfiguration" + "NetworkInterfaces" ] }, - "description": "Used to configure network resources for a device such as Hostname, DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway." + "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.\n\nFor 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." }, "response": [ { - "name": "SetNetworkConfiguration", + "name": "SetNetworkInterfaces", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost\"\n },\n \"DNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n },\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": false\n }\n }\n \n },\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [ \n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 80\n }\n ]\n },\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", + "raw": "{\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": true\n }\n }\n \n }\n}", "options": { "raw": { "language": "json" @@ -1045,7 +1044,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkInterfaces", "protocol": "http", "host": [ "0", @@ -1060,10 +1059,9 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "NetworkConfiguration" + "NetworkInterfaces" ] - }, - "description": "Onvif Protocol Specification [https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl](https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl)" + } }, "status": "OK", "code": 200, @@ -1075,11 +1073,11 @@ }, { "key": "X-Correlation-Id", - "value": "2955d163-0007-4fa3-9a2c-267510c01e44" + "value": "1ccf5e8a-352b-4a85-8ea7-71f9333a5bf4" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 23:10:59 GMT" + "value": "Fri, 23 Sep 2022 16:19:43 GMT" }, { "key": "Content-Length", @@ -1090,19 +1088,14 @@ "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] - } - ] - }, - { - "name": "System Function", - "item": [ + }, { - "name": "DeviceInformation", + "name": "NetworkProtocols", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeviceInformation", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", "protocol": "http", "host": [ "0", @@ -1117,19 +1110,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DeviceInformation" + "NetworkProtocols" ] }, - "description": "This operation gets basic device information from the device." + "description": "This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols." }, "response": [ { - "name": "DeviceInformation", + "name": "NetworkProtocols", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeviceInformation", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", "protocol": "http", "host": [ "0", @@ -1144,7 +1137,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DeviceInformation" + "NetworkProtocols" ] } }, @@ -1158,33 +1151,30 @@ }, { "key": "X-Correlation-Id", - "value": "76d81da0-eba7-4e98-9d92-b60560c20a94" + "value": "96d41685-1184-43f4-a5bf-580fcb5f7011" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 04:14:17 GMT" + "value": "Fri, 05 Aug 2022 03:59:36 GMT" }, { "key": "Content-Length", - "value": "672" + "value": "634" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"a025e1b1-7e2b-4db8-95b6-7dac978e9c97\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DeviceInformation\",\n \"origin\": 1659672857568971786,\n \"readings\": [\n {\n \"id\": \"3039ffbc-165a-46ef-849b-95c7df9aacfa\",\n \"origin\": 1659672857568971786,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DeviceInformation\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"FirmwareVersion\": \"1.1.16 Build 211209 Rel.37726n(4555)\",\n \"HardwareId\": \"1.0\",\n \"Manufacturer\": \"TP-Link\",\n \"Model\": \"C200\",\n \"SerialNumber\": \"00c20000\"\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"193b3677-23c8-4d89-852e-73a1aabf445e\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkProtocols\",\n \"origin\": 1659671976670370385,\n \"readings\": [\n {\n \"id\": \"d3a47ec4-3b43-413a-9a67-42f54487cfa5\",\n \"origin\": 1659671976670370385,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkProtocols\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkProtocols\": [\n {\n \"Enabled\": true,\n \"Name\": \"HTTPS\",\n \"Port\": 443\n },\n {\n \"Enabled\": true,\n \"Name\": \"RTSP\",\n \"Port\": 554\n }\n ]\n }\n }\n ]\n }\n}" } ] }, { - "name": "SystemDateAndTime", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, + "name": "SetNetworkProtocols", "request": { - "method": "GET", + "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "raw": "{\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 2020\n },\n {\n \"Name\": \"HTTPS\",\n \"Enabled\": false,\n \"Port\": 443\n },\n {\n \"Name\": \"RTSP\",\n \"Enabled\": true,\n \"Port\": 554\n }\n ]\n } \n}", "options": { "raw": { "language": "json" @@ -1192,7 +1182,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", "protocol": "http", "host": [ "0", @@ -1207,19 +1197,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SystemDateAndTime" + "NetworkProtocols" ] }, - "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.\n\nA device shall provide the UTCDateTime information." + "description": "This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command." }, "response": [ { - "name": "SystemDateAndTime", + "name": "SetNetworkProtocols", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 2020\n },\n {\n \"Name\": \"HTTPS\",\n \"Enabled\": false,\n \"Port\": 443\n },\n {\n \"Name\": \"RTSP\",\n \"Enabled\": true,\n \"Port\": 554\n }\n ]\n } \n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkProtocols", "protocol": "http", "host": [ "0", @@ -1234,7 +1233,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SystemDateAndTime" + "NetworkProtocols" ] } }, @@ -1248,30 +1247,33 @@ }, { "key": "X-Correlation-Id", - "value": "81f90086-d959-4f35-9bf6-9b814d7a10c4" + "value": "a7f75e35-bb5c-46b2-a502-c269c574a7b0" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 04:14:25 GMT" + "value": "Fri, 23 Sep 2022 16:26:38 GMT" }, { "key": "Content-Length", - "value": "886" + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"da6f552e-e4b3-4d75-a2ce-989745b8ef7b\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"SystemDateAndTime\",\n \"origin\": 1659672865881317546,\n \"readings\": [\n {\n \"id\": \"aa61a541-beb5-4be0-bb7a-625ce60a980e\",\n \"origin\": 1659672865881317546,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"SystemDateAndTime\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"SystemDateAndTime\": {\n \"DateTimeType\": \"NTP\",\n \"DaylightSavings\": true,\n \"Extension\": \"\",\n \"LocalDateTime\": {\n \"Date\": {\n \"Month\": \"8\",\n \"Year\": \"2022\",\n \"Day\": \"11\"\n },\n \"Time\": {\n \"Hour\": \"21\",\n \"Minute\": \"14\",\n \"Second\": \"25\"\n }\n },\n \"TimeZone\": {\n \"TZ\": \"GMT+08:00DST+07:00,M3.2.0/02:00:00,M11.1.0/02:00:00\\n\"\n },\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": \"8\",\n \"Year\": \"2022\",\n \"Day\": \"11\"\n },\n \"Time\": {\n \"Hour\": \"4\",\n \"Minute\": \"14\",\n \"Second\": \"25\"\n }\n }\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "SetSystemDateAndTime", + "name": "NetworkDefaultGateway", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, "request": { - "method": "PUT", + "method": "GET", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SystemDateAndTime\": {\n \"DateTimeType\":\"Manual\",\n \"DaylightSavings\": false,\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": 12,\n \"Year\": 2021,\n \"Day\": 11\n\n },\n \"Time\": {\n \"Hour\": 5,\n \"Minute\": 48,\n \"Second\": 20\n }\n }\n }\n}", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", "options": { "raw": { "language": "json" @@ -1279,7 +1281,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", "protocol": "http", "host": [ "0", @@ -1294,28 +1296,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SystemDateAndTime" + "NetworkDefaultGateway" ] }, - "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.\n\nIf system time and date are set manually, the client shall include UTCDateTime in the request.\n\nA TimeZone token which is not formed according to the rules of IEEE 1003.1 section 8.3 is considered as invalid timezone.\n\nThe 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." + "description": "This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es)." }, "response": [ { - "name": "SetSystemDateAndTime", + "name": "NetworkDefaultGateway", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"SystemDateAndTime\": {\n \"DateTimeType\":\"Manual\",\n \"DaylightSavings\": false,\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": 12,\n \"Year\": 2021,\n \"Day\": 11\n\n },\n \"Time\": {\n \"Hour\": 5,\n \"Minute\": 48,\n \"Second\": 20\n }\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", "protocol": "http", "host": [ "0", @@ -1330,7 +1323,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SystemDateAndTime" + "NetworkDefaultGateway" ] } }, @@ -1338,24 +1331,36 @@ "code": 200, "_postman_previewlanguage": "json", "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, { "key": "X-Correlation-Id", - "value": "fb9339bb-b588-49f8-82b1-d0da167897c0" + "value": "e24e3e01-1680-40c6-ae25-3151ff5aafef" + }, + { + "key": "Date", + "value": "Fri, 05 Aug 2022 03:59:47 GMT" + }, + { + "key": "Content-Length", + "value": "558" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"78915210-fab0-4018-a8ed-72f793c2cbc7\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkDefaultGateway\",\n \"origin\": 1659671987813255281,\n \"readings\": [\n {\n \"id\": \"c348128d-0c51-4470-a978-b431302906a0\",\n \"origin\": 1659671987813255281,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkDefaultGateway\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkGateway\": {}\n }\n }\n ]\n }\n}" } ] }, { - "name": "SetSystemFactoryDefault", + "name": "SetNetworkDefaultGateway", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetSystemFactoryDefault\": {\n \"FactoryDefault\":\"Soft\"\n }\n}", + "raw": "{\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n } \n}", "options": { "raw": { "language": "json" @@ -1363,7 +1368,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SetSystemFactoryDefault", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", "protocol": "http", "host": [ "0", @@ -1378,20 +1383,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SetSystemFactoryDefault" + "NetworkDefaultGateway" ] }, - "description": "This operation reloads the parameters on the device to their factory default values." + "description": "This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command." }, "response": [ { - "name": "SetSystemFactoryDefault", + "name": "SetNetworkDefaultGateway", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetSystemFactoryDefault\": {\n \"FactoryDefault\":\"Soft\"\n }\n}", + "raw": "{\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n } \n}", "options": { "raw": { "language": "json" @@ -1399,7 +1404,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SetSystemFactoryDefault", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkDefaultGateway", "protocol": "http", "host": [ "0", @@ -1414,7 +1419,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SetSystemFactoryDefault" + "NetworkDefaultGateway" ] } }, @@ -1428,11 +1433,11 @@ }, { "key": "X-Correlation-Id", - "value": "fb9339bb-b588-49f8-82b1-d0da167897c0" + "value": "84ab80db-4334-49e7-a956-e2ce4aab9b99" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 16:27:07 GMT" + "value": "Fri, 23 Sep 2022 16:26:55 GMT" }, { "key": "Content-Length", @@ -1445,12 +1450,24 @@ ] }, { - "name": "RebootNeeded", + "name": "NetworkConfiguration", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, "request": { "method": "GET", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RebootNeeded", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", "protocol": "http", "host": [ "0", @@ -1465,19 +1482,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "RebootNeeded" + "NetworkConfiguration" ] }, - "description": "Indicates whether or not a reboot is required after configuration updates." + "description": "Used to retrieve network resources for a device such as Hostname, DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway." }, "response": [ { - "name": "RebootNeeded", + "name": "NetworkConfiguration", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RebootNeeded", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", "protocol": "http", "host": [ "0", @@ -1492,7 +1509,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "RebootNeeded" + "NetworkConfiguration" ] } }, @@ -1506,30 +1523,30 @@ }, { "key": "X-Correlation-Id", - "value": "88967d2b-dc04-4cd8-9cad-9c82c92ded44" + "value": "eef44832-ed52-4799-be75-9d247984114f" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 04:14:42 GMT" + "value": "Thu, 04 Aug 2022 23:42:57 GMT" }, { "key": "Content-Length", - "value": "507" + "value": "1944" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"cb3b3a49-86e4-44e3-b2a0-426b08168ae1\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"RebootNeeded\",\n \"origin\": 1659672882772484274,\n \"readings\": [\n {\n \"id\": \"f56f48df-d664-4179-98d1-abcb496f07bc\",\n \"origin\": 1659672882772484274,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"RebootNeeded\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Bool\",\n \"value\": \"false\"\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"b34fe9d1-78f9-4b49-961b-80a252e084c4\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkConfiguration\",\n \"origin\": 1659656577804929222,\n \"readings\": [\n {\n \"id\": \"67e318f5-4426-48ff-8235-4a2471e47baf\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Hostname\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"HostnameInformation\": {\n \"FromDHCP\": false,\n \"Name\": \"hostname\"\n }\n }\n },\n {\n \"id\": \"76cfd2b5-f178-4d16-88d1-6b04f129a867\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DNS\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DNSInformation\": {}\n }\n },\n {\n \"id\": \"301b79ab-c92d-4a3f-9776-9a71f6c3c340\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkInterfaces\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkInterfaces\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"Config\": {\n \"DHCP\": false,\n \"Manual\": {\n \"Address\": \"10.0.0.188\",\n \"PrefixLength\": 24\n }\n },\n \"Enabled\": true\n },\n \"Info\": {\n \"HwAddress\": \"10:27:F5:EA:88:F4\",\n \"MTU\": 1500,\n \"Name\": \"eth0\"\n },\n \"Token\": \"eth0\"\n }\n }\n },\n {\n \"id\": \"cc1d5230-06a8-4515-822e-187ba07d0efc\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkProtocols\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkProtocols\": [\n {\n \"Enabled\": true,\n \"Name\": \"HTTPS\",\n \"Port\": 443\n },\n {\n \"Enabled\": true,\n \"Name\": \"RTSP\",\n \"Port\": 554\n }\n ]\n }\n },\n {\n \"id\": \"81f9c4e6-1cfd-487a-a05b-b8ea5b39ffcf\",\n \"origin\": 1659656577804929222,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkDefaultGateway\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkGateway\": {}\n }\n }\n ]\n }\n}" } ] }, { - "name": "SystemReboot", + "name": "SetNetworkConfiguration", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SystemReboot\": {}\n}", + "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost\"\n },\n \"DNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n },\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": false\n }\n }\n \n },\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [ \n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 80\n }\n ]\n },\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", "options": { "raw": { "language": "json" @@ -1537,7 +1554,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemReboot", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", "protocol": "http", "host": [ "0", @@ -1552,19 +1569,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SystemReboot" + "NetworkConfiguration" ] - } + }, + "description": "Used to configure network resources for a device such as Hostname, DNS, NetworkInterfaces, NetworkProtocols and NetworkDefaultGateway." }, "response": [ { - "name": "SystemReboot", + "name": "SetNetworkConfiguration", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SystemReboot\": {}\n}", + "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost\"\n },\n \"DNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n },\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": false\n }\n }\n \n },\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [ \n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 80\n }\n ]\n },\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", "options": { "raw": { "language": "json" @@ -1572,7 +1590,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemReboot", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/NetworkConfiguration", "protocol": "http", "host": [ "0", @@ -1587,10 +1605,10 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "SystemReboot" + "NetworkConfiguration" ] }, - "description": "Indicates whether or not a reboot is required after configuration updates." + "description": "Onvif Protocol Specification [https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl](https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl)" }, "status": "OK", "code": 200, @@ -1602,11 +1620,11 @@ }, { "key": "X-Correlation-Id", - "value": "0b194034-4975-4f5b-8141-63ec88666987" + "value": "2955d163-0007-4fa3-9a2c-267510c01e44" }, { "key": "Date", - "value": "Fri, 07 Oct 2022 21:55:59 GMT" + "value": "Fri, 23 Sep 2022 23:10:59 GMT" }, { "key": "Content-Length", @@ -1621,15 +1639,15 @@ ] }, { - "name": "Metadata Configuration", + "name": "System Function", "item": [ { - "name": "MetadataConfigurations", + "name": "DeviceInformation", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurations", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeviceInformation", "protocol": "http", "host": [ "0", @@ -1644,19 +1662,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfigurations" + "DeviceInformation" ] }, - "description": "This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command." + "description": "This operation gets basic device information from the device." }, "response": [ { - "name": "MetadataConfigurations", + "name": "DeviceInformation", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurations", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeviceInformation", "protocol": "http", "host": [ "0", @@ -1671,7 +1689,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfigurations" + "DeviceInformation" ] } }, @@ -1685,29 +1703,41 @@ }, { "key": "X-Correlation-Id", - "value": "7358d440-ed28-4f52-ab63-d28fb53d7c51" + "value": "76d81da0-eba7-4e98-9d92-b60560c20a94" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:20 GMT" + "value": "Fri, 05 Aug 2022 04:14:17 GMT" }, { "key": "Content-Length", - "value": "560" + "value": "672" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"1acba723-b1b1-4790-8e80-9d554cacaedc\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurations\",\n \"origin\": 1659659180814799513,\n \"readings\": [\n {\n \"id\": \"8c59a3a8-401b-4e18-8af5-9a98efe7f410\",\n \"origin\": 1659659180814799513,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"MetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"a025e1b1-7e2b-4db8-95b6-7dac978e9c97\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DeviceInformation\",\n \"origin\": 1659672857568971786,\n \"readings\": [\n {\n \"id\": \"3039ffbc-165a-46ef-849b-95c7df9aacfa\",\n \"origin\": 1659672857568971786,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DeviceInformation\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"FirmwareVersion\": \"1.1.16 Build 211209 Rel.37726n(4555)\",\n \"HardwareId\": \"1.0\",\n \"Manufacturer\": \"TP-Link\",\n \"Model\": \"C200\",\n \"SerialNumber\": \"00c20000\"\n }\n }\n ]\n }\n}" } ] }, { - "name": "MetadataConfiguration", + "name": "SystemDateAndTime", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, "request": { "method": "GET", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration?jsonObject={{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", "protocol": "http", "host": [ "0", @@ -1722,25 +1752,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfiguration" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}" - } + "SystemDateAndTime" ] }, - "description": "The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known." + "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.\n\nA device shall provide the UTCDateTime information." }, "response": [ { - "name": "MetadataConfiguration", + "name": "SystemDateAndTime", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration?jsonObject={{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", "protocol": "http", "host": [ "0", @@ -1755,13 +1779,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfiguration" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}" - } + "SystemDateAndTime" ] } }, @@ -1775,30 +1793,30 @@ }, { "key": "X-Correlation-Id", - "value": "96f2ec58-26af-410c-8264-5c62c45425eb" + "value": "81f90086-d959-4f35-9bf6-9b814d7a10c4" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 23:11:29 GMT" + "value": "Fri, 05 Aug 2022 04:14:25 GMT" }, { "key": "Content-Length", - "value": "557" + "value": "886" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"53480499-ece4-4437-b795-0ff4f57a564a\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfiguration\",\n \"origin\": 1663974689815368367,\n \"readings\": [\n {\n \"id\": \"b6cda316-6a50-4990-8279-e2777be95c79\",\n \"origin\": 1663974689815368367,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688\",\n \"resourceName\": \"MetadataConfiguration\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configuration\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"da6f552e-e4b3-4d75-a2ce-989745b8ef7b\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"SystemDateAndTime\",\n \"origin\": 1659672865881317546,\n \"readings\": [\n {\n \"id\": \"aa61a541-beb5-4be0-bb7a-625ce60a980e\",\n \"origin\": 1659672865881317546,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"SystemDateAndTime\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"SystemDateAndTime\": {\n \"DateTimeType\": \"NTP\",\n \"DaylightSavings\": true,\n \"Extension\": \"\",\n \"LocalDateTime\": {\n \"Date\": {\n \"Month\": \"8\",\n \"Year\": \"2022\",\n \"Day\": \"11\"\n },\n \"Time\": {\n \"Hour\": \"21\",\n \"Minute\": \"14\",\n \"Second\": \"25\"\n }\n },\n \"TimeZone\": {\n \"TZ\": \"GMT+08:00DST+07:00,M3.2.0/02:00:00,M11.1.0/02:00:00\\n\"\n },\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": \"8\",\n \"Year\": \"2022\",\n \"Day\": \"11\"\n },\n \"Time\": {\n \"Hour\": \"4\",\n \"Minute\": \"14\",\n \"Second\": \"25\"\n }\n }\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "SetMetadataConfiguration", + "name": "SetSystemDateAndTime", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"MetadataConfiguration\": {\n \"ForcePersistence\": true,\n \"Configuration\":{\n \"token\": \"{{MEDIA_CONFIG_TOKEN}}\",\n \"Analytics\": true\n }\n \n }\n}", + "raw": "{\n \"SystemDateAndTime\": {\n \"DateTimeType\":\"Manual\",\n \"DaylightSavings\": false,\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": 12,\n \"Year\": 2021,\n \"Day\": 11\n\n },\n \"Time\": {\n \"Hour\": 5,\n \"Minute\": 48,\n \"Second\": 20\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -1806,7 +1824,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", "protocol": "http", "host": [ "0", @@ -1821,20 +1839,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfiguration" + "SystemDateAndTime" ] }, - "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." + "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.\n\nIf system time and date are set manually, the client shall include UTCDateTime in the request.\n\nA TimeZone token which is not formed according to the rules of IEEE 1003.1 section 8.3 is considered as invalid timezone.\n\nThe 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." }, "response": [ { - "name": "SetMetadataConfiguration", + "name": "SetSystemDateAndTime", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"MetadataConfiguration\": {\n \"ForcePersistence\": true,\n \"Configuration\":{\n \"token\": \"{{MEDIA_CONFIG_TOKEN}}\",\n \"Analytics\": true\n }\n \n }\n}", + "raw": "{\n \"SystemDateAndTime\": {\n \"DateTimeType\":\"Manual\",\n \"DaylightSavings\": false,\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": 12,\n \"Year\": 2021,\n \"Day\": 11\n\n },\n \"Time\": {\n \"Hour\": 5,\n \"Minute\": 48,\n \"Second\": 20\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -1842,7 +1860,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemDateAndTime", "protocol": "http", "host": [ "0", @@ -1857,7 +1875,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfiguration" + "SystemDateAndTime" ] } }, @@ -1865,21 +1883,9 @@ "code": 200, "_postman_previewlanguage": "json", "header": [ - { - "key": "Content-Type", - "value": "application/json" - }, { "key": "X-Correlation-Id", - "value": "f9b22e19-bfba-4bb3-84bf-48ed200b9cf1" - }, - { - "key": "Date", - "value": "Fri, 23 Sep 2022 23:13:37 GMT" - }, - { - "key": "Content-Length", - "value": "37" + "value": "fb9339bb-b588-49f8-82b1-d0da167897c0" } ], "cookie": [], @@ -1888,12 +1894,21 @@ ] }, { - "name": "CompatibleMetadataConfigurations", + "name": "SetSystemFactoryDefault", "request": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetSystemFactoryDefault\": {\n \"FactoryDefault\":\"Soft\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/CompatibleMetadataConfigurations?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SetSystemFactoryDefault", "protocol": "http", "host": [ "0", @@ -1908,25 +1923,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "CompatibleMetadataConfigurations" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" - } + "SetSystemFactoryDefault" ] }, - "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." + "description": "This operation reloads the parameters on the device to their factory default values." }, "response": [ { - "name": "CompatibleMetadataConfigurations", + "name": "SetSystemFactoryDefault", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"SetSystemFactoryDefault\": {\n \"FactoryDefault\":\"Soft\"\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/CompatibleMetadataConfigurations?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SetSystemFactoryDefault", "protocol": "http", "host": [ "0", @@ -1941,13 +1959,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "CompatibleMetadataConfigurations" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" - } + "SetSystemFactoryDefault" ] } }, @@ -1961,29 +1973,29 @@ }, { "key": "X-Correlation-Id", - "value": "362fa295-c750-49a8-a457-a5b5d1486cc6" + "value": "fb9339bb-b588-49f8-82b1-d0da167897c0" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:28 GMT" + "value": "Fri, 23 Sep 2022 16:27:07 GMT" }, { "key": "Content-Length", - "value": "580" + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"410b5658-82d9-488c-a5c4-c69f0ff6d273\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"CompatibleMetadataConfigurations\",\n \"origin\": 1659659188300470539,\n \"readings\": [\n {\n \"id\": \"86aa4298-c8ee-4c74-afc9-73104bb3cd11\",\n \"origin\": 1659659188300470539,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"CompatibleMetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "MetadataConfigurationOptions", + "name": "RebootNeeded", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RebootNeeded", "protocol": "http", "host": [ "0", @@ -1998,25 +2010,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfigurationOptions" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}" - } + "RebootNeeded" ] }, - "description": "This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration." + "description": "Indicates whether or not a reboot is required after configuration updates." }, "response": [ { - "name": "MetadataConfigurationOptions", + "name": "RebootNeeded", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RebootNeeded", "protocol": "http", "host": [ "0", @@ -2031,13 +2037,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "MetadataConfigurationOptions" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}" - } + "RebootNeeded" ] } }, @@ -2051,30 +2051,30 @@ }, { "key": "X-Correlation-Id", - "value": "fcbe3f78-3851-44ac-a75f-238527b90ea7" + "value": "88967d2b-dc04-4cd8-9cad-9c82c92ded44" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:34 GMT" + "value": "Fri, 05 Aug 2022 04:14:42 GMT" }, { "key": "Content-Length", - "value": "565" + "value": "507" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"f296e8b5-707f-4e66-9388-918821b83a19\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurationOptions\",\n \"origin\": 1659659194429862266,\n \"readings\": [\n {\n \"id\": \"f8efa15a-612d-4532-b40b-4e895cecb3bd\",\n \"origin\": 1659659194429862266,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"MetadataConfigurationOptions\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Options\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"cb3b3a49-86e4-44e3-b2a0-426b08168ae1\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"RebootNeeded\",\n \"origin\": 1659672882772484274,\n \"readings\": [\n {\n \"id\": \"f56f48df-d664-4179-98d1-abcb496f07bc\",\n \"origin\": 1659672882772484274,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"RebootNeeded\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Bool\",\n \"value\": \"false\"\n }\n ]\n }\n}" } ] }, { - "name": "AddMetadataConfiguration", + "name": "SystemReboot", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"AddMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"ConfigurationToken\": \"{{MEDIA_CONFIG_TOKEN}}\"\n }\n}", + "raw": "{\n \"SystemReboot\": {}\n}", "options": { "raw": { "language": "json" @@ -2082,7 +2082,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddMetadataConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemReboot", "protocol": "http", "host": [ "0", @@ -2097,20 +2097,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "AddMetadataConfiguration" + "SystemReboot" ] - }, - "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." + } }, "response": [ { - "name": "AddMetadataConfiguration", + "name": "SystemReboot", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"AddMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"ConfigurationToken\": \"{{MEDIA_CONFIG_TOKEN}}\"\n }\n}", + "raw": "{\n \"SystemReboot\": {}\n}", "options": { "raw": { "language": "json" @@ -2118,7 +2117,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddMetadataConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/SystemReboot", "protocol": "http", "host": [ "0", @@ -2133,9 +2132,10 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "AddMetadataConfiguration" + "SystemReboot" ] - } + }, + "description": "Indicates whether or not a reboot is required after configuration updates." }, "status": "OK", "code": 200, @@ -2147,11 +2147,11 @@ }, { "key": "X-Correlation-Id", - "value": "9aaf8833-760d-4e7b-ac10-123c36fa71fb" + "value": "0b194034-4975-4f5b-8141-63ec88666987" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 23:13:44 GMT" + "value": "Fri, 07 Oct 2022 21:55:59 GMT" }, { "key": "Content-Length", @@ -2162,23 +2162,19 @@ "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] - }, + } + ] + }, + { + "name": "User Handling", + "item": [ { - "name": "RemoveMetadataConfiguration", + "name": "Get users", "request": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"RemoveMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveMetadataConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", "protocol": "http", "host": [ "0", @@ -2193,28 +2189,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "RemoveMetadataConfiguration" + "Users" ] }, - "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." + "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." }, "response": [ { - "name": "RemoveMetadataConfiguration", + "name": "Get users", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"RemoveMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveMetadataConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", "protocol": "http", "host": [ "0", @@ -2229,7 +2216,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "RemoveMetadataConfiguration" + "Users" ] } }, @@ -2243,38 +2230,30 @@ }, { "key": "X-Correlation-Id", - "value": "f591166b-b0ae-4c3e-8d87-3fa2fb0f180c" + "value": "16c7a0fe-a3fc-4b4f-a8e3-110ba2f0325a" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 23:13:48 GMT" + "value": "Sun, 25 Sep 2022 03:40:38 GMT" }, { "key": "Content-Length", - "value": "37" + "value": "609" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"8e524ecd-674d-4dd8-b728-de78b8245189\",\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Users\",\n \"origin\": 1664077238993899589,\n \"readings\": [\n {\n \"id\": \"f5086b88-9876-4627-91d5-7ce39431652e\",\n \"origin\": 1664077238993899589,\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"resourceName\": \"Users\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"User\": [\n {\n \"UserLevel\": \"Administrator\",\n \"Username\": \"admin\"\n },\n {\n \"UserLevel\": \"User\",\n \"Username\": \"user\"\n }\n ]\n }\n }\n ]\n }\n}" } ] - } - ] - }, - { - "name": "Video Streaming", - "item": [ + }, { - "name": "Profiles", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, + "name": "Create Users", "request": { - "method": "GET", + "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", + "raw": "{\n \"CreateUsers\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n }\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -2282,7 +2261,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Profiles", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/CreateUsers", "protocol": "http", "host": [ "0", @@ -2297,35 +2276,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Profiles" + "CreateUsers" ] }, - "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." + "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.\n\nONVIF 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." }, "response": [ { - "name": "Profiles", + "name": "Create Users", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"CreateUsers\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Profiles", - "protocol": "http", - "host": [ - "0", - "0", - "0", - "0" - ], - "port": "59882", - "path": [ - "api", - "v2", - "device", - "name", - "{{EDGEX_DEVICE_NAME}}", - "Profiles" - ] + "raw": "" } }, "status": "OK", @@ -2338,29 +2310,38 @@ }, { "key": "X-Correlation-Id", - "value": "00d76d82-033a-4787-ac76-3e049ca16294" + "value": "e772e887-419e-4647-ae97-59722fbc7317" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:38:34 GMT" + "value": "Sun, 25 Sep 2022 03:40:48 GMT" }, { - "key": "Transfer-Encoding", - "value": "chunked" + "key": "Content-Length", + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"e6560b52-1952-4d66-9f53-3cf27d48b3c0\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Profiles\",\n \"origin\": 1659656314715442631,\n \"readings\": [\n {\n \"id\": \"5c7bc03c-308f-4b2c-8bc9-2e59da7d6f65\",\n \"origin\": 1659656314715442631,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Profiles\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Profiles\": [\n {\n \"AudioEncoderConfiguration\": {\n \"Bitrate\": 131072,\n \"Encoding\": \"G711\",\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"AudioEncoder_1\",\n \"SampleRate\": 8000,\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"microphone\",\n \"UseCount\": 2\n },\n \"AudioSourceConfiguration\": {\n \"Name\": \"AudioSourceConfig\",\n \"SourceToken\": \"raw_as1\",\n \"Token\": \"asconf\",\n \"UseCount\": 2\n },\n \"Extension\": null,\n \"Fixed\": true,\n \"MetadataConfiguration\": null,\n \"Name\": \"mainStream\",\n \"PTZConfiguration\": {\n \"DefaultAbsolutePantTiltPositionSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace\",\n \"DefaultContinuousPanTiltVelocitySpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace\",\n \"DefaultPTZSpeed\": {},\n \"DefaultPTZTimeout\": \"PT0H0M20S\",\n \"DefaultRelativePanTiltTranslationSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace\",\n \"PanTiltLimits\": {\n \"Range\": {\n \"URI\": \"\",\n \"XRange\": {\n \"Max\": 170,\n \"Min\": -170\n },\n \"YRange\": {\n \"Max\": 35,\n \"Min\": -32\n }\n }\n },\n \"Token\": \"PTZConfiguration0\"\n },\n \"Token\": \"profile_1\",\n \"VideoAnalyticsConfiguration\": {\n \"AnalyticsEngineConfiguration\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"medium\"\n },\n {\n \"Name\": \"Enabled\",\n \"Value\": \"off\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n },\n {\n \"Name\": \"MyTamperDetecModule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\"\n },\n {\n \"Name\": \"Enabled\"\n }\n ]\n },\n \"Type\": \"tt:TamperEngine\"\n }\n ]\n },\n \"Name\": \"VideoAnalyticsName\",\n \"RuleEngineConfiguration\": {\n \"Rule\": {\n \"Name\": \"MyTamperDetectorRule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"ActiveCells\",\n \"Value\": \"0P8A8A==\"\n },\n {\n \"Name\": \"MinCount\",\n \"Value\": \"5\"\n },\n {\n \"Name\": \"AlarmOnDelay\",\n \"Value\": \"1000\"\n },\n {\n \"Name\": \"AlarmOffDelay\",\n \"Value\": \"1000\"\n }\n ]\n },\n \"Type\": \"tt:TamperDetector\"\n }\n },\n \"Token\": \"VideoAnalyticsToken\",\n \"UseCount\": 2\n },\n \"VideoEncoderConfiguration\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_1\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 1024,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 1080,\n \"Width\": 1920\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"main\",\n \"UseCount\": 1\n },\n \"VideoSourceConfiguration\": {\n \"Bounds\": {\n \"Height\": 720,\n \"Width\": 1280,\n \"X\": 0,\n \"Y\": 0\n },\n \"Extension\": null,\n \"Name\": \"VideoSourceConfig\",\n \"SourceToken\": \"raw_vs1\",\n \"Token\": \"vsconf\",\n \"UseCount\": 2,\n \"ViewMode\": \"\"\n }\n },\n {\n \"AudioEncoderConfiguration\": {\n \"Bitrate\": 131072,\n \"Encoding\": \"G711\",\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"AudioEncoder_1\",\n \"SampleRate\": 8000,\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"microphone\",\n \"UseCount\": 2\n },\n \"AudioSourceConfiguration\": {\n \"Name\": \"AudioSourceConfig\",\n \"SourceToken\": \"raw_as1\",\n \"Token\": \"asconf\",\n \"UseCount\": 2\n },\n \"Extension\": null,\n \"Fixed\": true,\n \"MetadataConfiguration\": null,\n \"Name\": \"minorStream\",\n \"PTZConfiguration\": {\n \"DefaultAbsolutePantTiltPositionSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace\",\n \"DefaultContinuousPanTiltVelocitySpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace\",\n \"DefaultPTZSpeed\": {},\n \"DefaultPTZTimeout\": \"PT0H0M20S\",\n \"DefaultRelativePanTiltTranslationSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace\",\n \"PanTiltLimits\": {\n \"Range\": {\n \"URI\": \"\",\n \"XRange\": {\n \"Max\": 170,\n \"Min\": -170\n },\n \"YRange\": {\n \"Max\": 35,\n \"Min\": -32\n }\n }\n },\n \"Token\": \"PTZConfiguration0\"\n },\n \"Token\": \"profile_2\",\n \"VideoAnalyticsConfiguration\": {\n \"AnalyticsEngineConfiguration\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"medium\"\n },\n {\n \"Name\": \"Enabled\",\n \"Value\": \"off\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n },\n {\n \"Name\": \"MyTamperDetecModule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\"\n },\n {\n \"Name\": \"Enabled\"\n }\n ]\n },\n \"Type\": \"tt:TamperEngine\"\n }\n ]\n },\n \"Name\": \"VideoAnalyticsName\",\n \"RuleEngineConfiguration\": {\n \"Rule\": {\n \"Name\": \"MyTamperDetectorRule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"ActiveCells\",\n \"Value\": \"0P8A8A==\"\n },\n {\n \"Name\": \"MinCount\",\n \"Value\": \"5\"\n },\n {\n \"Name\": \"AlarmOnDelay\",\n \"Value\": \"1000\"\n },\n {\n \"Name\": \"AlarmOffDelay\",\n \"Value\": \"1000\"\n }\n ]\n },\n \"Type\": \"tt:TamperDetector\"\n }\n },\n \"Token\": \"VideoAnalyticsToken\",\n \"UseCount\": 2\n },\n \"VideoEncoderConfiguration\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_2\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 256,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 360,\n \"Width\": 640\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"minor\",\n \"UseCount\": 1\n },\n \"VideoSourceConfiguration\": {\n \"Bounds\": {\n \"Height\": 720,\n \"Width\": 1280,\n \"X\": 0,\n \"Y\": 0\n },\n \"Extension\": null,\n \"Name\": \"VideoSourceConfig\",\n \"SourceToken\": \"raw_vs1\",\n \"Token\": \"vsconf\",\n \"UseCount\": 2,\n \"ViewMode\": \"\"\n }\n }\n ]\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "StreamUri", + "name": "Set users", "request": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"Users\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Administrator\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Operator\"\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", "protocol": "http", "host": [ "0", @@ -2375,25 +2356,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "StreamUri" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}" - } + "Users" ] }, - "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).\n\nThe correct syntax for the StreamSetup element for these media stream setups defined in 5.1.1 of the streaming specification are as follows: \nRTP unicast over UDP: StreamType = \"RTP_unicast\", TransportProtocol = \"UDP\" \nRTP over RTSP over HTTP over TCP: StreamType = \"RTP_unicast\", TransportProtocol = \"HTTP\" \nRTP over RTSP over TCP: StreamType = \"RTP_unicast\", TransportProtocol = \"RTSP\"\n\nIf a multicast stream is requested at least one of VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration shall have a valid multicast setting.\n\nFor full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets." + "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.\n\nONVIF 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." }, "response": [ { - "name": "StreamUri", + "name": "Set users", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"Users\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Administrator\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Operator\"\n }\n ]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", "protocol": "http", "host": [ "0", @@ -2408,13 +2392,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "StreamUri" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}" - } + "Users" ] } }, @@ -2428,29 +2406,38 @@ }, { "key": "X-Correlation-Id", - "value": "ed49c080-d872-4c97-bf07-f0cf95795fb9" + "value": "bc42d5ca-4132-47e5-b159-98ca2aa1cdb8" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:38:43 GMT" + "value": "Sun, 25 Sep 2022 03:40:53 GMT" }, { "key": "Content-Length", - "value": "641" + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"0ef64d9b-ba26-49a9-9a9f-5ec6f7b47190\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"StreamUri\",\n \"origin\": 1659656323588826999,\n \"readings\": [\n {\n \"id\": \"255085ba-4399-489d-aa34-cab5e1379281\",\n \"origin\": 1659656323588826999,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"StreamUri\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"MediaUri\": {\n \"InvalidAfterConnect\": false,\n \"InvalidAfterReboot\": false,\n \"Timeout\": \"PT0H0M2S\",\n \"Uri\": \"rtsp://10.0.0.188:554/stream1\"\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "Snapshot", + "name": "Delete users", "request": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"DeleteUsers\": {\n \"Username\": [\"user1\",\"user2\"]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Snapshot", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeleteUsers", "protocol": "http", "host": [ "0", @@ -2465,19 +2452,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Snapshot" + "DeleteUsers" ] }, - "description": "This request returns a snapshot of the video stream at the time the command is given.\n\nIt is returned in a binary format." + "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." }, "response": [ { - "name": "Snapshot", + "name": "Delete users", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"DeleteUsers\": {\n \"Username\": [\"user1\",\"user2\"]\n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Snapshot", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeleteUsers", "protocol": "http", "host": [ "0", @@ -2492,7 +2488,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Snapshot" + "DeleteUsers" ] } }, @@ -2506,46 +2502,34 @@ }, { "key": "X-Correlation-Id", - "value": "e1116b67-69cd-4ed8-9b70-f543c9cf4a17" + "value": "12780a21-c3b4-42b1-9e46-11369a5926de" }, { "key": "Date", - "value": "Mon, 10 Oct 2022 15:25:00 GMT" + "value": "Sun, 25 Sep 2022 03:40:57 GMT" }, { - "key": "Transfer-Encoding", - "value": "chunked" + "key": "Content-Length", + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"5fdf593f-2a92-4a71-b08c-791d7a27fdff\",\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Snapshot\",\n \"origin\": 1665415500727830418,\n \"readings\": [\n {\n \"id\": \"d04a9dad-feb9-4099-a524-8a4b4cf2cc37\",\n \"origin\": 1665415500727830418,\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"resourceName\": \"Snapshot\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Binary\",\n \"binaryValue\": \"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACAAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDzGwiBtoGx/wAs1/kK0BGPSotPH+g23/XFP5CreKxOyOwxVqTYuOlAWn7eKQFd1VQDtH3hUgtoz1QUsq/u2PoM1PikBCLWL+4KelkhOQSAOp3dKoX+sQWalVO+X0HasB9bumOfMP0oDmR2T6c/klt/4d/5VRvNOkhxvQrkcblH4/rmsaz8TT25bzP3qMCNp7Z9K3IvGcU0C211F5kROTnG4dOh7dKYXTMPysXeMV0MKgDpVC4+xTXiy2QkMXPDNuI4rRgGcUBYsqgFSgUiLUoFMmwzbU8a0wLzVmMAimMlij713+h2a2lhEpX52G5vxrj9Nthc3kUJGQx5HtXoUaYFBUELIgYZ2ivLviHKJ47tAoxDAyj8ia9TkkWGF5HOFUc15H4oJm03UZW5LQyH9DTiKo9DmdPQ/YbbH/PFP5CrgWoNNP8AxLbX/rin8hVwVIR2GBacFp4UU8LSAryL8hqrqF4LTTTICN54XNaEi/Ka5LXpi8kcfZF6e5oAxXcscmoy1KetMaqSMGLuGacGqIU8A02gNK0vWhTAJByDXX6bMLiFXXvXBxiur8NSMZBGx+X0rKRvTd3Y6VBUyjirM1uoCOg4bP5j/IqMJirTHKNhgFSxjmgJTo1IamSdL4Xh3X5fH3Vrs8Yrl/Csf7yZ/Yf1rqyKGaIyddlMemOF43naa8419c6HqJx/y7Sf+gmvQPExItIVHQuc/lXB6+MeH9SP/TtJ/wCgmtYGFU5jTVH9mWn/AFxT+Qq2FqjppP8AZ1qP+mKfyFaS9KxNI7ABTgKUCngDFICMjiuG1cEXsoPrXdtiuP8AEUW25V/7wNBMjnj1ptPbrTcc1Zix8MZedR2zzVuWEKpUDBBp1lDj5z+FWbiA7t46GspT1OmnT0uVbOHfLg9K9G0Lw8xtYLuAr5chYZZuflxk1wtpFtkz2r03w5K7aBdRXczrHbyRNGuBwH3A4+vH6UblU9GdHe2sP2Nx5iBtxK57np/9euaxTjfSSjBOBTQaqBdRp7CgU9Rg01aeOtUYnV+FjzN9BXUiuS8Ln/SWX1WuvUc0MtGJ4nQ/Z7Y44yf6VwfiEY8P6l/17Sf+gmvR/ESb9MiOORJ/MH/CvP8AxGn/ABT2pHt9lk/9BNbwOeocPp0MzWFqwdR+5T+Qq4ILr+8lJpqj+zbP/rhH/wCg1eVaxNY7FURXX95Kf9nu/wC+lWwKkAqWhmU7XKnBWsvWIxJYuzD5lwRXTyRFkIUZasPVrO5Ns6LBISeOmR+lAmjidhJp6QMx6VrLpk0Ry8R/KmPHtbGMVnKdg5CONdiYFWuGhwagqzEm5BWL1N4qxNZoN4wK9C1R/M0jSQEVWNth2A5faxVc/QAVwtpGVbPpXpviH+zrTR9Ks1niFxDHlgvcNz/P+daxYmjnIweKsqKbGqkDBzU6rWyMhB0p69aAlSpHVNEm1oD7L+L3OK7pBXnunnyriJ/Rga9CRuhpFplTWofM05sdVIavPfEq48Nap/16S/8AoBr064QTwPGf4gRXm/iZMeGtVyOlpLn/AL5NaQdkY1Fc4fTR/wASyz/64R/+gitFU4qrpUQ/sqyZ8qot48+v3RVpbiVFkiixhxg5QE/gSMj8KzNI7DguFLZGB1yRU9ncWRLLc7xgfK688+mPSs1oHbr+tK6i3i3NwPWpGaUVxam4wqMAOjMe/wBKW8vbSGM+dIq56AnrXPPeSSf8e2UTvIR/IUiwRiOS6nbeQPvSck0mxsklubedW8mVW9s1nOFOeBVS65BuYE8tg33R3FSRP5ihgeDUNDI3t1ZvkGCe1WLa3YcEVNboplBIq/GirIDjjvUuJdN62Io4SozViOEzq4X74rUisEnjPkgucZwAc04RQ2MrJEfMZ12yHHAPfFZ6nZaJjQve2hyrnGehGQa7BrcMsUsQIiliWQE+pHI/A5H4VkSxqyHI6dvSum0TbqPh2W3zmeyJdB3MZ64+h5/GtoHNWguhnhcdadkZ4pWpoHNanMWYeor0G1ffBG2eqivPYuldxob79PXnOKBo0+1cL42h8rQ9ZHrZyn/xw13ijNcj4/hx4c1WT1sZh+SGriRI820qEyaZp/p9mj/9BFX/ALKELEjHyk1Z0qK3g8M6bPMQo+yQkk+6CqNzJc3zYhR0i6Db94/X0qTSOxBcXKR/u41MkvoOg+pqolpNeEGYb8fgo/DvWpDpSR7TIM8Z254/+vV4g8jtxxQBhLZbPv8AJxj2rO1k+UkcC/Vh/KukkT94KwdcXzbmCJRl8HP41IGBGXkcKo9eKfYj9y6n7ytW9Y6X9nUtImZT+lZWwWepTQkYWTFS0ImgilyCBVxGYfeHNWEgCqAKUw07DLNrfvAwaGRo3HQqcVNJ4j1JeWuBKAc/vYlfH0yKzfLxUU/EJpWK5mbNv4kt7ydY9StIgrHDS267Hx/ujg/lWnaXn/CO67b3sJM9jJkpIoIEsZ4I+o9PUVwg4OeldZ4d1GC7h/si+ZVhIzDKesT+v0PQ/wD1qaQc76nS3doslst/asj28nQK2Sh9D+uKoVZ0OO7sdSksJ4d0E64kiZlyfQqSeTyDx1pLu0ksrh4ZR8ynGexHqKohjI+ldd4ZkzbyR+hBrkYq6Xw04W4ZP7woBHVKOK5vx9Hu8Fas392zm/8AQDXTAVheN03+BtcA6ixmP/jhoTJkeZeHLO717TtOjJKWsFtEq8dwgGa6+TSI7WFYoo8d/c1ifDS8M1ra2RXIS3VgfbA6/mK7u5T94D6AD880zWOxxU0Oxm44BqnIPmf6VuXsWC59WNY7rjf+FANFJxjrWNEq3XiBuMiPp9f8mtq6bylZj0GKo+H7cOs923LSNwfYf/XzQKxcljwM4rkNfQpepMBkcV2tyMRmuU1yJpIjjtzQFjT2DaCPTNMJpdOzLpcUjctt5PrSN1pNA0Rmqs/3TVo1Vn+6akCi9EZ/eDmnPUaffBpCO80u7l1fTWtnAluI1zbydHXH8Oe4PTnuRWvaX8eu2yQ3Mu27hG1JG4Dj0Y/ng/nWH4UMQdAW2kNuVj0Hrn/Pb61P4gtRo2us8OPKb54+OxP9Dx+FaDZfMTRMVdSpBxg1q6LKIr6LJwCcU2yceIbMTmBI5EGxpI3ySccbl9Kr2hMcqHuDQQeg1i+M/wDkR9e/7B8//otq2QQyhhyCMg1jeMv+RH1//sHT/wDotqhEyPK/BVzNptnZ6pAhkighjS6XuFIHP0+6fqK9ZiCXUMkqOGVgpUjuMZz+teWeE3XTH0l35tru0ijnB6cxjr7cg13VnIfDepCwlY/2bdHNu78+W3dCfx4qzaOwavCqwu4HaudnGE3Y9K7PVYF+zyrjI25FchIM24GOQcH8KCjn9dfZa3PbGz9RV7TrT7JYRRbcYHP1qjrdu1zfQQJ/y3Khh64P+Ga2ieKDMqXY+Suc1FC6sAOororr7hrHukySfagaZR0K7zpzI3WJsEexq64RvmQ9e1ZGiyiLUrq2b+Mfyz/jWq8TQZK8x9vagZC/ANUZjk1cnOY2+lZrNkVBJHIeaYpwaefmBpi9aQjc0q+e2ZSDxmuo1S5i1rTkjRv9Ig+aMqOq/wAQ/kR9CPSuDSUoKtW+rzWjAxvg1SYzsfD815YKZIbqAQvjzY2BLcfh/UVsEICrxNlHG9T/AD/XIrz2PV5RNuAVAeyjArqfD9691DJGzjMeHUH0PDY/Hb+tO4HpumS+bpsDbs8YNUPGX/Ij6/8A9g6f/wBFtS+HHLWTgn7r8UnjL/kR9f8A+wdP/wCi2oM5H//Z\",\n \"mediaType\": \"image/jpeg\",\n \"value\": \"\"\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] } ] }, { - "name": "Video Encoder Configuration", + "name": "Metadata Configuration", "item": [ { - "name": "VideoEncoderConfigurations", - "protocolProfileBehavior": { - "disableBodyPruning": true - }, + "name": "MetadataConfigurations", "request": { "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetVideoEncoderConfigurations", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurations", "protocol": "http", "host": [ "0", @@ -2560,19 +2544,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "GetVideoEncoderConfigurations" + "MetadataConfigurations" ] }, - "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." + "description": "This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command." }, "response": [ { - "name": "VideoEncoderConfigurations", + "name": "MetadataConfigurations", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetVideoEncoderConfigurations", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurations", "protocol": "http", "host": [ "0", @@ -2587,7 +2571,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "GetVideoEncoderConfigurations" + "MetadataConfigurations" ] } }, @@ -2601,29 +2585,29 @@ }, { "key": "X-Correlation-Id", - "value": "7330109d-9cd8-4d4d-9334-4d39860e62b3" + "value": "7358d440-ed28-4f52-ab63-d28fb53d7c51" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:43 GMT" + "value": "Fri, 05 Aug 2022 00:26:20 GMT" }, { "key": "Content-Length", - "value": "944" + "value": "560" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"1ee4ca7f-fb95-46b3-8e6d-8542b45b22d4\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"GetVideoEncoderConfigurations\",\n \"origin\": 1659659203023412427,\n \"readings\": [\n {\n \"id\": \"dd2b4e0e-9a62-49bc-a80b-071d4b1ed8e1\",\n \"origin\": 1659659203023412427,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"GetVideoEncoderConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_2\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 256,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 360,\n \"Width\": 640\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"minor\",\n \"UseCount\": 1\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"1acba723-b1b1-4790-8e80-9d554cacaedc\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurations\",\n \"origin\": 1659659180814799513,\n \"readings\": [\n {\n \"id\": \"8c59a3a8-401b-4e18-8af5-9a98efe7f410\",\n \"origin\": 1659659180814799513,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"MetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {}\n }\n }\n ]\n }\n}" } ] }, { - "name": "VideoEncoderConfiguration", + "name": "MetadataConfiguration", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration?jsonObject={{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration?jsonObject={{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -2638,25 +2622,25 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "VideoEncoderConfiguration" + "MetadataConfiguration" ], "query": [ { "key": "jsonObject", - "value": "{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}" + "value": "{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}" } ] }, - "description": "If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command." + "description": "The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known." }, "response": [ { - "name": "VideoEncoderConfiguration", + "name": "MetadataConfiguration", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration?jsonObject={{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration?jsonObject={{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -2671,12 +2655,12 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "VideoEncoderConfiguration" + "MetadataConfiguration" ], "query": [ { "key": "jsonObject", - "value": "{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}" + "value": "{{EDGEX_MEDIA_CONFIG_TOKEN_BASE64}}" } ] } @@ -2691,29 +2675,38 @@ }, { "key": "X-Correlation-Id", - "value": "2eee5539-10bd-4e4d-b259-be10351c1de2" + "value": "96f2ec58-26af-410c-8264-5c62c45425eb" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:47 GMT" + "value": "Fri, 23 Sep 2022 23:11:29 GMT" }, { "key": "Content-Length", - "value": "937" + "value": "557" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"598079d0-d169-4385-86f3-cb7a106345a5\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"VideoEncoderConfiguration\",\n \"origin\": 1659659207626081088,\n \"readings\": [\n {\n \"id\": \"86aed436-65cb-4162-b3e6-14def8e4e4d3\",\n \"origin\": 1659659207626081088,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"VideoEncoderConfiguration\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configuration\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_1\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 1024,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 1080,\n \"Width\": 1920\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"main\",\n \"UseCount\": 1\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"53480499-ece4-4437-b795-0ff4f57a564a\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfiguration\",\n \"origin\": 1663974689815368367,\n \"readings\": [\n {\n \"id\": \"b6cda316-6a50-4990-8279-e2777be95c79\",\n \"origin\": 1663974689815368367,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688\",\n \"resourceName\": \"MetadataConfiguration\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configuration\": {}\n }\n }\n ]\n }\n}" } ] }, { - "name": "VideoEncoderConfigurationOptions", + "name": "SetMetadataConfiguration", "request": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"MetadataConfiguration\": {\n \"ForcePersistence\": true,\n \"Configuration\":{\n \"token\": \"{{MEDIA_CONFIG_TOKEN}}\",\n \"Analytics\": true\n }\n \n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration", "protocol": "http", "host": [ "0", @@ -2728,25 +2721,28 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "VideoEncoderConfigurationOptions" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}" - } + "MetadataConfiguration" ] }, - "description": "This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured.\n\nFor 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.\n\nThis 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." + "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." }, "response": [ { - "name": "VideoEncoderConfigurationOptions", + "name": "SetMetadataConfiguration", "originalRequest": { - "method": "GET", + "method": "PUT", "header": [], + "body": { + "mode": "raw", + "raw": "{\n \"MetadataConfiguration\": {\n \"ForcePersistence\": true,\n \"Configuration\":{\n \"token\": \"{{MEDIA_CONFIG_TOKEN}}\",\n \"Analytics\": true\n }\n \n }\n}", + "options": { + "raw": { + "language": "json" + } + } + }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfiguration", "protocol": "http", "host": [ "0", @@ -2761,13 +2757,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "VideoEncoderConfigurationOptions" - ], - "query": [ - { - "key": "jsonObject", - "value": "{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}" - } + "MetadataConfiguration" ] } }, @@ -2781,38 +2771,29 @@ }, { "key": "X-Correlation-Id", - "value": "a84e4fb9-68a1-4b93-a48e-12d6467b5a52" + "value": "f9b22e19-bfba-4bb3-84bf-48ed200b9cf1" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:52 GMT" + "value": "Fri, 23 Sep 2022 23:13:37 GMT" }, { "key": "Content-Length", - "value": "1189" + "value": "37" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"187b2e94-6efe-421f-b618-186a20fd41df\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"VideoEncoderConfigurationOptions\",\n \"origin\": 1659659212171416506,\n \"readings\": [\n {\n \"id\": \"0b709715-f644-4cf0-a477-dcc3b5ef218c\",\n \"origin\": 1659659212171416506,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"VideoEncoderConfigurationOptions\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Options\": {\n \"Extension\": {\n \"H264\": {\n \"BitrateRange\": {\n \"Max\": 1024,\n \"Min\": 256\n },\n \"EncodingIntervalRange\": {\n \"Max\": 1,\n \"Min\": 1\n },\n \"FrameRateRange\": {\n \"Max\": 15,\n \"Min\": 1\n },\n \"GovLengthRange\": {\n \"Max\": 25,\n \"Min\": 25\n },\n \"H264ProfilesSupported\": [\n \"Main\"\n ],\n \"ResolutionsAvailable\": [\n {\n \"Height\": 1080,\n \"Width\": 1920\n },\n {\n \"Height\": 720,\n \"Width\": 1280\n },\n {\n \"Height\": 360,\n \"Width\": 640\n }\n ]\n }\n },\n \"H264\": {\n \"EncodingIntervalRange\": {\n \"Max\": 1,\n \"Min\": 1\n },\n \"FrameRateRange\": {\n \"Max\": 15,\n \"Min\": 1\n },\n \"GovLengthRange\": {\n \"Max\": 25,\n \"Min\": 25\n },\n \"H264ProfilesSupported\": [\n \"Main\"\n ],\n \"ResolutionsAvailable\": [\n {\n \"Height\": 1080,\n \"Width\": 1920\n },\n {\n \"Height\": 720,\n \"Width\": 1280\n },\n {\n \"Height\": 360,\n \"Width\": 640\n }\n ]\n },\n \"QualityRange\": {\n \"Max\": 5,\n \"Min\": 1\n }\n }\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] }, { - "name": "SetVideoEncoderConfiguration", + "name": "CompatibleMetadataConfigurations", "request": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"VideoEncoderConfiguration\": {\n \"ForcePersistence\": false,\n \"Configuration\":{\n \"token\": \"{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}\",\n \"Encoding\": \"H264\",\n \"Quality\": 3.000000,\n \"Resolution\": {\n \"Width\": 1920,\n \"Height\": 1080\n },\n \"Multicast\": {\n \"Address\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"0.0.0.0\"\n },\n \"Port\": 8860,\n \"TTL\": 1,\n \"AutoStart\": false\n }\n }\n \n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/CompatibleMetadataConfigurations?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", "protocol": "http", "host": [ "0", @@ -2827,28 +2808,25 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "VideoEncoderConfiguration" + "CompatibleMetadataConfigurations" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" + } ] }, - "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.\n\nSessionTimeout 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." + "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." }, "response": [ { - "name": "SetVideoEncoderConfiguration", + "name": "CompatibleMetadataConfigurations", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"VideoEncoderConfiguration\": {\n \"ForcePersistence\": false,\n \"Configuration\":{\n \"token\": \"{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}\",\n \"Encoding\": \"H264\",\n \"Quality\": 3.000000,\n \"Resolution\": {\n \"Width\": 1920,\n \"Height\": 1080\n },\n \"Multicast\": {\n \"Address\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"0.0.0.0\"\n },\n \"Port\": 8860,\n \"TTL\": 1,\n \"AutoStart\": false\n }\n }\n \n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/CompatibleMetadataConfigurations?jsonObject={{EDGEX_MEDIA_PROFILE_BASE64}}", "protocol": "http", "host": [ "0", @@ -2863,12 +2841,18 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "VideoEncoderConfiguration" + "CompatibleMetadataConfigurations" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_BASE64}}" + } ] } }, - "status": "Internal Server Error", - "code": 500, + "status": "OK", + "code": 200, "_postman_previewlanguage": "json", "header": [ { @@ -2877,34 +2861,29 @@ }, { "key": "X-Correlation-Id", - "value": "8888c1a3-e632-4223-9013-41c5e938eb4d" + "value": "362fa295-c750-49a8-a457-a5b5d1486cc6" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:56 GMT" + "value": "Fri, 05 Aug 2022 00:26:28 GMT" }, { "key": "Content-Length", - "value": "489" + "value": "580" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"message\": \"request failed, status code: 500, err: {\\\"apiVersion\\\":\\\"v2\\\",\\\"message\\\":\\\"error writing DeviceResourece VideoEncoderConfiguration for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\\\\u003e failed to execute write command, \\\\u003cnil\\\\u003e -\\\\u003e invalid request for the function 'SetVideoEncoderConfiguration' of web service 'Media'. Onvif error: fault reason: , fault detail: , fault code: SOAP-ENV:Sender \\\",\\\"statusCode\\\":500}\",\n \"statusCode\": 500\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"410b5658-82d9-488c-a5c4-c69f0ff6d273\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"CompatibleMetadataConfigurations\",\n \"origin\": 1659659188300470539,\n \"readings\": [\n {\n \"id\": \"86aa4298-c8ee-4c74-afc9-73104bb3cd11\",\n \"origin\": 1659659188300470539,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"CompatibleMetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {}\n }\n }\n ]\n }\n}" } ] - } - ] - }, - { - "name": "User Handling", - "item": [ + }, { - "name": "Get users", + "name": "MetadataConfigurationOptions", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -2919,19 +2898,25 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Users" + "MetadataConfigurationOptions" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}" + } ] }, - "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." + "description": "This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration." }, "response": [ { - "name": "Get users", + "name": "MetadataConfigurationOptions", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/MetadataConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -2946,7 +2931,13 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Users" + "MetadataConfigurationOptions" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_AND_CONFIG_TOKEN_BASE64}}" + } ] } }, @@ -2960,30 +2951,30 @@ }, { "key": "X-Correlation-Id", - "value": "16c7a0fe-a3fc-4b4f-a8e3-110ba2f0325a" + "value": "fcbe3f78-3851-44ac-a75f-238527b90ea7" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:40:38 GMT" + "value": "Fri, 05 Aug 2022 00:26:34 GMT" }, { "key": "Content-Length", - "value": "609" + "value": "565" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"8e524ecd-674d-4dd8-b728-de78b8245189\",\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Users\",\n \"origin\": 1664077238993899589,\n \"readings\": [\n {\n \"id\": \"f5086b88-9876-4627-91d5-7ce39431652e\",\n \"origin\": 1664077238993899589,\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"resourceName\": \"Users\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"User\": [\n {\n \"UserLevel\": \"Administrator\",\n \"Username\": \"admin\"\n },\n {\n \"UserLevel\": \"User\",\n \"Username\": \"user\"\n }\n ]\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"f296e8b5-707f-4e66-9388-918821b83a19\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurationOptions\",\n \"origin\": 1659659194429862266,\n \"readings\": [\n {\n \"id\": \"f8efa15a-612d-4532-b40b-4e895cecb3bd\",\n \"origin\": 1659659194429862266,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"MetadataConfigurationOptions\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Options\": {}\n }\n }\n ]\n }\n}" } ] }, { - "name": "Create Users", + "name": "AddMetadataConfiguration", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"CreateUsers\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n }\n ]\n }\n}", + "raw": "{\n \"AddMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"ConfigurationToken\": \"{{MEDIA_CONFIG_TOKEN}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -2991,7 +2982,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/CreateUsers", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddMetadataConfiguration", "protocol": "http", "host": [ "0", @@ -3006,20 +2997,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "CreateUsers" + "AddMetadataConfiguration" ] }, - "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.\n\nONVIF 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." + "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." }, "response": [ { - "name": "Create Users", + "name": "AddMetadataConfiguration", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"CreateUsers\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"User\"\n }\n ]\n }\n}", + "raw": "{\n \"AddMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"ConfigurationToken\": \"{{MEDIA_CONFIG_TOKEN}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -3027,7 +3018,23 @@ } }, "url": { - "raw": "" + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddMetadataConfiguration", + "protocol": "http", + "host": [ + "0", + "0", + "0", + "0" + ], + "port": "59882", + "path": [ + "api", + "v2", + "device", + "name", + "{{EDGEX_DEVICE_NAME}}", + "AddMetadataConfiguration" + ] } }, "status": "OK", @@ -3040,11 +3047,11 @@ }, { "key": "X-Correlation-Id", - "value": "e772e887-419e-4647-ae97-59722fbc7317" + "value": "9aaf8833-760d-4e7b-ac10-123c36fa71fb" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:40:48 GMT" + "value": "Fri, 23 Sep 2022 23:13:44 GMT" }, { "key": "Content-Length", @@ -3057,13 +3064,13 @@ ] }, { - "name": "Set users", + "name": "RemoveMetadataConfiguration", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"Users\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Administrator\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Operator\"\n }\n ]\n }\n}", + "raw": "{\n \"RemoveMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -3071,7 +3078,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveMetadataConfiguration", "protocol": "http", "host": [ "0", @@ -3086,20 +3093,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Users" + "RemoveMetadataConfiguration" ] }, - "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.\n\nONVIF 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." + "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." }, "response": [ { - "name": "Set users", + "name": "RemoveMetadataConfiguration", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"Users\": {\n \"User\": [\n {\n \"Username\": \"user1\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Administrator\"\n },\n {\n \"Username\": \"user2\",\n \"Password\": \"Password1!\",\n \"UserLevel\": \"Operator\"\n }\n ]\n }\n}", + "raw": "{\n \"RemoveMetadataConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -3107,7 +3114,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Users", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveMetadataConfiguration", "protocol": "http", "host": [ "0", @@ -3122,7 +3129,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Users" + "RemoveMetadataConfiguration" ] } }, @@ -3136,11 +3143,11 @@ }, { "key": "X-Correlation-Id", - "value": "bc42d5ca-4132-47e5-b159-98ca2aa1cdb8" + "value": "f591166b-b0ae-4c3e-8d87-3fa2fb0f180c" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:40:53 GMT" + "value": "Fri, 23 Sep 2022 23:13:48 GMT" }, { "key": "Content-Length", @@ -3151,15 +3158,23 @@ "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" } ] - }, + } + ] + }, + { + "name": "Video Streaming", + "item": [ { - "name": "Delete users", + "name": "Profiles", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, "request": { - "method": "PUT", + "method": "GET", "header": [], "body": { "mode": "raw", - "raw": "{\n \"DeleteUsers\": {\n \"Username\": [\"user1\",\"user2\"]\n }\n}", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", "options": { "raw": { "language": "json" @@ -3167,7 +3182,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeleteUsers", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Profiles", "protocol": "http", "host": [ "0", @@ -3182,28 +3197,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DeleteUsers" + "Profiles" ] }, - "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." + "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." }, "response": [ { - "name": "Delete users", + "name": "Profiles", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"DeleteUsers\": {\n \"Username\": [\"user1\",\"user2\"]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DeleteUsers", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Profiles", "protocol": "http", "host": [ "0", @@ -3218,7 +3224,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DeleteUsers" + "Profiles" ] } }, @@ -3232,34 +3238,29 @@ }, { "key": "X-Correlation-Id", - "value": "12780a21-c3b4-42b1-9e46-11369a5926de" + "value": "00d76d82-033a-4787-ac76-3e049ca16294" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:40:57 GMT" + "value": "Thu, 04 Aug 2022 23:38:34 GMT" }, { - "key": "Content-Length", - "value": "37" + "key": "Transfer-Encoding", + "value": "chunked" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"e6560b52-1952-4d66-9f53-3cf27d48b3c0\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Profiles\",\n \"origin\": 1659656314715442631,\n \"readings\": [\n {\n \"id\": \"5c7bc03c-308f-4b2c-8bc9-2e59da7d6f65\",\n \"origin\": 1659656314715442631,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Profiles\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Profiles\": [\n {\n \"AudioEncoderConfiguration\": {\n \"Bitrate\": 131072,\n \"Encoding\": \"G711\",\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"AudioEncoder_1\",\n \"SampleRate\": 8000,\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"microphone\",\n \"UseCount\": 2\n },\n \"AudioSourceConfiguration\": {\n \"Name\": \"AudioSourceConfig\",\n \"SourceToken\": \"raw_as1\",\n \"Token\": \"asconf\",\n \"UseCount\": 2\n },\n \"Extension\": null,\n \"Fixed\": true,\n \"MetadataConfiguration\": null,\n \"Name\": \"mainStream\",\n \"PTZConfiguration\": {\n \"DefaultAbsolutePantTiltPositionSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace\",\n \"DefaultContinuousPanTiltVelocitySpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace\",\n \"DefaultPTZSpeed\": {},\n \"DefaultPTZTimeout\": \"PT0H0M20S\",\n \"DefaultRelativePanTiltTranslationSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace\",\n \"PanTiltLimits\": {\n \"Range\": {\n \"URI\": \"\",\n \"XRange\": {\n \"Max\": 170,\n \"Min\": -170\n },\n \"YRange\": {\n \"Max\": 35,\n \"Min\": -32\n }\n }\n },\n \"Token\": \"PTZConfiguration0\"\n },\n \"Token\": \"profile_1\",\n \"VideoAnalyticsConfiguration\": {\n \"AnalyticsEngineConfiguration\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"medium\"\n },\n {\n \"Name\": \"Enabled\",\n \"Value\": \"off\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n },\n {\n \"Name\": \"MyTamperDetecModule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\"\n },\n {\n \"Name\": \"Enabled\"\n }\n ]\n },\n \"Type\": \"tt:TamperEngine\"\n }\n ]\n },\n \"Name\": \"VideoAnalyticsName\",\n \"RuleEngineConfiguration\": {\n \"Rule\": {\n \"Name\": \"MyTamperDetectorRule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"ActiveCells\",\n \"Value\": \"0P8A8A==\"\n },\n {\n \"Name\": \"MinCount\",\n \"Value\": \"5\"\n },\n {\n \"Name\": \"AlarmOnDelay\",\n \"Value\": \"1000\"\n },\n {\n \"Name\": \"AlarmOffDelay\",\n \"Value\": \"1000\"\n }\n ]\n },\n \"Type\": \"tt:TamperDetector\"\n }\n },\n \"Token\": \"VideoAnalyticsToken\",\n \"UseCount\": 2\n },\n \"VideoEncoderConfiguration\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_1\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 1024,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 1080,\n \"Width\": 1920\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"main\",\n \"UseCount\": 1\n },\n \"VideoSourceConfiguration\": {\n \"Bounds\": {\n \"Height\": 720,\n \"Width\": 1280,\n \"X\": 0,\n \"Y\": 0\n },\n \"Extension\": null,\n \"Name\": \"VideoSourceConfig\",\n \"SourceToken\": \"raw_vs1\",\n \"Token\": \"vsconf\",\n \"UseCount\": 2,\n \"ViewMode\": \"\"\n }\n },\n {\n \"AudioEncoderConfiguration\": {\n \"Bitrate\": 131072,\n \"Encoding\": \"G711\",\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"AudioEncoder_1\",\n \"SampleRate\": 8000,\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"microphone\",\n \"UseCount\": 2\n },\n \"AudioSourceConfiguration\": {\n \"Name\": \"AudioSourceConfig\",\n \"SourceToken\": \"raw_as1\",\n \"Token\": \"asconf\",\n \"UseCount\": 2\n },\n \"Extension\": null,\n \"Fixed\": true,\n \"MetadataConfiguration\": null,\n \"Name\": \"minorStream\",\n \"PTZConfiguration\": {\n \"DefaultAbsolutePantTiltPositionSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/PositionGenericSpace\",\n \"DefaultContinuousPanTiltVelocitySpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/VelocityGenericSpace\",\n \"DefaultPTZSpeed\": {},\n \"DefaultPTZTimeout\": \"PT0H0M20S\",\n \"DefaultRelativePanTiltTranslationSpace\": \"http://www.onvif.org/ver10/tptz/PanTiltSpaces/TranslationGenericSpace\",\n \"PanTiltLimits\": {\n \"Range\": {\n \"URI\": \"\",\n \"XRange\": {\n \"Max\": 170,\n \"Min\": -170\n },\n \"YRange\": {\n \"Max\": 35,\n \"Min\": -32\n }\n }\n },\n \"Token\": \"PTZConfiguration0\"\n },\n \"Token\": \"profile_2\",\n \"VideoAnalyticsConfiguration\": {\n \"AnalyticsEngineConfiguration\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"medium\"\n },\n {\n \"Name\": \"Enabled\",\n \"Value\": \"off\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n },\n {\n \"Name\": \"MyTamperDetecModule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\"\n },\n {\n \"Name\": \"Enabled\"\n }\n ]\n },\n \"Type\": \"tt:TamperEngine\"\n }\n ]\n },\n \"Name\": \"VideoAnalyticsName\",\n \"RuleEngineConfiguration\": {\n \"Rule\": {\n \"Name\": \"MyTamperDetectorRule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"ActiveCells\",\n \"Value\": \"0P8A8A==\"\n },\n {\n \"Name\": \"MinCount\",\n \"Value\": \"5\"\n },\n {\n \"Name\": \"AlarmOnDelay\",\n \"Value\": \"1000\"\n },\n {\n \"Name\": \"AlarmOffDelay\",\n \"Value\": \"1000\"\n }\n ]\n },\n \"Type\": \"tt:TamperDetector\"\n }\n },\n \"Token\": \"VideoAnalyticsToken\",\n \"UseCount\": 2\n },\n \"VideoEncoderConfiguration\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_2\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 256,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 360,\n \"Width\": 640\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"minor\",\n \"UseCount\": 1\n },\n \"VideoSourceConfiguration\": {\n \"Bounds\": {\n \"Height\": 720,\n \"Width\": 1280,\n \"X\": 0,\n \"Y\": 0\n },\n \"Extension\": null,\n \"Name\": \"VideoSourceConfig\",\n \"SourceToken\": \"raw_vs1\",\n \"Token\": \"vsconf\",\n \"UseCount\": 2,\n \"ViewMode\": \"\"\n }\n }\n ]\n }\n }\n ]\n }\n}" } ] - } - ] - }, - { - "name": "Auto Discovery", - "item": [ + }, { - "name": "GetDiscoveryMode", + "name": "StreamUri", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}", "protocol": "http", "host": [ "0", @@ -3274,19 +3275,25 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DiscoveryMode" + "StreamUri" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}" + } ] }, - "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." + "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).\n\nThe correct syntax for the StreamSetup element for these media stream setups defined in 5.1.1 of the streaming specification are as follows: \nRTP unicast over UDP: StreamType = \"RTP_unicast\", TransportProtocol = \"UDP\" \nRTP over RTSP over HTTP over TCP: StreamType = \"RTP_unicast\", TransportProtocol = \"HTTP\" \nRTP over RTSP over TCP: StreamType = \"RTP_unicast\", TransportProtocol = \"RTSP\"\n\nIf a multicast stream is requested at least one of VideoEncoderConfiguration, AudioEncoderConfiguration and MetadataConfiguration shall have a valid multicast setting.\n\nFor full compatibility with other ONVIF services a device should not generate Uris longer than 128 octets." }, "response": [ { - "name": "GetDiscoveryMode", + "name": "StreamUri", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/StreamUri?jsonObject={{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}", "protocol": "http", "host": [ "0", @@ -3301,7 +3308,13 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DiscoveryMode" + "StreamUri" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_STREAM_SETUP_BASE64}}" + } ] } }, @@ -3315,38 +3328,29 @@ }, { "key": "X-Correlation-Id", - "value": "e81b8fb3-4bc4-4aab-a56f-5ff1ed41c123" + "value": "ed49c080-d872-4c97-bf07-f0cf95795fb9" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:38:59 GMT" + "value": "Thu, 04 Aug 2022 23:38:43 GMT" }, { "key": "Content-Length", - "value": "553" + "value": "641" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"8155efce-41b5-412f-a25d-b63bed015d63\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DiscoveryMode\",\n \"origin\": 1659656339306907742,\n \"readings\": [\n {\n \"id\": \"099efd6b-d5fa-44a3-98f2-67eb72a1659f\",\n \"origin\": 1659656339306907742,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DiscoveryMode\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DiscoveryMode\": \"Discoverable\"\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"0ef64d9b-ba26-49a9-9a9f-5ec6f7b47190\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"StreamUri\",\n \"origin\": 1659656323588826999,\n \"readings\": [\n {\n \"id\": \"255085ba-4399-489d-aa34-cab5e1379281\",\n \"origin\": 1659656323588826999,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"StreamUri\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"MediaUri\": {\n \"InvalidAfterConnect\": false,\n \"InvalidAfterReboot\": false,\n \"Timeout\": \"PT0H0M2S\",\n \"Uri\": \"rtsp://10.0.0.188:554/stream1\"\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "Set DiscoveryMode", + "name": "Snapshot", "request": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"DiscoveryMode\": {\n \"DiscoveryMode\": \"Discoverable\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Snapshot", "protocol": "http", "host": [ "0", @@ -3361,28 +3365,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DiscoveryMode" + "Snapshot" ] }, - "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." + "description": "This request returns a snapshot of the video stream at the time the command is given.\n\nIt is returned in a binary format." }, "response": [ { - "name": "Set DiscoveryMode", + "name": "Snapshot", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"DiscoveryMode\": {\n \"DiscoveryMode\": \"Discoverable\"\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/DiscoveryMode", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Snapshot", "protocol": "http", "host": [ "0", @@ -3397,7 +3392,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "DiscoveryMode" + "Snapshot" ] } }, @@ -3411,30 +3406,38 @@ }, { "key": "X-Correlation-Id", - "value": "99ed7b8d-81cc-4046-8ac9-ea8dd9013fb2" + "value": "e1116b67-69cd-4ed8-9b70-f543c9cf4a17" }, { "key": "Date", - "value": "Thu, 04 Aug 2022 23:39:15 GMT" + "value": "Mon, 10 Oct 2022 15:25:00 GMT" }, { - "key": "Content-Length", - "value": "37" + "key": "Transfer-Encoding", + "value": "chunked" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"5fdf593f-2a92-4a71-b08c-791d7a27fdff\",\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Snapshot\",\n \"origin\": 1665415500727830418,\n \"readings\": [\n {\n \"id\": \"d04a9dad-feb9-4099-a524-8a4b4cf2cc37\",\n \"origin\": 1665415500727830418,\n \"deviceName\": \"Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1\",\n \"resourceName\": \"Snapshot\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Binary\",\n \"binaryValue\": \"/9j/4AAQSkZJRgABAQEAYABgAAD/2wBDAAgGBgcGBQgHBwcJCQgKDBQNDAsLDBkSEw8UHRofHh0aHBwgJC4nICIsIxwcKDcpLDAxNDQ0Hyc5PTgyPC4zNDL/2wBDAQkJCQwLDBgNDRgyIRwhMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjL/wAARCACAAKADASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9oADAMBAAIRAxEAPwDzGwiBtoGx/wAs1/kK0BGPSotPH+g23/XFP5CreKxOyOwxVqTYuOlAWn7eKQFd1VQDtH3hUgtoz1QUsq/u2PoM1PikBCLWL+4KelkhOQSAOp3dKoX+sQWalVO+X0HasB9bumOfMP0oDmR2T6c/klt/4d/5VRvNOkhxvQrkcblH4/rmsaz8TT25bzP3qMCNp7Z9K3IvGcU0C211F5kROTnG4dOh7dKYXTMPysXeMV0MKgDpVC4+xTXiy2QkMXPDNuI4rRgGcUBYsqgFSgUiLUoFMmwzbU8a0wLzVmMAimMlij713+h2a2lhEpX52G5vxrj9Nthc3kUJGQx5HtXoUaYFBUELIgYZ2ivLviHKJ47tAoxDAyj8ia9TkkWGF5HOFUc15H4oJm03UZW5LQyH9DTiKo9DmdPQ/YbbH/PFP5CrgWoNNP8AxLbX/rin8hVwVIR2GBacFp4UU8LSAryL8hqrqF4LTTTICN54XNaEi/Ka5LXpi8kcfZF6e5oAxXcscmoy1KetMaqSMGLuGacGqIU8A02gNK0vWhTAJByDXX6bMLiFXXvXBxiur8NSMZBGx+X0rKRvTd3Y6VBUyjirM1uoCOg4bP5j/IqMJirTHKNhgFSxjmgJTo1IamSdL4Xh3X5fH3Vrs8Yrl/Csf7yZ/Yf1rqyKGaIyddlMemOF43naa8419c6HqJx/y7Sf+gmvQPExItIVHQuc/lXB6+MeH9SP/TtJ/wCgmtYGFU5jTVH9mWn/AFxT+Qq2FqjppP8AZ1qP+mKfyFaS9KxNI7ABTgKUCngDFICMjiuG1cEXsoPrXdtiuP8AEUW25V/7wNBMjnj1ptPbrTcc1Zix8MZedR2zzVuWEKpUDBBp1lDj5z+FWbiA7t46GspT1OmnT0uVbOHfLg9K9G0Lw8xtYLuAr5chYZZuflxk1wtpFtkz2r03w5K7aBdRXczrHbyRNGuBwH3A4+vH6UblU9GdHe2sP2Nx5iBtxK57np/9euaxTjfSSjBOBTQaqBdRp7CgU9Rg01aeOtUYnV+FjzN9BXUiuS8Ln/SWX1WuvUc0MtGJ4nQ/Z7Y44yf6VwfiEY8P6l/17Sf+gmvR/ESb9MiOORJ/MH/CvP8AxGn/ABT2pHt9lk/9BNbwOeocPp0MzWFqwdR+5T+Qq4ILr+8lJpqj+zbP/rhH/wCg1eVaxNY7FURXX95Kf9nu/wC+lWwKkAqWhmU7XKnBWsvWIxJYuzD5lwRXTyRFkIUZasPVrO5Ns6LBISeOmR+lAmjidhJp6QMx6VrLpk0Ry8R/KmPHtbGMVnKdg5CONdiYFWuGhwagqzEm5BWL1N4qxNZoN4wK9C1R/M0jSQEVWNth2A5faxVc/QAVwtpGVbPpXpviH+zrTR9Ks1niFxDHlgvcNz/P+daxYmjnIweKsqKbGqkDBzU6rWyMhB0p69aAlSpHVNEm1oD7L+L3OK7pBXnunnyriJ/Rga9CRuhpFplTWofM05sdVIavPfEq48Nap/16S/8AoBr064QTwPGf4gRXm/iZMeGtVyOlpLn/AL5NaQdkY1Fc4fTR/wASyz/64R/+gitFU4qrpUQ/sqyZ8qot48+v3RVpbiVFkiixhxg5QE/gSMj8KzNI7DguFLZGB1yRU9ncWRLLc7xgfK688+mPSs1oHbr+tK6i3i3NwPWpGaUVxam4wqMAOjMe/wBKW8vbSGM+dIq56AnrXPPeSSf8e2UTvIR/IUiwRiOS6nbeQPvSck0mxsklubedW8mVW9s1nOFOeBVS65BuYE8tg33R3FSRP5ihgeDUNDI3t1ZvkGCe1WLa3YcEVNboplBIq/GirIDjjvUuJdN62Io4SozViOEzq4X74rUisEnjPkgucZwAc04RQ2MrJEfMZ12yHHAPfFZ6nZaJjQve2hyrnGehGQa7BrcMsUsQIiliWQE+pHI/A5H4VkSxqyHI6dvSum0TbqPh2W3zmeyJdB3MZ64+h5/GtoHNWguhnhcdadkZ4pWpoHNanMWYeor0G1ffBG2eqivPYuldxob79PXnOKBo0+1cL42h8rQ9ZHrZyn/xw13ijNcj4/hx4c1WT1sZh+SGriRI820qEyaZp/p9mj/9BFX/ALKELEjHyk1Z0qK3g8M6bPMQo+yQkk+6CqNzJc3zYhR0i6Db94/X0qTSOxBcXKR/u41MkvoOg+pqolpNeEGYb8fgo/DvWpDpSR7TIM8Z254/+vV4g8jtxxQBhLZbPv8AJxj2rO1k+UkcC/Vh/KukkT94KwdcXzbmCJRl8HP41IGBGXkcKo9eKfYj9y6n7ytW9Y6X9nUtImZT+lZWwWepTQkYWTFS0ImgilyCBVxGYfeHNWEgCqAKUw07DLNrfvAwaGRo3HQqcVNJ4j1JeWuBKAc/vYlfH0yKzfLxUU/EJpWK5mbNv4kt7ydY9StIgrHDS267Hx/ujg/lWnaXn/CO67b3sJM9jJkpIoIEsZ4I+o9PUVwg4OeldZ4d1GC7h/si+ZVhIzDKesT+v0PQ/wD1qaQc76nS3doslst/asj28nQK2Sh9D+uKoVZ0OO7sdSksJ4d0E64kiZlyfQqSeTyDx1pLu0ksrh4ZR8ynGexHqKohjI+ldd4ZkzbyR+hBrkYq6Xw04W4ZP7woBHVKOK5vx9Hu8Fas392zm/8AQDXTAVheN03+BtcA6ixmP/jhoTJkeZeHLO717TtOjJKWsFtEq8dwgGa6+TSI7WFYoo8d/c1ifDS8M1ra2RXIS3VgfbA6/mK7u5T94D6AD880zWOxxU0Oxm44BqnIPmf6VuXsWC59WNY7rjf+FANFJxjrWNEq3XiBuMiPp9f8mtq6bylZj0GKo+H7cOs923LSNwfYf/XzQKxcljwM4rkNfQpepMBkcV2tyMRmuU1yJpIjjtzQFjT2DaCPTNMJpdOzLpcUjctt5PrSN1pNA0Rmqs/3TVo1Vn+6akCi9EZ/eDmnPUaffBpCO80u7l1fTWtnAluI1zbydHXH8Oe4PTnuRWvaX8eu2yQ3Mu27hG1JG4Dj0Y/ng/nWH4UMQdAW2kNuVj0Hrn/Pb61P4gtRo2us8OPKb54+OxP9Dx+FaDZfMTRMVdSpBxg1q6LKIr6LJwCcU2yceIbMTmBI5EGxpI3ySccbl9Kr2hMcqHuDQQeg1i+M/wDkR9e/7B8//otq2QQyhhyCMg1jeMv+RH1//sHT/wDotqhEyPK/BVzNptnZ6pAhkighjS6XuFIHP0+6fqK9ZiCXUMkqOGVgpUjuMZz+teWeE3XTH0l35tru0ijnB6cxjr7cg13VnIfDepCwlY/2bdHNu78+W3dCfx4qzaOwavCqwu4HaudnGE3Y9K7PVYF+zyrjI25FchIM24GOQcH8KCjn9dfZa3PbGz9RV7TrT7JYRRbcYHP1qjrdu1zfQQJ/y3Khh64P+Ga2ieKDMqXY+Suc1FC6sAOororr7hrHukySfagaZR0K7zpzI3WJsEexq64RvmQ9e1ZGiyiLUrq2b+Mfyz/jWq8TQZK8x9vagZC/ANUZjk1cnOY2+lZrNkVBJHIeaYpwaefmBpi9aQjc0q+e2ZSDxmuo1S5i1rTkjRv9Ig+aMqOq/wAQ/kR9CPSuDSUoKtW+rzWjAxvg1SYzsfD815YKZIbqAQvjzY2BLcfh/UVsEICrxNlHG9T/AD/XIrz2PV5RNuAVAeyjArqfD9691DJGzjMeHUH0PDY/Hb+tO4HpumS+bpsDbs8YNUPGX/Ij6/8A9g6f/wBFtS+HHLWTgn7r8UnjL/kR9f8A+wdP/wCi2oM5H//Z\",\n \"mediaType\": \"image/jpeg\",\n \"value\": \"\"\n }\n ]\n }\n}" } ] - }, + } + ] + }, + { + "name": "Video Encoder Configuration", + "item": [ { - "name": "Add Scopes", + "name": "VideoEncoderConfigurations", + "protocolProfileBehavior": { + "disableBodyPruning": true + }, "request": { - "method": "PUT", + "method": "GET", "header": [], "body": { "mode": "raw", - "raw": "{\n \"AddScopes\":{\n \"ScopeItem\":[\n \"http//:123\"\n ]\n }\n}", + "raw": "{\n \"SetDNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n }\n}", "options": { "raw": { "language": "json" @@ -3442,7 +3445,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddScopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetVideoEncoderConfigurations", "protocol": "http", "host": [ "0", @@ -3457,28 +3460,19 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "AddScopes" + "GetVideoEncoderConfigurations" ] }, - "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." + "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." }, "response": [ { - "name": "Add Scopes", + "name": "VideoEncoderConfigurations", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"AddScopes\":{\n \"ScopeItem\":[\n \"http//:123\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/AddScopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetVideoEncoderConfigurations", "protocol": "http", "host": [ "0", @@ -3493,7 +3487,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "AddScopes" + "GetVideoEncoderConfigurations" ] } }, @@ -3507,29 +3501,29 @@ }, { "key": "X-Correlation-Id", - "value": "6c1402e7-4516-4661-9ba7-b486dc20336f" + "value": "7330109d-9cd8-4d4d-9334-4d39860e62b3" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:41:03 GMT" + "value": "Fri, 05 Aug 2022 00:26:43 GMT" }, { "key": "Content-Length", - "value": "37" + "value": "944" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"1ee4ca7f-fb95-46b3-8e6d-8542b45b22d4\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"GetVideoEncoderConfigurations\",\n \"origin\": 1659659203023412427,\n \"readings\": [\n {\n \"id\": \"dd2b4e0e-9a62-49bc-a80b-071d4b1ed8e1\",\n \"origin\": 1659659203023412427,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"GetVideoEncoderConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_2\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 256,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 360,\n \"Width\": 640\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"minor\",\n \"UseCount\": 1\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "Get Scopes", + "name": "VideoEncoderConfiguration", "request": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration?jsonObject={{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -3544,19 +3538,25 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Scopes" + "VideoEncoderConfiguration" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}" + } ] }, - "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: \n\\- Fixed \n\\- Configurable \nFixed 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." + "description": "If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command." }, "response": [ { - "name": "Get Scopes", + "name": "VideoEncoderConfiguration", "originalRequest": { "method": "GET", "header": [], "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration?jsonObject={{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -3571,7 +3571,13 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Scopes" + "VideoEncoderConfiguration" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN_BASE64}}" + } ] } }, @@ -3585,38 +3591,29 @@ }, { "key": "X-Correlation-Id", - "value": "966fc4b2-a648-4bef-91fc-2aaf9f9310a7" + "value": "2eee5539-10bd-4e4d-b259-be10351c1de2" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:27:08 GMT" + "value": "Fri, 05 Aug 2022 00:26:47 GMT" }, { "key": "Content-Length", - "value": "896" + "value": "937" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"05f573f4-0836-45ad-b9ba-c393f9927586\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Scopes\",\n \"origin\": 1659659228090509033,\n \"readings\": [\n {\n \"id\": \"ea858652-cb16-432c-bf45-f9785cd00d85\",\n \"origin\": 1659659228090509033,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"Scopes\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Scopes\": [\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/name/TP-IPC\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/hardware/MODEL\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/Profile/Streaming\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/location/ShenZhen\"\n },\n {\n \"ScopeDef\": \"Fixed\",\n \"ScopeItem\": \"onvif://www.onvif.org/type/NetworkVideoTransmitter\"\n }\n ]\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"598079d0-d169-4385-86f3-cb7a106345a5\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"VideoEncoderConfiguration\",\n \"origin\": 1659659207626081088,\n \"readings\": [\n {\n \"id\": \"86aed436-65cb-4162-b3e6-14def8e4e4d3\",\n \"origin\": 1659659207626081088,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"VideoEncoderConfiguration\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configuration\": {\n \"Encoding\": \"H264\",\n \"H264\": {\n \"GovLength\": 25,\n \"H264Profile\": \"Main\"\n },\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 0,\n \"TTL\": 0\n },\n \"Name\": \"VideoEncoder_1\",\n \"Quality\": 3,\n \"RateControl\": {\n \"BitrateLimit\": 1024,\n \"EncodingInterval\": 1,\n \"FrameRateLimit\": 15\n },\n \"Resolution\": {\n \"Height\": 1080,\n \"Width\": 1920\n },\n \"SessionTimeout\": \"PT0H1M5S\",\n \"Token\": \"main\",\n \"UseCount\": 1\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "Put Scopes", + "name": "VideoEncoderConfigurationOptions", "request": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"Scopes\":{\n \"Scopes\":[\n \"http//:123\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -3631,28 +3628,25 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Scopes" + "VideoEncoderConfigurationOptions" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}" + } ] }, - "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." + "description": "This operation returns the available options (supported values and ranges for video encoder configuration parameters) when the video encoder parameters are reconfigured.\n\nFor 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.\n\nThis 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." }, "response": [ { - "name": "Put Scopes", + "name": "VideoEncoderConfigurationOptions", "originalRequest": { - "method": "PUT", + "method": "GET", "header": [], - "body": { - "mode": "raw", - "raw": "{\n \"Scopes\":{\n \"Scopes\":[\n \"http//:123\"\n ]\n }\n}", - "options": { - "raw": { - "language": "json" - } - } - }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/Scopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfigurationOptions?jsonObject={{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}", "protocol": "http", "host": [ "0", @@ -3667,7 +3661,13 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "Scopes" + "VideoEncoderConfigurationOptions" + ], + "query": [ + { + "key": "jsonObject", + "value": "{{EDGEX_MEDIA_PROFILE_VIDEO_ENCODER_TOKEN_BASE64}}" + } ] } }, @@ -3681,30 +3681,30 @@ }, { "key": "X-Correlation-Id", - "value": "0fa69e08-5b67-4b92-93c8-7cb642c2f43c" + "value": "a84e4fb9-68a1-4b93-a48e-12d6467b5a52" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:41:08 GMT" + "value": "Fri, 05 Aug 2022 00:26:52 GMT" }, { "key": "Content-Length", - "value": "37" + "value": "1189" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"187b2e94-6efe-421f-b618-186a20fd41df\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"VideoEncoderConfigurationOptions\",\n \"origin\": 1659659212171416506,\n \"readings\": [\n {\n \"id\": \"0b709715-f644-4cf0-a477-dcc3b5ef218c\",\n \"origin\": 1659659212171416506,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"VideoEncoderConfigurationOptions\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Options\": {\n \"Extension\": {\n \"H264\": {\n \"BitrateRange\": {\n \"Max\": 1024,\n \"Min\": 256\n },\n \"EncodingIntervalRange\": {\n \"Max\": 1,\n \"Min\": 1\n },\n \"FrameRateRange\": {\n \"Max\": 15,\n \"Min\": 1\n },\n \"GovLengthRange\": {\n \"Max\": 25,\n \"Min\": 25\n },\n \"H264ProfilesSupported\": [\n \"Main\"\n ],\n \"ResolutionsAvailable\": [\n {\n \"Height\": 1080,\n \"Width\": 1920\n },\n {\n \"Height\": 720,\n \"Width\": 1280\n },\n {\n \"Height\": 360,\n \"Width\": 640\n }\n ]\n }\n },\n \"H264\": {\n \"EncodingIntervalRange\": {\n \"Max\": 1,\n \"Min\": 1\n },\n \"FrameRateRange\": {\n \"Max\": 15,\n \"Min\": 1\n },\n \"GovLengthRange\": {\n \"Max\": 25,\n \"Min\": 25\n },\n \"H264ProfilesSupported\": [\n \"Main\"\n ],\n \"ResolutionsAvailable\": [\n {\n \"Height\": 1080,\n \"Width\": 1920\n },\n {\n \"Height\": 720,\n \"Width\": 1280\n },\n {\n \"Height\": 360,\n \"Width\": 640\n }\n ]\n },\n \"QualityRange\": {\n \"Max\": 5,\n \"Min\": 1\n }\n }\n }\n }\n ]\n }\n}" } ] }, { - "name": "Remove Scopes", + "name": "SetVideoEncoderConfiguration", "request": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"RemoveScopes\":{\n \"ScopeItem\":[\n \"onvif://www.onvif.org/name/Geovision\"\n ]\n }\n}", + "raw": "{\n \"VideoEncoderConfiguration\": {\n \"ForcePersistence\": false,\n \"Configuration\":{\n \"token\": \"{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}\",\n \"Encoding\": \"H264\",\n \"Quality\": 3.000000,\n \"Resolution\": {\n \"Width\": 1920,\n \"Height\": 1080\n },\n \"Multicast\": {\n \"Address\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"0.0.0.0\"\n },\n \"Port\": 8860,\n \"TTL\": 1,\n \"AutoStart\": false\n }\n }\n \n }\n}", "options": { "raw": { "language": "json" @@ -3712,7 +3712,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveScopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration", "protocol": "http", "host": [ "0", @@ -3727,20 +3727,20 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "RemoveScopes" + "VideoEncoderConfiguration" ] }, - "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" + "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.\n\nSessionTimeout 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." }, "response": [ { - "name": "Remove Scopes", + "name": "SetVideoEncoderConfiguration", "originalRequest": { "method": "PUT", "header": [], "body": { "mode": "raw", - "raw": "{\n \"RemoveScopes\":{\n \"ScopeItem\":[\n \"onvif://www.onvif.org/name/Geovision\"\n ]\n }\n}", + "raw": "{\n \"VideoEncoderConfiguration\": {\n \"ForcePersistence\": false,\n \"Configuration\":{\n \"token\": \"{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}\",\n \"Encoding\": \"H264\",\n \"Quality\": 3.000000,\n \"Resolution\": {\n \"Width\": 1920,\n \"Height\": 1080\n },\n \"Multicast\": {\n \"Address\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"0.0.0.0\"\n },\n \"Port\": 8860,\n \"TTL\": 1,\n \"AutoStart\": false\n }\n }\n \n }\n}", "options": { "raw": { "language": "json" @@ -3748,7 +3748,7 @@ } }, "url": { - "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/RemoveScopes", + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/VideoEncoderConfiguration", "protocol": "http", "host": [ "0", @@ -3763,7 +3763,7 @@ "device", "name", "{{EDGEX_DEVICE_NAME}}", - "RemoveScopes" + "VideoEncoderConfiguration" ] } }, @@ -3777,19 +3777,19 @@ }, { "key": "X-Correlation-Id", - "value": "1585c4fb-963a-4dc2-afa1-057559aedacc" + "value": "8888c1a3-e632-4223-9013-41c5e938eb4d" }, { "key": "Date", - "value": "Sun, 25 Sep 2022 03:41:12 GMT" + "value": "Fri, 05 Aug 2022 00:26:56 GMT" }, { "key": "Content-Length", - "value": "528" + "value": "489" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"message\": \"request failed, status code: 500, err: {\\\"apiVersion\\\":\\\"v2\\\",\\\"message\\\":\\\"error writing DeviceResourece RemoveScopes for Intel-SimCamera-003caffe-6392-4bb2-a5a4-f027d2e89ee1 -\\\\u003e failed to execute write command, \\\\u003cnil\\\\u003e -\\\\u003e invalid request for the function 'RemoveScopes' of web service 'Device'. Onvif error: fault reason: Trying to Remove scope which does not exist, fault detail: , fault code: s:Sender ter:InvalidArgVal ter:NoScope\\\",\\\"statusCode\\\":500}\",\n \"statusCode\": 500\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"message\": \"request failed, status code: 500, err: {\\\"apiVersion\\\":\\\"v2\\\",\\\"message\\\":\\\"error writing DeviceResourece VideoEncoderConfiguration for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\\\\u003e failed to execute write command, \\\\u003cnil\\\\u003e -\\\\u003e invalid request for the function 'SetVideoEncoderConfiguration' of web service 'Media'. Onvif error: fault reason: , fault detail: , fault code: SOAP-ENV:Sender \\\",\\\"statusCode\\\":500}\",\n \"statusCode\": 500\n}" } ] } diff --git a/doc/postman/device-onvif-camera.postman_environment.json b/doc/postman/device-onvif-camera.postman_environment.json index b3910608..73864e63 100644 --- a/doc/postman/device-onvif-camera.postman_environment.json +++ b/doc/postman/device-onvif-camera.postman_environment.json @@ -20,9 +20,15 @@ "type": "default", "enabled": true }, + { + "key": "MEDIA_CONFIG_TOKEN", + "value": "1", + "type": "default", + "enabled": true + }, { "key": "EDGEX_MEDIA_CONFIG_TOKEN_BASE64", - "value": "", + "value": "eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiMSJ9", "type": "default", "enabled": true }, From 0ba7cfd313b4e56130368743e0e446052423e8f0 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Thu, 20 Oct 2022 15:17:00 -0700 Subject: [PATCH 10/15] docs: add servers, fix friendly name, format json Signed-off-by: Anthony Casagrande --- doc/openapi/p2o-options.json | 16 +++- doc/openapi/v2/device-onvif-camera.yaml | 9 +- ...evice-onvif-camera.postman_collection.json | 82 +++++++++++-------- 3 files changed, 70 insertions(+), 37 deletions(-) diff --git a/doc/openapi/p2o-options.json b/doc/openapi/p2o-options.json index 1f051ba0..f0e8eeb0 100644 --- a/doc/openapi/p2o-options.json +++ b/doc/openapi/p2o-options.json @@ -6,5 +6,19 @@ }, "folders": { "separator": " - " - } + }, + "servers": [ + { + "url": "http://localhost:59882", + "description": "Local running instance of EdgeX" + }, + { + "url": "http://127.0.0.1:59882", + "description": "Local running instance of EdgeX" + }, + { + "url": "http://0.0.0.0:59882", + "description": "Local running instance of EdgeX" + } + ] } diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 06d0aeea..b4e73a8d 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -4,7 +4,12 @@ info: description: EdgeX Onvif Device Service REST APIs version: 2.2.0 servers: +- url: http://localhost:59882 + description: Local running instance of EdgeX +- url: http://127.0.0.1:59882 + description: Local running instance of EdgeX - url: http://0.0.0.0:59882 + description: Local running instance of EdgeX tags: - name: Auto Discovery - name: Network Configuration @@ -6693,8 +6698,7 @@ paths: - FriendlyName type: object example: - FriendlyName: - FriendlyName: My Camera + FriendlyName: My Camera parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -6858,6 +6862,7 @@ paths: Location: Front door Business: John's Grocery Store Install Date: 01/01/1970 + Color: White parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index 83ecad8b..db52dce1 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -191,7 +191,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"AddScopes\":{\n \"ScopeItem\":[\n \"http//:123\"\n ]\n }\n}", + "raw": "{\n \"AddScopes\": {\n \"ScopeItem\": [\n \"http//:123\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -365,7 +365,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"Scopes\":{\n \"Scopes\":[\n \"http//:123\"\n ]\n }\n}", + "raw": "{\n \"Scopes\": {\n \"Scopes\": [\n \"http//:123\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -461,7 +461,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"RemoveScopes\":{\n \"ScopeItem\":[\n \"onvif://www.onvif.org/name/Geovision\"\n ]\n }\n}", + "raw": "{\n \"RemoveScopes\": {\n \"ScopeItem\": [\n \"onvif://www.onvif.org/name/Geovision\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -1000,7 +1000,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": true\n }\n }\n \n }\n}", + "raw": "{\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": true\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -1174,7 +1174,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 2020\n },\n {\n \"Name\": \"HTTPS\",\n \"Enabled\": false,\n \"Port\": 443\n },\n {\n \"Name\": \"RTSP\",\n \"Enabled\": true,\n \"Port\": 554\n }\n ]\n } \n}", + "raw": "{\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 2020\n },\n {\n \"Name\": \"HTTPS\",\n \"Enabled\": false,\n \"Port\": 443\n },\n {\n \"Name\": \"RTSP\",\n \"Enabled\": true,\n \"Port\": 554\n }\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -1360,7 +1360,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n } \n}", + "raw": "{\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", "options": { "raw": { "language": "json" @@ -1546,7 +1546,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost\"\n },\n \"DNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n },\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": false\n }\n }\n \n },\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [ \n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 80\n }\n ]\n },\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", + "raw": "{\n \"Hostname\": {\n \"Name\": \"localhost\"\n },\n \"DNS\": {\n \"FromDHCP\": false,\n \"DNSManual\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"192.168.12.1\"\n }\n },\n \"NetworkInterfaces\": {\n \"InterfaceToken\": \"eth0\",\n \"NetworkInterface\": {\n \"Enabled\": true,\n \"IPv4\": {\n \"DHCP\": false\n }\n }\n },\n \"NetworkProtocols\": {\n \"NetworkProtocols\": [\n {\n \"Name\": \"HTTP\",\n \"Enabled\": true,\n \"Port\": 80\n }\n ]\n },\n \"NetworkDefaultGateway\": {\n \"IPv4Address\": \"192.168.12.1\"\n }\n}", "options": { "raw": { "language": "json" @@ -1816,7 +1816,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"SystemDateAndTime\": {\n \"DateTimeType\":\"Manual\",\n \"DaylightSavings\": false,\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": 12,\n \"Year\": 2021,\n \"Day\": 11\n\n },\n \"Time\": {\n \"Hour\": 5,\n \"Minute\": 48,\n \"Second\": 20\n }\n }\n }\n}", + "raw": "{\n \"SystemDateAndTime\": {\n \"DateTimeType\": \"Manual\",\n \"DaylightSavings\": false,\n \"UTCDateTime\": {\n \"Date\": {\n \"Month\": 12,\n \"Year\": 2021,\n \"Day\": 11\n },\n \"Time\": {\n \"Hour\": 5,\n \"Minute\": 48,\n \"Second\": 20\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -1900,7 +1900,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetSystemFactoryDefault\": {\n \"FactoryDefault\":\"Soft\"\n }\n}", + "raw": "{\n \"SetSystemFactoryDefault\": {\n \"FactoryDefault\": \"Soft\"\n }\n}", "options": { "raw": { "language": "json" @@ -2429,7 +2429,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"DeleteUsers\": {\n \"Username\": [\"user1\",\"user2\"]\n }\n}", + "raw": "{\n \"DeleteUsers\": {\n \"Username\": [\n \"user1\",\n \"user2\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -2698,7 +2698,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"MetadataConfiguration\": {\n \"ForcePersistence\": true,\n \"Configuration\":{\n \"token\": \"{{MEDIA_CONFIG_TOKEN}}\",\n \"Analytics\": true\n }\n \n }\n}", + "raw": "{\n \"MetadataConfiguration\": {\n \"ForcePersistence\": true,\n \"Configuration\": {\n \"token\": \"{{MEDIA_CONFIG_TOKEN}}\",\n \"Analytics\": true\n }\n }\n}", "options": { "raw": { "language": "json" @@ -3704,7 +3704,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"VideoEncoderConfiguration\": {\n \"ForcePersistence\": false,\n \"Configuration\":{\n \"token\": \"{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}\",\n \"Encoding\": \"H264\",\n \"Quality\": 3.000000,\n \"Resolution\": {\n \"Width\": 1920,\n \"Height\": 1080\n },\n \"Multicast\": {\n \"Address\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"0.0.0.0\"\n },\n \"Port\": 8860,\n \"TTL\": 1,\n \"AutoStart\": false\n }\n }\n \n }\n}", + "raw": "{\n \"VideoEncoderConfiguration\": {\n \"ForcePersistence\": false,\n \"Configuration\": {\n \"token\": \"{{EDGEX_MEDIA_VIDEO_ENCODER_TOKEN}}\",\n \"Encoding\": \"H264\",\n \"Quality\": 3.000000,\n \"Resolution\": {\n \"Width\": 1920,\n \"Height\": 1080\n },\n \"Multicast\": {\n \"Address\": {\n \"Type\": \"IPv4\",\n \"IPv4Address\": \"0.0.0.0\"\n },\n \"Port\": 8860,\n \"TTL\": 1,\n \"AutoStart\": false\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -4279,7 +4279,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"Configuration\": {\n \"PTZConfiguration\": {\n \"Token\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"NodeToken\": \"{{PTZ_NODE_TOKEN}}\",\n \"PanTiltLimits\": {\n \"Range\": {\n \"XRange\": {\n \"Max\": 170,\n \"Min\": -170\n },\n \"YRange\": {\n \"Max\": 35,\n \"Min\": -32\n }\n }\n }\n } \n }\n}", + "raw": "{\n \"Configuration\": {\n \"PTZConfiguration\": {\n \"Token\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"NodeToken\": \"{{PTZ_NODE_TOKEN}}\",\n \"PanTiltLimits\": {\n \"Range\": {\n \"XRange\": {\n \"Max\": 170,\n \"Min\": -170\n },\n \"YRange\": {\n \"Max\": 35,\n \"Min\": -32\n }\n }\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -4375,7 +4375,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"AddPTZConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"ConfigurationToken\": \"{{PTZ_CONFIG_TOKEN}}\" \n }\n}", + "raw": "{\n \"AddPTZConfiguration\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"ConfigurationToken\": \"{{PTZ_CONFIG_TOKEN}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -4471,7 +4471,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"RemovePTZConfiguration\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\" \n }\n}", + "raw": "{\n \"RemovePTZConfiguration\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -4572,7 +4572,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"AbsoluteMove\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"Position\": {\n \"PanTilt\": {\n \"x\": 0,\n \"y\": 0\n }\n } \n }\n}", + "raw": "{\n \"AbsoluteMove\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"Position\": {\n \"PanTilt\": {\n \"x\": 0,\n \"y\": 0\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -4668,7 +4668,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"RelativeMove\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"Translation\": {\n \"PanTilt\": {\n \"x\": 0,\n \"y\": 0\n }\n } \n }\n}", + "raw": "{\n \"RelativeMove\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"Translation\": {\n \"PanTilt\": {\n \"x\": 0,\n \"y\": 0\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -4764,7 +4764,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"ContinuousMove\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"Velocity\": {\n \"PanTilt\": {\n \"x\": -1,\n \"y\": -1\n }\n } \n }\n}", + "raw": "{\n \"ContinuousMove\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"Velocity\": {\n \"PanTilt\": {\n \"x\": -1,\n \"y\": -1\n }\n }\n }\n}", "options": { "raw": { "language": "json" @@ -4963,7 +4963,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"Stop\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"PanTilt\": true \n }\n}", + "raw": "{\n \"Stop\": {\n \"ProfileToken\": \"{{MEDIA_PROFILE}}\",\n \"PanTilt\": true\n }\n}", "options": { "raw": { "language": "json" @@ -5064,7 +5064,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"SetPreset\": {\n \"PresetName\":\"Preset1\",\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\" \n }\n}", + "raw": "{\n \"SetPreset\": {\n \"PresetName\": \"Preset1\",\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\"\n }\n}", "options": { "raw": { "language": "json" @@ -5250,7 +5250,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"GotoPreset\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"PresetToken\": \"Preset1\" \n }\n}", + "raw": "{\n \"GotoPreset\": {\n \"ProfileToken\": \"{{PTZ_CONFIG_TOKEN}}\",\n \"PresetToken\": \"Preset1\"\n }\n}", "options": { "raw": { "language": "json" @@ -5899,7 +5899,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"UnsubscribeCameraEvent\": {\n }\n}", + "raw": "{\n \"UnsubscribeCameraEvent\": {}\n}", "options": { "raw": { "language": "json" @@ -6356,7 +6356,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"CreateAnalyticsModules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"AnalyticsModule\": [\n {\n \"Name\": \"TestAnalyticsModule\",\n \"Type\": \"{{ANALYTIC_MODULE_TYPE}}\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\":\"{{ANALYTIC_MODULE_OPTION_NAME}}\", \n \"Value\":\"{{ANALYTIC_MODULE_OPTION_VALUE}}\"\n }\n ]\n }\n \n }\n ]\n }\n}", + "raw": "{\n \"CreateAnalyticsModules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"AnalyticsModule\": [\n {\n \"Name\": \"TestAnalyticsModule\",\n \"Type\": \"{{ANALYTIC_MODULE_TYPE}}\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"{{ANALYTIC_MODULE_OPTION_NAME}}\",\n \"Value\": \"{{ANALYTIC_MODULE_OPTION_VALUE}}\"\n }\n ]\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -6452,7 +6452,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"DeleteAnalyticsModules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"AnalyticsModuleName\": [\"TestAnalyticsModule\"]\n }\n}", + "raw": "{\n \"DeleteAnalyticsModules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"AnalyticsModuleName\": [\n \"TestAnalyticsModule\"\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -6638,7 +6638,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"AnalyticsModules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"AnalyticsModule\": [\n {\n \"Name\": \"Viproc\",\n \"Type\": \"{{ANALYTIC_MODULE_TYPE}}\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\":\"{{ANALYTIC_MODULE_OPTION_NAME}}\", \n \"Value\":\"{{ANALYTIC_MODULE_OPTION_VALUE}}\"\n }\n ]\n }\n \n }\n ]\n }\n}", + "raw": "{\n \"AnalyticsModules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"AnalyticsModule\": [\n {\n \"Name\": \"Viproc\",\n \"Type\": \"{{ANALYTIC_MODULE_TYPE}}\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"{{ANALYTIC_MODULE_OPTION_NAME}}\",\n \"Value\": \"{{ANALYTIC_MODULE_OPTION_VALUE}}\"\n }\n ]\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -6950,7 +6950,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"CreateRules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"Rule\": [\n {\n \"Name\": \"Object Counting\",\n \"Type\": \"tt:LineCounting\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\":\"Armed\", \n \"Value\":\"true\"\n }\n ],\n \"ElementItem\": [\n {\n \"Name\":\"Segments\", \n \"Polyline\": {\n \"Point\": [\n {\n \"x\":\"0.16\",\n \"y\": \"0.5\"\n },\n {\n \"x\":\"0.16\",\n \"y\": \"-0.5\"\n }\n ]\n }\n }\n ]\n }\n \n }\n ]\n }\n}", + "raw": "{\n \"CreateRules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"Rule\": [\n {\n \"Name\": \"Object Counting\",\n \"Type\": \"tt:LineCounting\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"Armed\",\n \"Value\": \"true\"\n }\n ],\n \"ElementItem\": [\n {\n \"Name\": \"Segments\",\n \"Polyline\": {\n \"Point\": [\n {\n \"x\": \"0.16\",\n \"y\": \"0.5\"\n },\n {\n \"x\": \"0.16\",\n \"y\": \"-0.5\"\n }\n ]\n }\n }\n ]\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -7142,7 +7142,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"Rules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"Rule\": [\n {\n \"Name\": \"MyMotionDetectorRule\",\n \"Type\": \"tt:ObjectInField\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\":\"ClassFilter\", \n \"Value\":\" Bike Car Truck\"\n }\n ]\n }\n \n }\n ]\n }\n}", + "raw": "{\n \"Rules\": {\n \"ConfigurationToken\": \"{{ANALYTIC_CONFIG_TOKEN}}\",\n \"Rule\": [\n {\n \"Name\": \"MyMotionDetectorRule\",\n \"Type\": \"tt:ObjectInField\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"ClassFilter\",\n \"Value\": \" Bike Car Truck\"\n }\n ]\n }\n }\n ]\n }\n}", "options": { "raw": { "language": "json" @@ -7323,7 +7323,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{ \"MACAddress\": \"10-27-f5-ea-88-f4\" }", + "raw": "{\n \"MACAddress\": \"10-27-f5-ea-88-f4\"\n}", "options": { "raw": { "language": "json" @@ -7497,7 +7497,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"FriendlyName\": {\n \"FriendlyName\": \"My Camera\"\n }\n}", + "raw": "{\n \"FriendlyName\": \"My Camera\"\n}", "options": { "raw": { "language": "json" @@ -7765,7 +7765,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"CustomMetadata\": {\n \"Location\":\"Front door\",\n \"Business\":\"John's Grocery Store\",\n \"Install Date\":\"01/01/1970\"\n }\n}", + "raw": "{\n \"CustomMetadata\": {\n \"Location\": \"Front door\",\n \"Business\": \"John's Grocery Store\",\n \"Install Date\": \"01/01/1970\",\n \"Color\": \"White\"\n }\n}", "options": { "raw": { "language": "json" @@ -7874,7 +7874,7 @@ "header": [], "body": { "mode": "raw", - "raw": "{\n \"DeleteCustomMetadata\": [\"Location\", \"Color\"]\n}", + "raw": "{\n \"DeleteCustomMetadata\": [\n \"Location\",\n \"Color\"\n ]\n}", "options": { "raw": { "language": "json" @@ -7967,10 +7967,24 @@ "description": "Custom commands outside of the ONVIF spec handled by the device service directly." } ], - "variable": [ + "event": [ { - "key": "ptz_enc", - "value": "" + "listen": "prerequest", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } + }, + { + "listen": "test", + "script": { + "type": "text/javascript", + "exec": [ + "" + ] + } } ] } \ No newline at end of file From 58fdfd40f00060caf6819d4a78b16f38e6b426d4 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Fri, 21 Oct 2022 11:44:45 -0700 Subject: [PATCH 11/15] docs: quote python type hints Signed-off-by: Anthony Casagrande --- doc/openapi/python/cleaner.py | 4 ++-- doc/openapi/python/postprocess.py | 7 ++++--- 2 files changed, 6 insertions(+), 5 deletions(-) diff --git a/doc/openapi/python/cleaner.py b/doc/openapi/python/cleaner.py index 8cdc1db4..8126de45 100644 --- a/doc/openapi/python/cleaner.py +++ b/doc/openapi/python/cleaner.py @@ -25,8 +25,8 @@ class SchemaCleaner: Note: This is a one time use object, do not re-use it! """ yml: any - schemas: dict[str, Schema] = field(default_factory=lambda: defaultdict(Schema)) - unused: set[str] = field(default_factory=set) + schemas: 'dict[str, Schema]' = field(default_factory=lambda: defaultdict(Schema)) + unused: set = field(default_factory=set) def _inner_parse(self, current, obj): """Inner recursive portion of _parse_schemas""" diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index d1948b36..1db8d2f2 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -64,12 +64,13 @@ class YamlProcessor: output_file: str matrix: MarkdownMatrix postman_env_file: str + yml: any = None sidecar: any = None profile: any = None - postman_env: dict[str, str] = field(default_factory=dict) - resources: dict[str, any] = field(default_factory=dict) - wsdl_files: dict[str, any] = field(default_factory=dict) + postman_env: 'dict[str, str]' = field(default_factory=dict) + resources: 'dict[str, any]' = field(default_factory=dict) + wsdl_files: 'dict[str, any]' = field(default_factory=dict) def _load(self): """Read input yaml file and sidecar yaml files""" From 525b448516f7ccbfc29b672512b49cbee4360610 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Fri, 21 Oct 2022 11:57:36 -0700 Subject: [PATCH 12/15] docs: use typing.Dict for typings Signed-off-by: Anthony Casagrande --- doc/openapi/python/cleaner.py | 3 ++- doc/openapi/python/postprocess.py | 7 ++++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/doc/openapi/python/cleaner.py b/doc/openapi/python/cleaner.py index 8126de45..901b08e6 100644 --- a/doc/openapi/python/cleaner.py +++ b/doc/openapi/python/cleaner.py @@ -7,6 +7,7 @@ from collections import defaultdict from dataclasses import dataclass, field from ruamel.yaml import YAML +from typing import Dict yaml = YAML() @@ -25,7 +26,7 @@ class SchemaCleaner: Note: This is a one time use object, do not re-use it! """ yml: any - schemas: 'dict[str, Schema]' = field(default_factory=lambda: defaultdict(Schema)) + schemas: Dict[str, Schema] = field(default_factory=lambda: defaultdict(Schema)) unused: set = field(default_factory=set) def _inner_parse(self, current, obj): diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 1db8d2f2..4ca3a4f2 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -10,6 +10,7 @@ import sys import copy import textwrap +from typing import Dict from ruamel.yaml import YAML from ruamel.yaml.scalarstring import LiteralScalarString @@ -68,9 +69,9 @@ class YamlProcessor: yml: any = None sidecar: any = None profile: any = None - postman_env: 'dict[str, str]' = field(default_factory=dict) - resources: 'dict[str, any]' = field(default_factory=dict) - wsdl_files: 'dict[str, any]' = field(default_factory=dict) + postman_env: Dict[str, str] = field(default_factory=dict) + resources: Dict[str, any] = field(default_factory=dict) + wsdl_files: Dict[str, any] = field(default_factory=dict) def _load(self): """Read input yaml file and sidecar yaml files""" From 560594ef4bd4e076c6088df215d67c9cfb59bdca Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Mon, 24 Oct 2022 14:44:21 -0700 Subject: [PATCH 13/15] docs: use debug logging to produce less output Signed-off-by: Anthony Casagrande --- doc/openapi/README.md | 37 +++++++++++++------- doc/openapi/python/cleaner.py | 8 +++-- doc/openapi/python/postprocess.py | 57 ++++++++++++++++++------------- doc/openapi/python/xmlstrip.py | 18 ++++++---- 4 files changed, 75 insertions(+), 45 deletions(-) diff --git a/doc/openapi/README.md b/doc/openapi/README.md index 4849959c..ec4d2178 100644 --- a/doc/openapi/README.md +++ b/doc/openapi/README.md @@ -1,43 +1,54 @@ # OpenAPI / Swagger Spec Files This code generates OpenAPI 3.0 spec based on the [Postman Collection](../postman/device-onvif-camera.postman_collection.json), -Onvif WSDL Schema Files, and [sidecar.yaml](sidecar.yaml). +[Onvif WSDL Schema Files](./ref), [sidecar.yaml](sidecar.yaml), [default camera device profile](../../cmd/res/profiles/camera.yaml), +[ONVIF Tested Cameras Matrix](../ONVIF-protocol.md#tested-onvif-cameras), and [ONVIF footnotes](../onvif-footnotes.md). -Usage: +## Usage - Install `postman-to-openapi` and python3 dependencies by running `make install` from this directory. -- Update the latest postman collection [device-onvif-camera.postman_collection.json](../postman/device-onvif-camera.postman_collection.json) -- Update the latest postman environment [device-onvif-camera.postman_environment.json](../postman/device-onvif-camera.postman_environment.json) +- Import the latest [postman collection][collection] and latest [postman environment][env] into Postman App +- Modify the postman collection and/or postman environment files +- Export the modified postman collection and environment +- Overwrite the postman collection and environment in this repo with the exported files - Run `make gen` to re-generate the OpenAPI files. + - Use `make -B gen` to force it to no use any cached files + - Use `DEBUG_LOGGING=1 make ...` to enable debug logging of the python scripts -## [python](python) folder +[collection]: ../postman/device-onvif-camera.postman_collection.json +[env]: ../postman/device-onvif-camera.postman_environment.json + +## Explanation +### [python](python) folder Contains scripts for processing the input and output files when generating the OpenAPI spec file. -### [xmlstrip.py](python/xmlstrip.py) +#### [xmlstrip.py](python/xmlstrip.py) This script cleans up the yaml files in the [ref](ref) folder by removing all the xml references in the schema, and tweaking the schema values to clean them up for use in the [postprocess.py](python/postprocess.py) script. -### [postprocess.py](python/postprocess.py) +#### [postprocess.py](python/postprocess.py) This script takes in the preliminary OpenAPI file that was generated from the Postman collection and adds additional metadata to it, as well as cleaning up the data and format. -### [xmlstrip.py](python/xmlstrip.py) +#### [xmlstrip.py](python/xmlstrip.py) This script cleans up the yaml files in the [ref](ref) folder by removing all the xml references in the schema, and tweaking the schema values to clean them up for use in the [postprocess.py](python/postprocess.py) script. -### [matrix.py](python/matrix.py) +#### [matrix.py](python/matrix.py) This script adds the compatibility matrix to each endpoint -### [cleaner.py](python/cleaner.py) +#### [cleaner.py](python/cleaner.py) This script removes all unused schema definition files -## [ref](ref) folder +### [sidecar.yaml](sidecar.yaml) +Contains additional canned responses, template data, and schemas to include in the final OpenAPI spec file. + +### [ref](ref) folder This folder contains files generated from the official Onvif wsdl spec files. The wsdl files were imported into [apimatic.io](https://apimatic.io) and exported as OpenAPI 3.0 spec yaml files. -## [v2](v2) folder +### [v2](v2) folder This folder contains the final exported OpenAPI 3.0 spec file, to be exported to SwaggerHub. - diff --git a/doc/openapi/python/cleaner.py b/doc/openapi/python/cleaner.py index 901b08e6..5216b0ba 100644 --- a/doc/openapi/python/cleaner.py +++ b/doc/openapi/python/cleaner.py @@ -8,8 +8,10 @@ from dataclasses import dataclass, field from ruamel.yaml import YAML from typing import Dict +import logging yaml = YAML() +log = logging.getLogger('cleaner') @dataclass @@ -88,11 +90,11 @@ def remove_unused_schemas(self) -> any: Recursively parses the schemas to determine which ones are used and which ones are not. The unused ones are subsequently deleted from the input yaml data. """ - print('Removing unused schemas') + log.debug('Removing unused schemas') total = len(self.yml["components"]["schemas"]) # cache the total number as it will be modified by the end self._parse_schemas() self._find_unused() self._remove_unused() - print(f'Removed {len(self.unused)} unused schemas of {total} total schemas!') - print(f'{len(self.yml["components"]["schemas"])} total schemas remain') + log.info(f'Removed {len(self.unused)} unused schemas of {total} total schemas!') + log.debug(f'{len(self.yml["components"]["schemas"])} total schemas remain') diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 4ca3a4f2..0668d853 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -11,6 +11,8 @@ import copy import textwrap from typing import Dict +import logging +import os from ruamel.yaml import YAML from ruamel.yaml.scalarstring import LiteralScalarString @@ -19,6 +21,7 @@ from matrix import MarkdownMatrix yaml = YAML() +log = logging.getLogger('postprocess') EDGEX = 'EdgeX' EDGEX_DEVICE_NAME = 'Camera001' @@ -75,23 +78,23 @@ class YamlProcessor: def _load(self): """Read input yaml file and sidecar yaml files""" - print(f'Reading input OpenAPI file: {self.input_file}') + log.info(f'Reading input OpenAPI file: {self.input_file}') with open(self.input_file) as f: self.yml = yaml.load(f) - print(f'Reading sidecar file: {self.sidecar_file}') + log.info(f'Reading sidecar file: {self.sidecar_file}') with open(self.sidecar_file) as f: self.sidecar = yaml.load(f) - print(f'Reading profile file: {self.profile_file}') + log.info(f'Reading profile file: {self.profile_file}') with open(self.profile_file) as f: self.profile = yaml.load(f) - print(f'Loading validation matrix file: {self.matrix.tested_file}') - print(f'Loading footnotes file: {self.matrix.footnotes_file}') + log.info(f'Loading validation matrix file: {self.matrix.tested_file}') + log.info(f'Loading footnotes file: {self.matrix.footnotes_file}') self.matrix.parse() - print(f'Loading postman env file: {self.postman_env_file}') + log.info(f'Loading postman env file: {self.postman_env_file}') with open(self.postman_env_file) as f: env = json.load(f) for item in env['values']: @@ -104,7 +107,7 @@ def _parse(self): def _write(self): """Output modified yaml file""" - print(f'Writing output OpenAPI file: {self.output_file}') + log.info(f'Writing output OpenAPI file: {self.output_file}') with open(self.output_file, 'w') as w: yaml.dump(self.yml, w) @@ -138,7 +141,7 @@ def _process_apis(self): len(content['application/json']) == 0 or \ ('example' in content['application/json'] and len( content['application/json']['example']) == 2): - print(f'Overriding empty 200 response for {service_fn}') + log.debug(f'Overriding empty 200 response for {service_fn}') method_obj['responses'][code] = resp_obj if service == EDGEX: @@ -152,7 +155,7 @@ def _process_apis(self): # override with cloned one method_obj['responses']['200'] = resp_200 else: - print(f'\033[33m[WARNING] *** Missing schema response definition for EdgeX command {method.upper()} {cmd} ***\033[0m') + log.warning(f'\033[33m*** Missing schema response definition for EdgeX command {method.upper()} {cmd} ***\033[0m') elif method == 'put': if cmd in self.sidecar['requests']['edgex']: # look for the json response object, so we can modify it @@ -171,7 +174,7 @@ def _process_apis(self): 'type': 'object' } else: - print(f'\033[33m[WARNING] *** Missing schema request definition for EdgeX command {method.upper()} {cmd} ***\033[0m') + log.warning(f'\033[33m*** Missing schema request definition for EdgeX command {method.upper()} {cmd} ***\033[0m') # override the response schema with default 200 response method_obj['responses']['200'] = self.sidecar['responses']['canned']['200'] @@ -191,11 +194,11 @@ def _process_apis(self): api = paths[f'/{fn}']['post'] if 'description' in api and \ ('description' not in method_obj or method_obj['description'].strip() == ''): - print(f'Copying description for {service_fn}') + log.debug(f'Copying description for {service_fn}') method_obj['description'] = api['description'] if service_fn in self.matrix.validated: - print(f'Adding validated camera list in description for {service_fn}') + log.debug(f'Adding validated camera list in description for {service_fn}') val_desc = f'''
@@ -211,7 +214,7 @@ def _process_apis(self): method_obj['description'] = multiline_string(method_obj['description'] + val_desc + '
') elif service != EDGEX: # only print warning for non-EdgeX functions - print(f'\033[33m[WARNING] *** Missing camera validation entry for command {service_fn} ***\033[0m') + log.warning(f'\033[33m*** Missing camera validation entry for command {service_fn} ***\033[0m') if service == EDGEX: # nothing left to patch for custom edgex functions, as they do not exist in onvif spec @@ -274,7 +277,7 @@ def _process_apis(self): if req_schema in self.yml['components']['schemas']: schema = self.yml['components']['schemas'][req_schema] if 'type' in schema and schema['type'] == 'object' and len(schema) == 1: - print(f'Skipping empty request schema for {service_fn}') + log.debug(f'Skipping empty request schema for {service_fn}') else: found = False for param in method_obj['parameters']: @@ -283,7 +286,7 @@ def _process_apis(self): self._set_json_object(param, service, fn) break if not found: - print(f'\033[33m[WARNING] *** Expected jsonObject parameter for command {cmd}! Creating one. ***\033[0m') + log.warning(f'\033[33m*** Expected jsonObject parameter for command {cmd}! Creating one. ***\033[0m') param = { 'name': 'jsonObject', 'in': 'query', @@ -340,11 +343,11 @@ def _combine_schemas(self): self.wsdl_files = {} for service in SERVICE_WSDL.keys(): fname = f'ref/out/{service.lower()}.yaml' - print(f'Loading schema file: {fname}') + log.info(f'Loading schema file: {fname}') with open(fname) as f: self.wsdl_files[service] = yaml.load(f) - print('Combining schema files') + log.info('Combining schema files') schemas = {} for schema_file in self.wsdl_files.values(): for k, v in schema_file['components']['schemas'].items(): @@ -466,14 +469,14 @@ def _verify_complete(self): api = f'{API_PREFIX}/{cmd}' path_obj = None if api not in self.yml['paths']: - print(f'\033[33m[WARNING] API "{api}" is missing from input collection! ***\033[0m') + log.warning(f'\033[33m*** API "{api}" is missing from input collection! ***\033[0m') else: path_obj = self.yml['paths'][api] if 'getFunction' in cmd_obj['attributes'] and (path_obj is None or 'get' not in path_obj): - print(f'\033[33m[WARNING] *** Expected call GET "{cmd}" was not found in input yaml! ***\033[0m') + log.warning(f'\033[33m*** Expected call GET "{cmd}" was not found in input yaml! ***\033[0m') if 'setFunction' in cmd_obj['attributes'] and (path_obj is None or 'put' not in path_obj): - print(f'\033[33m[WARNING] *** Expected call PUT "{cmd}" was not found in input yaml! ***\033[0m') + log.warning(f'\033[33m*** Expected call PUT "{cmd}" was not found in input yaml! ***\033[0m') def _patch_parameters(self): """ @@ -530,10 +533,10 @@ def _insert_postman_env(self, obj): if v.startswith('{{'): key = v.lstrip('{{').rstrip('}}') if key in self.postman_env: - print(f'Patching postman env: {key}') + log.debug(f'Patching postman env: {key}') obj[k] = self.postman_env[key] else: - print(f'\033[33m[WARNING] *** Reference to postman env {key} was not found in environment ***\033[0m') + log.warning(f'\033[33m*** Reference to postman env {key} was not found in environment ***\033[0m') else: self._insert_postman_env(v) elif isinstance(obj, list): @@ -546,7 +549,15 @@ def main(): print(f'Usage: {sys.argv[0]} ') sys.exit(1) - proc = YamlProcessor(sys.argv[1], sys.argv[2], sys.argv[3], sys.argv[4], MarkdownMatrix(sys.argv[5], sys.argv[6]), sys.argv[7]) + logging.basicConfig(level=(logging.DEBUG if os.getenv('DEBUG_LOGGING') == '1' else logging.INFO), + format='%(asctime)-15s %(levelname)-8s %(name)-8s %(message)s') + + proc = YamlProcessor(sys.argv[1], # input_file + sys.argv[2], # sidecar_file + sys.argv[3], # profile_file + sys.argv[4], # output_file + MarkdownMatrix(sys.argv[5], sys.argv[6]), # onvif_tested_file, onvif_footnotes_file + sys.argv[7]) # postman_env_file proc.process() diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py index e5267452..7953cafa 100755 --- a/doc/openapi/python/xmlstrip.py +++ b/doc/openapi/python/xmlstrip.py @@ -3,10 +3,13 @@ # Copyright (C) 2022 Intel Corporation # SPDX-License-Identifier: Apache-2.0 # - +import os import re import sys import yaml +import logging + +log = logging.getLogger('xmlstrip') # schemas to not include in the exported file EXCLUDED_SCHEMAS = ['wstop_Topic', 'wstop_TopicNamespaceType', 'wstop_TopicType'] @@ -20,6 +23,9 @@ def main(): if len(sys.argv) != 4: print(f'Usage: {sys.argv[0]} ') + logging.basicConfig(level=(logging.DEBUG if os.getenv('DEBUG_LOGGING') == '1' else logging.INFO), + format='%(asctime)-15s %(levelname)-8s %(name)-8s %(message)s') + with open(sys.argv[2]) as f: yml = yaml.safe_load(f.read()) @@ -59,7 +65,7 @@ def fix_schemas(schemas): # this has the benefit of printing out the transformations. if k.startswith('tt_') | k.startswith('tns_'): k2 = k.replace('tt_', f'onvif_').replace('tns_', f'{service}_') - print(f'{k} -> {k2}') + log.debug(f'{k} -> {k2}') out[k2] = v # only add schemas which are namespaced (ie. contain an underscore) @@ -84,7 +90,7 @@ def fix_refs(name, obj): if isinstance(obj, dict): if 'allOf' in obj and len(obj) == 1: if len(obj['allOf']) == 1 and '$ref' in obj['allOf'][0]: - print(f'fixing schema ref for {name}') + log.debug(f'fixing schema ref for {name}') obj['$ref'] = obj['allOf'][0]['$ref'] del obj['allOf'] else: @@ -105,14 +111,14 @@ def strip_xml(name, obj): """ if isinstance(obj, dict): if 'xml' in obj: - print(f'Stripping xml field from {name}') + log.debug(f'Stripping xml field from {name}') del obj['xml'] if 'description' in obj and obj['description'].strip() == '': del obj['description'] if 'application/xml' in obj: - print('Redefining mime type to application/json') + log.debug('Redefining mime type to application/json') obj['application/json'] = obj['application/xml'] del obj['application/xml'] @@ -123,7 +129,7 @@ def strip_xml(name, obj): for o2 in obj: strip_xml(f'{name}[]', o2) if len(obj) == 2 and obj[1] == {}: - print('Removing empty value from array') + log.debug('Removing empty value from array') del obj[1] From 08f55f8b99f7998092fe3b80cf36075370ffe62a Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Mon, 24 Oct 2022 16:36:52 -0700 Subject: [PATCH 14/15] docs: add missing env vars for postman Signed-off-by: Anthony Casagrande --- doc/openapi/v2/device-onvif-camera.yaml | 12 ++++++------ ...evice-onvif-camera.postman_environment.json | 18 ++++++++++++++++++ 2 files changed, 24 insertions(+), 6 deletions(-) diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index b4e73a8d..5926120d 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -5663,11 +5663,11 @@ paths: ConfigurationToken: VideoAnalyticsToken_3263078450 AnalyticsModule: - Name: Viproc - Type: '{{ANALYTIC_MODULE_TYPE}}' + Type: tt:CellMotionEngine Parameters: SimpleItem: - - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' - Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' + - Name: Sensitivity + Value: '40' parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: @@ -5721,11 +5721,11 @@ paths: ConfigurationToken: VideoAnalyticsToken_3263078450 AnalyticsModule: - Name: TestAnalyticsModule - Type: '{{ANALYTIC_MODULE_TYPE}}' + Type: tt:CellMotionEngine Parameters: SimpleItem: - - Name: '{{ANALYTIC_MODULE_OPTION_NAME}}' - Value: '{{ANALYTIC_MODULE_OPTION_VALUE}}' + - Name: Sensitivity + Value: '40' parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: diff --git a/doc/postman/device-onvif-camera.postman_environment.json b/doc/postman/device-onvif-camera.postman_environment.json index 73864e63..e1695de5 100644 --- a/doc/postman/device-onvif-camera.postman_environment.json +++ b/doc/postman/device-onvif-camera.postman_environment.json @@ -109,6 +109,24 @@ "value": "eyJDb25maWd1cmF0aW9uVG9rZW4iOiAiUFRaQ29uZmlndXJhdGlvbjAifQ==", "type": "default", "enabled": true + }, + { + "key": "ANALYTIC_MODULE_TYPE", + "value": "tt:CellMotionEngine", + "type": "default", + "enabled": true + }, + { + "key": "ANALYTIC_MODULE_OPTION_NAME", + "value": "Sensitivity", + "type": "default", + "enabled": true + }, + { + "key": "ANALYTIC_MODULE_OPTION_VALUE", + "value": "40", + "type": "default", + "enabled": true } ], "_postman_variable_scope": "environment", From 86c68f64e3a8b624a4bd1892fd05bfd93905ecb0 Mon Sep 17 00:00:00 2001 From: Anthony Casagrande Date: Tue, 25 Oct 2022 10:25:49 -0700 Subject: [PATCH 15/15] docs: update responses with data from hikvision validation Signed-off-by: Anthony Casagrande --- doc/openapi/python/postprocess.py | 2 +- doc/openapi/python/xmlstrip.py | 68 +-- doc/openapi/v2/device-onvif-camera.yaml | 505 ++++++++++++++---- ...evice-onvif-camera.postman_collection.json | 144 +++-- 4 files changed, 530 insertions(+), 189 deletions(-) diff --git a/doc/openapi/python/postprocess.py b/doc/openapi/python/postprocess.py index 0668d853..6809b739 100755 --- a/doc/openapi/python/postprocess.py +++ b/doc/openapi/python/postprocess.py @@ -550,7 +550,7 @@ def main(): sys.exit(1) logging.basicConfig(level=(logging.DEBUG if os.getenv('DEBUG_LOGGING') == '1' else logging.INFO), - format='%(asctime)-15s %(levelname)-8s %(name)-8s %(message)s') + format='%(asctime)-15s %(levelname)-8s %(name)-12s %(message)s') proc = YamlProcessor(sys.argv[1], # input_file sys.argv[2], # sidecar_file diff --git a/doc/openapi/python/xmlstrip.py b/doc/openapi/python/xmlstrip.py index 7953cafa..1908509d 100755 --- a/doc/openapi/python/xmlstrip.py +++ b/doc/openapi/python/xmlstrip.py @@ -19,40 +19,6 @@ TT_REGEX = re.compile(r'([ /])tt_') -def main(): - if len(sys.argv) != 4: - print(f'Usage: {sys.argv[0]} ') - - logging.basicConfig(level=(logging.DEBUG if os.getenv('DEBUG_LOGGING') == '1' else logging.INFO), - format='%(asctime)-15s %(levelname)-8s %(name)-8s %(message)s') - - with open(sys.argv[2]) as f: - yml = yaml.safe_load(f.read()) - - for name, obj in yml.items(): - strip_xml(name, obj) - - for name, obj in yml.items(): - fix_refs(name, obj) - - yml['components']['schemas'] = fix_schemas(yml['components']['schemas']) - - service = sys.argv[1] - with open(sys.argv[3], 'w') as w: - # todo: this can be optimized better using streams. Right now it dumps the yaml to a string - # and then processes each raw line before actually writing it to the output file. - lines = yaml.dump(yml).split('\n') - for line in lines: - if TITLE_REGEX.match(line): - continue # skip the title elements as they are all just superfluous - # namespace all tns schemas to this specific service - line = TNS_REGEX.sub(fr'\1{service}_', line) - # namespace all tt schemas as common onvif - line = TT_REGEX.sub(r'\1onvif_', line) - w.write(line) - w.write('\n') - - def fix_schemas(schemas): """ Namespace all schemas by service name @@ -133,5 +99,39 @@ def strip_xml(name, obj): del obj[1] +def main(): + if len(sys.argv) != 4: + print(f'Usage: {sys.argv[0]} ') + + logging.basicConfig(level=(logging.DEBUG if os.getenv('DEBUG_LOGGING') == '1' else logging.INFO), + format='%(asctime)-15s %(levelname)-12s %(name)-8s %(message)s') + + with open(sys.argv[2]) as f: + yml = yaml.safe_load(f.read()) + + for name, obj in yml.items(): + strip_xml(name, obj) + + for name, obj in yml.items(): + fix_refs(name, obj) + + yml['components']['schemas'] = fix_schemas(yml['components']['schemas']) + + service = sys.argv[1] + with open(sys.argv[3], 'w') as w: + # todo: this can be optimized better using streams. Right now it dumps the yaml to a string + # and then processes each raw line before actually writing it to the output file. + lines = yaml.dump(yml).split('\n') + for line in lines: + if TITLE_REGEX.match(line): + continue # skip the title elements as they are all just superfluous + # namespace all tns schemas to this specific service + line = TNS_REGEX.sub(fr'\1{service}_', line) + # namespace all tt schemas as common onvif + line = TT_REGEX.sub(r'\1onvif_', line) + w.write(line) + w.write('\n') + + if __name__ == '__main__': main() diff --git a/doc/openapi/v2/device-onvif-camera.yaml b/doc/openapi/v2/device-onvif-camera.yaml index 5926120d..afae4517 100644 --- a/doc/openapi/v2/device-onvif-camera.yaml +++ b/doc/openapi/v2/device-onvif-camera.yaml @@ -636,21 +636,27 @@ paths: statusCode: 200 event: apiVersion: v2 - id: d2d2541f-2feb-490f-bf89-b7407d3078d3 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: b45c64e4-1e1b-49c5-a1b9-d83f15e280b2 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: DNS - origin: 1659671999397808400 + origin: 1664265880674763500 readings: - - id: 3ad48fbe-1e98-4c90-a26e-f83a391c4d8c - origin: 1659671999397808400 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + - id: 548e6841-0914-4e9c-935e-c58320a998a8 + origin: 1664265880674763500 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: DNS profileName: onvif-camera valueType: Object value: '' objectValue: - DNSInformation: {} + DNSInformation: + DNSManual: + IPv4Address: 223.5.5.5 + Type: IPv4 + FromDHCP: false '400': *id001 '404': *id002 '423': *id003 @@ -1024,21 +1030,25 @@ paths: statusCode: 200 event: apiVersion: v2 - id: 78915210-fab0-4018-a8ed-72f793c2cbc7 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: 66991bcb-ff04-4680-af91-aefe449d517c + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: NetworkDefaultGateway - origin: 1659671987813255200 + origin: 1664269765488074200 readings: - - id: c348128d-0c51-4470-a978-b431302906a0 - origin: 1659671987813255200 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + - id: 4c8c2ca4-2c0c-49eb-8c8d-e21209813445 + origin: 1664269765488074200 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: NetworkDefaultGateway profileName: onvif-camera valueType: Object value: '' objectValue: - NetworkGateway: {} + NetworkGateway: + IPv4Address: 10.0.20.1 + IPv6Address: '::' '400': *id001 '404': *id002 '423': *id003 @@ -1881,21 +1891,38 @@ paths: statusCode: 200 event: apiVersion: v2 - id: 1acba723-b1b1-4790-8e80-9d554cacaedc - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: 95eae089-a594-4af6-b827-c0cd689034e1 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: MetadataConfigurations - origin: 1659659180814799600 + origin: 1664272201400116500 readings: - - id: 8c59a3a8-401b-4e18-8af5-9a98efe7f410 - origin: 1659659180814799600 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + - id: 147f3297-6d21-4c9d-b0f9-241f1ca0528c + origin: 1664272201400116500 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: MetadataConfigurations profileName: onvif-camera valueType: Object value: '' objectValue: - Configurations: {} + Configurations: + Analytics: false + AnalyticsEngineConfiguration: {} + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 8864 + TTL: 128 + Name: metaData + PTZStatus: + Position: false + Status: false + SessionTimeout: PT5S + Token: MetaDataToken '400': *id001 '404': *id002 '423': *id003 @@ -1985,21 +2012,39 @@ paths: statusCode: 200 event: apiVersion: v2 - id: 53480499-ece4-4437-b795-0ff4f57a564a - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + id: 239e1b98-d000-4bc5-8bd8-8287817b756f + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: MetadataConfiguration - origin: 1663974689815368400 + origin: 1664272513018240800 readings: - - id: b6cda316-6a50-4990-8279-e2777be95c79 - origin: 1663974689815368400 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688 + - id: ab630702-05d5-4c97-98d0-fa23b16e72cc + origin: 1664272513018240800 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: MetadataConfiguration profileName: onvif-camera valueType: Object value: '' objectValue: - Configuration: {} + Configuration: + Analytics: false + AnalyticsEngineConfiguration: {} + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 8864 + TTL: 128 + Name: metaData + PTZStatus: + Position: false + Status: false + SessionTimeout: PT5S + Token: MetaDataToken + UseCount: 1 '400': *id001 '404': *id002 '423': *id003 @@ -2136,21 +2181,39 @@ paths: statusCode: 200 event: apiVersion: v2 - id: 410b5658-82d9-488c-a5c4-c69f0ff6d273 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: 37a0130d-d555-44f2-ab9c-6214617eca32 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: CompatibleMetadataConfigurations - origin: 1659659188300470500 + origin: 1664272369409217800 readings: - - id: 86aa4298-c8ee-4c74-afc9-73104bb3cd11 - origin: 1659659188300470500 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + - id: 86fb41fc-48e7-455f-bb66-78c8f556a21e + origin: 1664272369409217800 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: CompatibleMetadataConfigurations profileName: onvif-camera valueType: Object value: '' objectValue: - Configurations: {} + Configurations: + Analytics: false + AnalyticsEngineConfiguration: {} + Multicast: + Address: + IPv4Address: 0.0.0.0 + Type: IPv4 + AutoStart: false + Port: 8864 + TTL: 128 + Name: metaData + PTZStatus: + Position: false + Status: false + SessionTimeout: PT5S + Token: MetaDataToken + UseCount: 1 '400': *id001 '404': *id002 '423': *id003 @@ -2243,21 +2306,28 @@ paths: statusCode: 200 event: apiVersion: v2 - id: f296e8b5-707f-4e66-9388-918821b83a19 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + id: e694b7a9-8a40-49c8-a5ed-a655b4342bb7 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: MetadataConfigurationOptions - origin: 1659659194429862100 + origin: 1664272709504749800 readings: - - id: f8efa15a-612d-4532-b40b-4e895cecb3bd - origin: 1659659194429862100 - deviceName: TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 + - id: 9951b817-1f15-4dde-98fc-7fe7b5727008 + origin: 1664272709504749800 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: MetadataConfigurationOptions profileName: onvif-camera valueType: Object value: '' objectValue: - Options: {} + Options: + PTZStatusFilterOptions: + PanTiltPositionSupported: false + PanTiltStatusSupported: false + ZoomPositionSupported: false + ZoomStatusSupported: false '400': *id001 '404': *id002 '423': *id003 @@ -5215,8 +5285,8 @@ paths: **Schema Reference:** [media2_GetProfiles](#media2_GetProfiles) - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '500': - description: Internal Server Error + '200': + description: OK headers: Content-Type: schema: @@ -5224,28 +5294,6 @@ paths: example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - type: object - example: - apiVersion: v2 - message: >- - request failed, status code: 500, err: - {"apiVersion":"v2","message":"error reading DeviceResourece - Media2Profiles for - TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e - failed to execute read command -\u003e invalid request for the - function 'GetProfiles' of web service 'Media2'. Onvif error: - fault reason: Method 'tr2:GetProfiles' not implemented: method - name or namespace not recognized, fault detail: , fault code: - SOAP-ENV:Sender ","statusCode":500} - statusCode: 500 - '200': - description: OK - headers: - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' content: application/json: schema: @@ -5259,12 +5307,41 @@ paths: properties: objectValue: $ref: '#/components/schemas/media2_GetProfilesResponse' - examples: - 200Example: - $ref: '#/components/examples/200Example' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 100ae377-e811-4b88-bd81-f6f67c86cf61 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c + profileName: onvif-camera + sourceName: Media2Profiles + origin: 1664440520205892000 + readings: + - id: e6bf94fd-ebde-4b0a-a503-8b23f7a8aebb + origin: 1664440520205892000 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c + resourceName: Media2Profiles + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Profiles: + - Fixed: true + Name: mainStream + Token: Profile_1 + - Fixed: true + Name: subStream + Token: Profile_2 + - Fixed: true + Name: thirdStream + Token: Profile_3 '400': *id001 '404': *id002 '423': *id003 + '500': *id004 '503': *id005 externalDocs: description: Onvif Specification @@ -5292,8 +5369,8 @@ paths: parameters: - $ref: '#/components/parameters/EDGEX_DEVICE_NAME' responses: - '500': - description: Internal Server Error + '200': + description: OK headers: Content-Type: schema: @@ -5301,29 +5378,6 @@ paths: example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' - content: - application/json: - schema: - type: object - example: - apiVersion: v2 - message: >- - request failed, status code: 500, err: - {"apiVersion":"v2","message":"error reading DeviceResourece - GetAnalyticsConfigurations for - TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\u003e - failed to execute read command -\u003e invalid request for the - function 'GetAnalyticsConfigurations' of web service 'Media2'. - Onvif error: fault reason: Method - 'tr2:GetAnalyticsConfigurations' not implemented: method name - or namespace not recognized, fault detail: , fault code: - SOAP-ENV:Sender ","statusCode":500} - statusCode: 500 - '200': - description: OK - headers: - X-Correlation-Id: - $ref: '#/components/headers/correlatedResponseHeader' content: application/json: schema: @@ -5337,12 +5391,91 @@ paths: properties: objectValue: $ref: '#/components/schemas/media2_GetAnalyticsConfigurationsResponse' - examples: - 200Example: - $ref: '#/components/examples/200Example' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 08db4d59-0991-4ace-bb6a-9103c54d38ea + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c + profileName: onvif-camera + sourceName: GetAnalyticsConfigurations + origin: 1664440527648299300 + readings: + - id: 6e768a1a-a521-47c6-9d13-2337386768d1 + origin: 1664440527648299300 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c + resourceName: GetAnalyticsConfigurations + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + Configurations: + - AnalyticsEngineConfiguration: + AnalyticsModule: + - Name: MyCellMotionModule + Parameters: + ElementItem: + - Name: Layout + SimpleItem: + - Name: Sensitivity + Value: '0' + Type: tt:CellMotionEngine + - Name: MyLineDetectorModule + Parameters: + ElementItem: + - Name: Layout + - Name: Field + SimpleItem: + - Name: Sensitivity + Value: '50' + Type: tt:LineDetectorEngine + - Name: MyFieldDetectorModule + Parameters: + ElementItem: + - Name: Layout + - Name: Field + SimpleItem: + - Name: Sensitivity + Value: '50' + Type: tt:FieldDetectorEngine + - Name: MyTamperDetecModule + Parameters: + ElementItem: + - Name: Transformation + - Name: Field + SimpleItem: + - Name: Sensitivity + Value: '0' + Type: hikxsd:TamperEngine + Name: VideoAnalyticsName + RuleEngineConfiguration: + Rule: + - Name: MyMotionDetectorRule + Parameters: + SimpleItem: + - Name: MinCount + Value: '5' + - Name: AlarmOnDelay + Value: '1000' + - Name: AlarmOffDelay + Value: '1000' + - Name: ActiveCells + Value: zwA= + Type: tt:CellMotionDetector + - Name: MyTamperDetectorRule + Parameters: + ElementItem: + - Name: Field + Type: hikxsd:TamperDetector + Token: VideoAnalyticsToken + UseCount: 3 '400': *id001 '404': *id002 '423': *id003 + '500': *id004 '503': *id005 externalDocs: description: Onvif Specification @@ -5493,6 +5626,10 @@ paths: '200': description: OK headers: + Content-Type: + schema: + type: string + example: application/json X-Correlation-Id: $ref: '#/components/headers/correlatedResponseHeader' content: @@ -5508,9 +5645,132 @@ paths: properties: objectValue: $ref: '#/components/schemas/analytics_GetSupportedAnalyticsModulesResponse' - examples: - 200Example: - $ref: '#/components/examples/200Example' + example: + apiVersion: v2 + statusCode: 200 + event: + apiVersion: v2 + id: 1caa5b4c-a2d1-403e-90a0-fc7d63a9538c + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c + profileName: onvif-camera + sourceName: GetSupportedAnalyticsModules + origin: 1664440535746008300 + readings: + - id: f9f5ddc4-10df-41a1-b50e-c12683683093 + origin: 1664440535746008300 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c + resourceName: GetSupportedAnalyticsModules + profileName: onvif-camera + valueType: Object + value: '' + objectValue: + SupportedAnalyticsModules: + AnalyticsModuleContentSchemaLocation: http://www.w3.org/2001/XMLSchema + AnalyticsModuleDescription: + - Fixed: false + MaxInstances: 1 + Messages: + Data: + SimpleItemDescription: + - Name: IsMotion + Type: xs:boolean + IsProperty: true + ParentTopic: tns1:RuleEngine/CellMotionDetector/Motion + Source: + SimpleItemDescription: + - Name: VideoSourceConfigurationToken + Type: tt:ReferenceToken + - Name: VideoAnalyticsConfigurationToken + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:CellMotionEngine + Parameters: + ElementItemDescription: + - Name: Layout + SimpleItemDescription: + - Name: Sensitivity + Type: xs:integer + - Fixed: false + MaxInstances: 4 + Messages: + Data: + SimpleItemDescription: + - Name: ObjectId + Type: xs:integer + ParentTopic: tns1:RuleEngine/LineDetector/Crossed + Source: + SimpleItemDescription: + - Name: VideoSourceConfigurationToken + Type: tt:ReferenceToken + - Name: VideoAnalyticsConfigurationToken + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:LineDetectorEngine + Parameters: + ElementItemDescription: + - Name: Transformation + - Name: Field + SimpleItemDescription: + - Name: Sensitivity + Type: xs:integer + - Fixed: false + MaxInstances: 4 + Messages: + Data: + SimpleItemDescription: + - Name: IsInside + Type: xs:boolean + IsProperty: true + Key: + SimpleItemDescription: + - Name: ObjectId + Type: xs:integer + ParentTopic: tns1:RuleEngine/FieldDetector/ObjectsInside + Source: + SimpleItemDescription: + - Name: VideoSourceConfigurationToken + Type: tt:ReferenceToken + - Name: VideoAnalyticsConfigurationToken + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: tt:FieldDetectorEngine + Parameters: + ElementItemDescription: + - Name: Transformation + - Name: Field + SimpleItemDescription: + - Name: Sensitivity + Type: xs:integer + - Fixed: false + MaxInstances: 1 + Messages: + Data: + SimpleItemDescription: + - Name: IsTamper + Type: xs:boolean + IsProperty: true + ParentTopic: tns1:RuleEngine/TamperDetector/Tamper + Source: + SimpleItemDescription: + - Name: VideoSourceConfigurationToken + Type: tt:ReferenceToken + - Name: VideoAnalyticsConfigurationToken + Type: tt:ReferenceToken + - Name: Rule + Type: xs:string + Name: hikxsd:TamperEngine + Parameters: + ElementItemDescription: + - Name: Transformation + - Name: Field + SimpleItemDescription: + - Name: Sensitivity + Type: xs:integer '400': *id001 '404': *id002 '423': *id003 @@ -5600,15 +5860,17 @@ paths: statusCode: 200 event: apiVersion: v2 - id: 76f908cd-6b34-477f-9a03-5eea4021b416 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + id: 09e8fab7-e43d-4ba3-adeb-6ca2d3a3b255 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c profileName: onvif-camera sourceName: AnalyticsModules - origin: 1665460175164294000 + origin: 1664440545266300000 readings: - - id: c5f01e17-9b31-43eb-bc55-2417617ef530 - origin: 1665460175164294000 - deviceName: Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19 + - id: c2bf2bfe-915f-48e5-bb4b-5cfdf5d9241a + origin: 1664440545266300000 + deviceName: >- + HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c resourceName: AnalyticsModules profileName: onvif-camera valueType: Object @@ -5617,10 +5879,39 @@ paths: AnalyticsModule: - Name: MyCellMotionModule Parameters: + ElementItem: + - Name: Layout SimpleItem: - Name: Sensitivity - Value: '6' + Value: '0' Type: tt:CellMotionEngine + - Name: MyLineDetectorModule + Parameters: + ElementItem: + - Name: Layout + - Name: Field + SimpleItem: + - Name: Sensitivity + Value: '50' + Type: tt:LineDetectorEngine + - Name: MyFieldDetectorModule + Parameters: + ElementItem: + - Name: Layout + - Name: Field + SimpleItem: + - Name: Sensitivity + Value: '50' + Type: tt:FieldDetectorEngine + - Name: MyTamperDetecModule + Parameters: + ElementItem: + - Name: Transformation + - Name: Field + SimpleItem: + - Name: Sensitivity + Value: '0' + Type: hikxsd:TamperEngine '400': *id001 '404': *id002 '423': *id003 diff --git a/doc/postman/device-onvif-camera.postman_collection.json b/doc/postman/device-onvif-camera.postman_collection.json index db52dce1..56ee61b4 100644 --- a/doc/postman/device-onvif-camera.postman_collection.json +++ b/doc/postman/device-onvif-camera.postman_collection.json @@ -1,6 +1,6 @@ { "info": { - "_postman_id": "b7a70229-560c-41c2-9958-4994c7bd93fc", + "_postman_id": "c665bdf3-cb76-4f60-8043-825441d7d5df", "name": "device-onvif-camera", "description": "The Open Network Video Interface Forum (ONVIF) Device Service is a microservice created to address the lack of standardization and automation of camera discovery and onboarding. EdgeX Foundry is a flexible microservice-based architecture created to promote the interoperability of multiple device interface combinations at the edge. In an EdgeX deployment, the ONVIF Device Service controls and communicates with ONVIF-compliant cameras, while EdgeX Foundry presents a standard interface to application developers. With normalized connectivity protocols and a vendor-neutral architecture, EdgeX paired with ONVIF Camera Device Service, simplifies deployment of edge camera devices.\n\nUse the ONVIF Device Service to streamline and scale your edge camera device deployment.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", @@ -803,19 +803,19 @@ }, { "key": "X-Correlation-Id", - "value": "d1eccd37-33c0-4c5d-bbb3-434b384399d2" + "value": "2ea12175-ffa2-4db7-a917-737d849c0865" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:59:59 GMT" + "value": "Tue, 27 Sep 2022 08:04:40 GMT" }, { "key": "Content-Length", - "value": "522" + "value": "618" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"d2d2541f-2feb-490f-bf89-b7407d3078d3\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DNS\",\n \"origin\": 1659671999397808427,\n \"readings\": [\n {\n \"id\": \"3ad48fbe-1e98-4c90-a26e-f83a391c4d8c\",\n \"origin\": 1659671999397808427,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"DNS\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DNSInformation\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"b45c64e4-1e1b-49c5-a1b9-d83f15e280b2\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"DNS\",\n \"origin\": 1664265880674763475,\n \"readings\": [\n {\n \"id\": \"548e6841-0914-4e9c-935e-c58320a998a8\",\n \"origin\": 1664265880674763475,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"DNS\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"DNSInformation\": {\n \"DNSManual\": {\n \"IPv4Address\": \"223.5.5.5\",\n \"Type\": \"IPv4\"\n },\n \"FromDHCP\": false\n }\n }\n }\n ]\n }\n}" } ] }, @@ -1337,19 +1337,19 @@ }, { "key": "X-Correlation-Id", - "value": "e24e3e01-1680-40c6-ae25-3151ff5aafef" + "value": "b71da6d5-4e6b-4557-b6ed-707bb0bd3426" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:59:47 GMT" + "value": "Tue, 27 Sep 2022 09:09:25 GMT" }, { "key": "Content-Length", - "value": "558" + "value": "628" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"78915210-fab0-4018-a8ed-72f793c2cbc7\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkDefaultGateway\",\n \"origin\": 1659671987813255281,\n \"readings\": [\n {\n \"id\": \"c348128d-0c51-4470-a978-b431302906a0\",\n \"origin\": 1659671987813255281,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"NetworkDefaultGateway\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkGateway\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"66991bcb-ff04-4680-af91-aefe449d517c\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"NetworkDefaultGateway\",\n \"origin\": 1664269765488074339,\n \"readings\": [\n {\n \"id\": \"4c8c2ca4-2c0c-49eb-8c8d-e21209813445\",\n \"origin\": 1664269765488074339,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"NetworkDefaultGateway\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"NetworkGateway\": {\n \"IPv4Address\": \"10.0.20.1\",\n \"IPv6Address\": \"::\"\n }\n }\n }\n ]\n }\n}" } ] }, @@ -2585,19 +2585,19 @@ }, { "key": "X-Correlation-Id", - "value": "7358d440-ed28-4f52-ab63-d28fb53d7c51" + "value": "d7a8609b-2810-4069-8d57-4700397af545" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:20 GMT" + "value": "Tue, 27 Sep 2022 09:50:01 GMT" }, { "key": "Content-Length", - "value": "560" + "value": "853" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"1acba723-b1b1-4790-8e80-9d554cacaedc\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurations\",\n \"origin\": 1659659180814799513,\n \"readings\": [\n {\n \"id\": \"8c59a3a8-401b-4e18-8af5-9a98efe7f410\",\n \"origin\": 1659659180814799513,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"MetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"95eae089-a594-4af6-b827-c0cd689034e1\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurations\",\n \"origin\": 1664272201400116525,\n \"readings\": [\n {\n \"id\": \"147f3297-6d21-4c9d-b0f9-241f1ca0528c\",\n \"origin\": 1664272201400116525,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"MetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {\n \"Analytics\": false,\n \"AnalyticsEngineConfiguration\": {},\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 8864,\n \"TTL\": 128\n },\n \"Name\": \"metaData\",\n \"PTZStatus\": {\n \"Position\": false,\n \"Status\": false\n },\n \"SessionTimeout\": \"PT5S\",\n \"Token\": \"MetaDataToken\"\n }\n }\n }\n ]\n }\n}" } ] }, @@ -2635,7 +2635,7 @@ }, "response": [ { - "name": "MetadataConfiguration", + "name": "GetMetadataConfiguration", "originalRequest": { "method": "GET", "header": [], @@ -2675,19 +2675,19 @@ }, { "key": "X-Correlation-Id", - "value": "96f2ec58-26af-410c-8264-5c62c45425eb" + "value": "b8d0916b-d340-40e4-a034-219f6c19ed03" }, { "key": "Date", - "value": "Fri, 23 Sep 2022 23:11:29 GMT" + "value": "Tue, 27 Sep 2022 09:55:13 GMT" }, { "key": "Content-Length", - "value": "557" + "value": "863" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"53480499-ece4-4437-b795-0ff4f57a564a\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfiguration\",\n \"origin\": 1663974689815368367,\n \"readings\": [\n {\n \"id\": \"b6cda316-6a50-4990-8279-e2777be95c79\",\n \"origin\": 1663974689815368367,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-cc32e5000688\",\n \"resourceName\": \"MetadataConfiguration\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configuration\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"239e1b98-d000-4bc5-8bd8-8287817b756f\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfiguration\",\n \"origin\": 1664272513018240840,\n \"readings\": [\n {\n \"id\": \"ab630702-05d5-4c97-98d0-fa23b16e72cc\",\n \"origin\": 1664272513018240840,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"MetadataConfiguration\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configuration\": {\n \"Analytics\": false,\n \"AnalyticsEngineConfiguration\": {},\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 8864,\n \"TTL\": 128\n },\n \"Name\": \"metaData\",\n \"PTZStatus\": {\n \"Position\": false,\n \"Status\": false\n },\n \"SessionTimeout\": \"PT5S\",\n \"Token\": \"MetaDataToken\",\n \"UseCount\": 1\n }\n }\n }\n ]\n }\n}" } ] }, @@ -2821,7 +2821,7 @@ }, "response": [ { - "name": "CompatibleMetadataConfigurations", + "name": "GetCompatibleMetadataConfigurations", "originalRequest": { "method": "GET", "header": [], @@ -2861,19 +2861,19 @@ }, { "key": "X-Correlation-Id", - "value": "362fa295-c750-49a8-a457-a5b5d1486cc6" + "value": "d538b93f-8ae7-4275-922a-f81977817b64" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:28 GMT" + "value": "Tue, 27 Sep 2022 09:52:49 GMT" }, { "key": "Content-Length", - "value": "580" + "value": "886" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"410b5658-82d9-488c-a5c4-c69f0ff6d273\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"CompatibleMetadataConfigurations\",\n \"origin\": 1659659188300470539,\n \"readings\": [\n {\n \"id\": \"86aa4298-c8ee-4c74-afc9-73104bb3cd11\",\n \"origin\": 1659659188300470539,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"CompatibleMetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"37a0130d-d555-44f2-ab9c-6214617eca32\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"CompatibleMetadataConfigurations\",\n \"origin\": 1664272369409217715,\n \"readings\": [\n {\n \"id\": \"86fb41fc-48e7-455f-bb66-78c8f556a21e\",\n \"origin\": 1664272369409217715,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"CompatibleMetadataConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": {\n \"Analytics\": false,\n \"AnalyticsEngineConfiguration\": {},\n \"Multicast\": {\n \"Address\": {\n \"IPv4Address\": \"0.0.0.0\",\n \"Type\": \"IPv4\"\n },\n \"AutoStart\": false,\n \"Port\": 8864,\n \"TTL\": 128\n },\n \"Name\": \"metaData\",\n \"PTZStatus\": {\n \"Position\": false,\n \"Status\": false\n },\n \"SessionTimeout\": \"PT5S\",\n \"Token\": \"MetaDataToken\",\n \"UseCount\": 1\n }\n }\n }\n ]\n }\n}" } ] }, @@ -2911,7 +2911,7 @@ }, "response": [ { - "name": "MetadataConfigurationOptions", + "name": "GetMetadataConfigurationOptions", "originalRequest": { "method": "GET", "header": [], @@ -2951,19 +2951,19 @@ }, { "key": "X-Correlation-Id", - "value": "fcbe3f78-3851-44ac-a75f-238527b90ea7" + "value": "e64dd74a-1a59-44a4-8fe0-f761ef70c663" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 00:26:34 GMT" + "value": "Tue, 27 Sep 2022 09:58:29 GMT" }, { "key": "Content-Length", - "value": "565" + "value": "739" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"f296e8b5-707f-4e66-9388-918821b83a19\",\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurationOptions\",\n \"origin\": 1659659194429862266,\n \"readings\": [\n {\n \"id\": \"f8efa15a-612d-4532-b40b-4e895cecb3bd\",\n \"origin\": 1659659194429862266,\n \"deviceName\": \"TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4\",\n \"resourceName\": \"MetadataConfigurationOptions\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Options\": {}\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"e694b7a9-8a40-49c8-a5ed-a655b4342bb7\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"MetadataConfigurationOptions\",\n \"origin\": 1664272709504749791,\n \"readings\": [\n {\n \"id\": \"9951b817-1f15-4dde-98fc-7fe7b5727008\",\n \"origin\": 1664272709504749791,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"MetadataConfigurationOptions\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Options\": {\n \"PTZStatusFilterOptions\": {\n \"PanTiltPositionSupported\": false,\n \"PanTiltStatusSupported\": false,\n \"ZoomPositionSupported\": false,\n \"ZoomStatusSupported\": false\n }\n }\n }\n }\n ]\n }\n}" } ] }, @@ -6024,7 +6024,7 @@ }, "response": [ { - "name": "GetProfiles - Tapo C200", + "name": "GetMedia2Profiles", "originalRequest": { "method": "GET", "header": [], @@ -6048,8 +6048,8 @@ ] } }, - "status": "Internal Server Error", - "code": 500, + "status": "OK", + "code": 200, "_postman_previewlanguage": "json", "header": [ { @@ -6058,19 +6058,19 @@ }, { "key": "X-Correlation-Id", - "value": "5508bc60-f875-4895-86ae-2ed70fe8b7f0" + "value": "0b6aa429-e24c-4dda-9368-7daa71aee8d0" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:58:10 GMT" + "value": "Thu, 29 Sep 2022 08:35:20 GMT" }, { "key": "Content-Length", - "value": "523" + "value": "728" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"message\": \"request failed, status code: 500, err: {\\\"apiVersion\\\":\\\"v2\\\",\\\"message\\\":\\\"error reading DeviceResourece Media2Profiles for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\\\\u003e failed to execute read command -\\\\u003e invalid request for the function 'GetProfiles' of web service 'Media2'. Onvif error: fault reason: Method 'tr2:GetProfiles' not implemented: method name or namespace not recognized, fault detail: , fault code: SOAP-ENV:Sender \\\",\\\"statusCode\\\":500}\",\n \"statusCode\": 500\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"100ae377-e811-4b88-bd81-f6f67c86cf61\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"Media2Profiles\",\n \"origin\": 1664440520205892135,\n \"readings\": [\n {\n \"id\": \"e6bf94fd-ebde-4b0a-a503-8b23f7a8aebb\",\n \"origin\": 1664440520205892135,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"Media2Profiles\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Profiles\": [\n {\n \"Fixed\": true,\n \"Name\": \"mainStream\",\n \"Token\": \"Profile_1\"\n },\n {\n \"Fixed\": true,\n \"Name\": \"subStream\",\n \"Token\": \"Profile_2\"\n },\n {\n \"Fixed\": true,\n \"Name\": \"thirdStream\",\n \"Token\": \"Profile_3\"\n }\n ]\n }\n }\n ]\n }\n}" } ] }, @@ -6102,7 +6102,7 @@ }, "response": [ { - "name": "GetAnalyticsConfigurations - Tapo C200", + "name": "GetAnalyticsConfigurations", "originalRequest": { "method": "GET", "header": [], @@ -6126,8 +6126,8 @@ ] } }, - "status": "Internal Server Error", - "code": 500, + "status": "OK", + "code": 200, "_postman_previewlanguage": "json", "header": [ { @@ -6136,19 +6136,19 @@ }, { "key": "X-Correlation-Id", - "value": "dc78312b-f01c-49f3-9a48-8ceb07b07a15" + "value": "931912b9-e285-43ec-9d83-764117bfb8f3" }, { "key": "Date", - "value": "Fri, 05 Aug 2022 03:58:29 GMT" + "value": "Thu, 29 Sep 2022 08:35:27 GMT" }, { "key": "Content-Length", - "value": "565" + "value": "1813" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"message\": \"request failed, status code: 500, err: {\\\"apiVersion\\\":\\\"v2\\\",\\\"message\\\":\\\"error reading DeviceResourece GetAnalyticsConfigurations for TP-Link-C200-3fa1fe68-b915-4053-a3e1-1027f5ea88f4 -\\\\u003e failed to execute read command -\\\\u003e invalid request for the function 'GetAnalyticsConfigurations' of web service 'Media2'. Onvif error: fault reason: Method 'tr2:GetAnalyticsConfigurations' not implemented: method name or namespace not recognized, fault detail: , fault code: SOAP-ENV:Sender \\\",\\\"statusCode\\\":500}\",\n \"statusCode\": 500\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"08db4d59-0991-4ace-bb6a-9103c54d38ea\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"GetAnalyticsConfigurations\",\n \"origin\": 1664440527648299236,\n \"readings\": [\n {\n \"id\": \"6e768a1a-a521-47c6-9d13-2337386768d1\",\n \"origin\": 1664440527648299236,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"GetAnalyticsConfigurations\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"Configurations\": [\n {\n \"AnalyticsEngineConfiguration\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"0\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n },\n {\n \"Name\": \"MyLineDetectorModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"50\"\n }\n ]\n },\n \"Type\": \"tt:LineDetectorEngine\"\n },\n {\n \"Name\": \"MyFieldDetectorModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"50\"\n }\n ]\n },\n \"Type\": \"tt:FieldDetectorEngine\"\n },\n {\n \"Name\": \"MyTamperDetecModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Transformation\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"0\"\n }\n ]\n },\n \"Type\": \"hikxsd:TamperEngine\"\n }\n ]\n },\n \"Name\": \"VideoAnalyticsName\",\n \"RuleEngineConfiguration\": {\n \"Rule\": [\n {\n \"Name\": \"MyMotionDetectorRule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"MinCount\",\n \"Value\": \"5\"\n },\n {\n \"Name\": \"AlarmOnDelay\",\n \"Value\": \"1000\"\n },\n {\n \"Name\": \"AlarmOffDelay\",\n \"Value\": \"1000\"\n },\n {\n \"Name\": \"ActiveCells\",\n \"Value\": \"zwA=\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionDetector\"\n },\n {\n \"Name\": \"MyTamperDetectorRule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Field\"\n }\n ]\n },\n \"Type\": \"hikxsd:TamperDetector\"\n }\n ]\n },\n \"Token\": \"VideoAnalyticsToken\",\n \"UseCount\": 3\n }\n ]\n }\n }\n ]\n }\n}" } ] }, @@ -6257,7 +6257,57 @@ }, "description": "List all analytics modules that are supported by the given VideoAnalyticsConfiguration." }, - "response": [] + "response": [ + { + "name": "GetSupportedAnalyticsModules", + "originalRequest": { + "method": "GET", + "header": [], + "url": { + "raw": "http://0.0.0.0:59882/api/v2/device/name/{{EDGEX_DEVICE_NAME}}/GetSupportedAnalyticsModules", + "protocol": "http", + "host": [ + "0", + "0", + "0", + "0" + ], + "port": "59882", + "path": [ + "api", + "v2", + "device", + "name", + "{{EDGEX_DEVICE_NAME}}", + "GetSupportedAnalyticsModules" + ] + } + }, + "status": "OK", + "code": 200, + "_postman_previewlanguage": "json", + "header": [ + { + "key": "Content-Type", + "value": "application/json" + }, + { + "key": "X-Correlation-Id", + "value": "b73f490a-11fe-4b8c-9a8b-7d6cf8fc30da" + }, + { + "key": "Date", + "value": "Thu, 29 Sep 2022 08:35:35 GMT" + }, + { + "key": "Transfer-Encoding", + "value": "chunked" + } + ], + "cookie": [], + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"1caa5b4c-a2d1-403e-90a0-fc7d63a9538c\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"GetSupportedAnalyticsModules\",\n \"origin\": 1664440535746008222,\n \"readings\": [\n {\n \"id\": \"f9f5ddc4-10df-41a1-b50e-c12683683093\",\n \"origin\": 1664440535746008222,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"GetSupportedAnalyticsModules\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"SupportedAnalyticsModules\": {\n \"AnalyticsModuleContentSchemaLocation\": \"http://www.w3.org/2001/XMLSchema\",\n \"AnalyticsModuleDescription\": [\n {\n \"Fixed\": false,\n \"MaxInstances\": 1,\n \"Messages\": {\n \"Data\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"IsMotion\",\n \"Type\": \"xs:boolean\"\n }\n ]\n },\n \"IsProperty\": true,\n \"ParentTopic\": \"tns1:RuleEngine/CellMotionDetector/Motion\",\n \"Source\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"VideoSourceConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"VideoAnalyticsConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"Rule\",\n \"Type\": \"xs:string\"\n }\n ]\n }\n },\n \"Name\": \"tt:CellMotionEngine\",\n \"Parameters\": {\n \"ElementItemDescription\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItemDescription\": [\n {\n \"Name\": \"Sensitivity\",\n \"Type\": \"xs:integer\"\n }\n ]\n }\n },\n {\n \"Fixed\": false,\n \"MaxInstances\": 4,\n \"Messages\": {\n \"Data\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"ObjectId\",\n \"Type\": \"xs:integer\"\n }\n ]\n },\n \"ParentTopic\": \"tns1:RuleEngine/LineDetector/Crossed\",\n \"Source\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"VideoSourceConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"VideoAnalyticsConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"Rule\",\n \"Type\": \"xs:string\"\n }\n ]\n }\n },\n \"Name\": \"tt:LineDetectorEngine\",\n \"Parameters\": {\n \"ElementItemDescription\": [\n {\n \"Name\": \"Transformation\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItemDescription\": [\n {\n \"Name\": \"Sensitivity\",\n \"Type\": \"xs:integer\"\n }\n ]\n }\n },\n {\n \"Fixed\": false,\n \"MaxInstances\": 4,\n \"Messages\": {\n \"Data\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"IsInside\",\n \"Type\": \"xs:boolean\"\n }\n ]\n },\n \"IsProperty\": true,\n \"Key\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"ObjectId\",\n \"Type\": \"xs:integer\"\n }\n ]\n },\n \"ParentTopic\": \"tns1:RuleEngine/FieldDetector/ObjectsInside\",\n \"Source\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"VideoSourceConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"VideoAnalyticsConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"Rule\",\n \"Type\": \"xs:string\"\n }\n ]\n }\n },\n \"Name\": \"tt:FieldDetectorEngine\",\n \"Parameters\": {\n \"ElementItemDescription\": [\n {\n \"Name\": \"Transformation\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItemDescription\": [\n {\n \"Name\": \"Sensitivity\",\n \"Type\": \"xs:integer\"\n }\n ]\n }\n },\n {\n \"Fixed\": false,\n \"MaxInstances\": 1,\n \"Messages\": {\n \"Data\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"IsTamper\",\n \"Type\": \"xs:boolean\"\n }\n ]\n },\n \"IsProperty\": true,\n \"ParentTopic\": \"tns1:RuleEngine/TamperDetector/Tamper\",\n \"Source\": {\n \"SimpleItemDescription\": [\n {\n \"Name\": \"VideoSourceConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"VideoAnalyticsConfigurationToken\",\n \"Type\": \"tt:ReferenceToken\"\n },\n {\n \"Name\": \"Rule\",\n \"Type\": \"xs:string\"\n }\n ]\n }\n },\n \"Name\": \"hikxsd:TamperEngine\",\n \"Parameters\": {\n \"ElementItemDescription\": [\n {\n \"Name\": \"Transformation\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItemDescription\": [\n {\n \"Name\": \"Sensitivity\",\n \"Type\": \"xs:integer\"\n }\n ]\n }\n }\n ]\n }\n }\n }\n ]\n }\n}" + } + ] }, { "name": "GetAnalyticsModules", @@ -6333,19 +6383,19 @@ }, { "key": "X-Correlation-Id", - "value": "e1799801-2c54-4816-b766-2d93caee89c9" + "value": "dce2b5db-eac1-48f8-a3ca-4f296585cd39" }, { "key": "Date", - "value": "Tue, 11 Oct 2022 03:49:35 GMT" + "value": "Thu, 29 Sep 2022 08:35:45 GMT" }, { "key": "Content-Length", - "value": "678" + "value": "1278" } ], "cookie": [], - "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"76f908cd-6b34-477f-9a03-5eea4021b416\",\n \"deviceName\": \"Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"AnalyticsModules\",\n \"origin\": 1665460175164293870,\n \"readings\": [\n {\n \"id\": \"c5f01e17-9b31-43eb-bc55-2417617ef530\",\n \"origin\": 1665460175164293870,\n \"deviceName\": \"Intel-SimCamera-001caffe-48ca-450d-bbd4-cb4f8630ef19\",\n \"resourceName\": \"AnalyticsModules\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"6\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n }\n ]\n }\n }\n ]\n }\n}" + "body": "{\n \"apiVersion\": \"v2\",\n \"statusCode\": 200,\n \"event\": {\n \"apiVersion\": \"v2\",\n \"id\": \"09e8fab7-e43d-4ba3-adeb-6ca2d3a3b255\",\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"profileName\": \"onvif-camera\",\n \"sourceName\": \"AnalyticsModules\",\n \"origin\": 1664440545266300009,\n \"readings\": [\n {\n \"id\": \"c2bf2bfe-915f-48e5-bb4b-5cfdf5d9241a\",\n \"origin\": 1664440545266300009,\n \"deviceName\": \"HIKVISION-DS-2DC4223IW-DE-3bd4c000-b1b9-11b3-8202-4cf5dc64a22c\",\n \"resourceName\": \"AnalyticsModules\",\n \"profileName\": \"onvif-camera\",\n \"valueType\": \"Object\",\n \"value\": \"\",\n \"objectValue\": {\n \"AnalyticsModule\": [\n {\n \"Name\": \"MyCellMotionModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"0\"\n }\n ]\n },\n \"Type\": \"tt:CellMotionEngine\"\n },\n {\n \"Name\": \"MyLineDetectorModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"50\"\n }\n ]\n },\n \"Type\": \"tt:LineDetectorEngine\"\n },\n {\n \"Name\": \"MyFieldDetectorModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Layout\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"50\"\n }\n ]\n },\n \"Type\": \"tt:FieldDetectorEngine\"\n },\n {\n \"Name\": \"MyTamperDetecModule\",\n \"Parameters\": {\n \"ElementItem\": [\n {\n \"Name\": \"Transformation\"\n },\n {\n \"Name\": \"Field\"\n }\n ],\n \"SimpleItem\": [\n {\n \"Name\": \"Sensitivity\",\n \"Value\": \"0\"\n }\n ]\n },\n \"Type\": \"hikxsd:TamperEngine\"\n }\n ]\n }\n }\n ]\n }\n}" } ] },