From 3ab1739c1afc268ae19cb174815366e5eb198a7c Mon Sep 17 00:00:00 2001 From: Patrick Michalina Date: Tue, 29 Jan 2019 23:44:49 -0600 Subject: [PATCH] fix: better input parameter api generation (#11) BREAKING CHANGE: In order to construct valid XML parameter snippets, the generateRequestElements function now requires a key-value object to map out XML nodes. This is mostly hidden from day-to-day library usage --- ...advancedsecurity_.onvifadvancedsecurity.md | 580 ++++----- .../classes/_api_analytics_.onvifanalytics.md | 160 +-- docs/classes/_api_device_.onvifdevice.md | 1084 ++++++++-------- docs/classes/_api_display_.onvifdisplay.md | 124 +- docs/classes/_api_imaging_.onvifimaging.md | 136 +- docs/classes/_api_index_.managedonvifapi.md | 28 +- docs/classes/_api_media_.onvifmedia.md | 952 +++++++------- .../_api_provisioning_.onvifprovisioning.md | 100 +- docs/classes/_api_ptz_.onvifptz.md | 340 ++--- docs/classes/_api_receiver_.onvifreceiver.md | 100 +- .../classes/_api_recording_.onvifrecording.md | 256 ++-- docs/classes/_api_replay_.onvifreplay.md | 52 +- docs/classes/_api_search_.onvifsearch.md | 172 +-- docs/enums/_api_types_.audioencoding.md | 6 +- .../_api_types_.audioencodingmimenames.md | 6 +- docs/enums/_api_types_.autofocusmode.md | 4 +- .../_api_types_.backlightcompensationmode.md | 4 +- docs/enums/_api_types_.capabilitycategory.md | 14 +- docs/enums/_api_types_.defoggingmode.md | 6 +- docs/enums/_api_types_.digitalidlestate.md | 4 +- docs/enums/_api_types_.direction.md | 6 +- docs/enums/_api_types_.discoverymode.md | 4 +- .../_api_types_.dot11authandmangementsuite.md | 8 +- docs/enums/_api_types_.dot11cipher.md | 8 +- docs/enums/_api_types_.dot11securitymode.md | 10 +- docs/enums/_api_types_.dot11signalstrength.md | 12 +- docs/enums/_api_types_.dot11stationmode.md | 6 +- docs/enums/_api_types_.duplex.md | 4 +- docs/enums/_api_types_.dynamicdnstype.md | 6 +- docs/enums/_api_types_.eflipmode.md | 6 +- docs/enums/_api_types_.enabled.md | 4 +- docs/enums/_api_types_.entity.md | 6 +- docs/enums/_api_types_.exposuremode.md | 4 +- docs/enums/_api_types_.exposurepriority.md | 4 +- docs/enums/_api_types_.factorydefaulttype.md | 4 +- docs/enums/_api_types_.h264profile.md | 8 +- .../_api_types_.imagestabilizationmode.md | 8 +- docs/enums/_api_types_.ipaddressfiltertype.md | 4 +- docs/enums/_api_types_.iptype.md | 4 +- .../_api_types_.ipv6dhcpconfiguration.md | 8 +- ..._api_types_.ircutfilterautoboundarytype.md | 8 +- docs/enums/_api_types_.ircutfiltermode.md | 6 +- .../_api_types_.metadatacompressiontype.md | 6 +- docs/enums/_api_types_.modeofoperation.md | 6 +- docs/enums/_api_types_.movestatus.md | 6 +- docs/enums/_api_types_.mpeg4profile.md | 4 +- docs/enums/_api_types_.networkhosttype.md | 6 +- docs/enums/_api_types_.networkprotocoltype.md | 6 +- docs/enums/_api_types_.osdtype.md | 6 +- docs/enums/_api_types_.propertyoperation.md | 6 +- .../_api_types_.ptzpresettourdirection.md | 6 +- .../_api_types_.ptzpresettouroperation.md | 8 +- docs/enums/_api_types_.ptzpresettourstate.md | 8 +- docs/enums/_api_types_.receivermode.md | 8 +- docs/enums/_api_types_.receiverstate.md | 8 +- docs/enums/_api_types_.recordingstatus.md | 12 +- docs/enums/_api_types_.relayidlestate.md | 4 +- docs/enums/_api_types_.relaylogicalstate.md | 4 +- docs/enums/_api_types_.relaymode.md | 4 +- docs/enums/_api_types_.reversemode.md | 8 +- docs/enums/_api_types_.rotatemode.md | 6 +- .../enums/_api_types_.sceneorientationmode.md | 4 +- .../_api_types_.sceneorientationoption.md | 6 +- docs/enums/_api_types_.scopedefinition.md | 4 +- docs/enums/_api_types_.searchstate.md | 8 +- docs/enums/_api_types_.setdatetimetype.md | 4 +- docs/enums/_api_types_.streamtype.md | 4 +- docs/enums/_api_types_.systemlogtype.md | 4 +- .../enums/_api_types_.tonecompensationmode.md | 6 +- docs/enums/_api_types_.tracktype.md | 8 +- docs/enums/_api_types_.transportprotocol.md | 8 +- docs/enums/_api_types_.userlevel.md | 10 +- docs/enums/_api_types_.videoencoding.md | 6 +- .../_api_types_.videoencodingmimenames.md | 8 +- .../_api_types_.videoencodingprofiles.md | 14 +- docs/enums/_api_types_.viewmodes.md | 16 +- docs/enums/_api_types_.whitebalancemode.md | 4 +- docs/enums/_api_types_.widedynamicmode.md | 4 +- docs/enums/_soap_request_.soap_node.md | 6 +- docs/enums/_soap_request_.xmlns.md | 66 +- docs/interfaces/_api_types_.aacdecoptions.md | 4 +- docs/interfaces/_api_types_.absolutefocus.md | 8 +- .../_api_types_.absolutefocusoptions.md | 6 +- .../_api_types_.actionengineeventpayload.md | 18 +- .../_api_types_.activeconnection.md | 4 +- .../_api_types_.analyticscapabilities.md | 6 +- ..._api_types_.analyticsdevicecapabilities.md | 12 +- ...pes_.analyticsdeviceengineconfiguration.md | 6 +- .../interfaces/_api_types_.analyticsengine.md | 2 +- ...api_types_.analyticsengineconfiguration.md | 8 +- .../_api_types_.analyticsenginecontrol.md | 16 +- .../_api_types_.analyticsengineinput.md | 6 +- .../_api_types_.analyticsengineinputinfo.md | 8 +- docs/interfaces/_api_types_.analyticsstate.md | 8 +- .../_api_types_.analyticsstateinformation.md | 4 +- .../_api_types_.arrayoffileprogress.md | 10 +- .../interfaces/_api_types_.audioattributes.md | 10 +- .../_api_types_.audioclasscandidate.md | 4 +- .../_api_types_.audioclassdescriptor.md | 8 +- ...types_.audiodecoderconfigurationoptions.md | 22 +- .../_api_types_.audioencoder2configuration.md | 10 +- ...ypes_.audioencoder2configurationoptions.md | 6 +- .../_api_types_.audioencoderconfiguration.md | 10 +- ..._types_.audioencoderconfigurationoption.md | 6 +- ...types_.audioencoderconfigurationoptions.md | 4 +- .../_api_types_.audiooutputconfiguration.md | 10 +- ..._types_.audiooutputconfigurationoptions.md | 10 +- docs/interfaces/_api_types_.audiosource.md | 2 +- .../_api_types_.audiosourceconfiguration.md | 2 +- ..._types_.audiosourceconfigurationoptions.md | 6 +- .../_api_types_.backlightcompensation.md | 4 +- .../_api_types_.backlightcompensation20.md | 8 +- ...api_types_.backlightcompensationoptions.md | 4 +- ...i_types_.backlightcompensationoptions20.md | 6 +- docs/interfaces/_api_types_.backupfile.md | 4 +- docs/interfaces/_api_types_.binarydata.md | 2 +- docs/interfaces/_api_types_.capabilities.md | 28 +- .../_api_types_.capabilitiesextension.md | 32 +- docs/interfaces/_api_types_.celllayout.md | 2 +- docs/interfaces/_api_types_.certificate.md | 4 +- ..._types_.certificategenerationparameters.md | 28 +- .../_api_types_.certificateinformation.md | 54 +- .../_api_types_.certificatestatus.md | 4 +- .../_api_types_.certificatewithprivatekey.md | 10 +- .../_api_types_.codingcapabilities.md | 10 +- docs/interfaces/_api_types_.coloroptions.md | 4 +- .../interfaces/_api_types_.colorspacerange.md | 8 +- docs/interfaces/_api_types_.config.md | 2 +- .../_api_types_.configdescription.md | 12 +- .../_api_types_.configurationentity.md | 4 +- .../interfaces/_api_types_.continuousfocus.md | 2 +- .../_api_types_.continuousfocusoptions.md | 2 +- docs/interfaces/_api_types_.date.md | 6 +- docs/interfaces/_api_types_.datetime.md | 4 +- docs/interfaces/_api_types_.datetimerange.md | 4 +- docs/interfaces/_api_types_.defogging.md | 12 +- .../_api_types_.defoggingoptions.md | 4 +- .../_api_types_.devicecapabilities.md | 22 +- .../_api_types_.deviceiocapabilities.md | 12 +- .../_api_types_.displaycapabilities.md | 4 +- docs/interfaces/_api_types_.dnsinformation.md | 20 +- .../_api_types_.dot11availablenetworks.md | 28 +- .../_api_types_.dot11capabilities.md | 10 +- .../_api_types_.dot11configuration.md | 10 +- docs/interfaces/_api_types_.dot11pskset.md | 12 +- .../_api_types_.dot11securityconfiguration.md | 18 +- docs/interfaces/_api_types_.dot11status.md | 22 +- .../_api_types_.dot1xconfiguration.md | 28 +- docs/interfaces/_api_types_.durationrange.md | 4 +- .../_api_types_.dynamicdnsinformation.md | 16 +- .../_api_types_.eapmethodconfiguration.md | 16 +- docs/interfaces/_api_types_.eflip.md | 2 +- docs/interfaces/_api_types_.eflipoptions.md | 8 +- .../_api_types_.engineconfiguration.md | 4 +- .../_api_types_.eventcapabilities.md | 8 +- .../_api_types_.eventsubscription.md | 8 +- docs/interfaces/_api_types_.exposure.md | 24 +- docs/interfaces/_api_types_.exposure20.md | 64 +- .../interfaces/_api_types_.exposureoptions.md | 22 +- .../_api_types_.exposureoptions20.md | 42 +- docs/interfaces/_api_types_.fault.md | 16 +- docs/interfaces/_api_types_.fileprogress.md | 4 +- .../interfaces/_api_types_.findeventresult.md | 10 +- .../_api_types_.findeventresultlist.md | 6 +- .../_api_types_.findmetadataresult.md | 6 +- .../_api_types_.findmetadataresultlist.md | 6 +- .../_api_types_.findptzpositionresult.md | 8 +- .../_api_types_.findptzpositionresultlist.md | 6 +- .../_api_types_.findrecordingresultlist.md | 8 +- docs/interfaces/_api_types_.floatlist.md | 6 +- docs/interfaces/_api_types_.floatrange.md | 4 +- .../_api_types_.focusconfiguration.md | 8 +- .../_api_types_.focusconfiguration20.md | 24 +- docs/interfaces/_api_types_.focusmove.md | 12 +- docs/interfaces/_api_types_.focusoptions.md | 10 +- docs/interfaces/_api_types_.focusoptions20.md | 20 +- docs/interfaces/_api_types_.focusstatus.md | 6 +- docs/interfaces/_api_types_.focusstatus20.md | 14 +- docs/interfaces/_api_types_.g711decoptions.md | 4 +- docs/interfaces/_api_types_.g726decoptions.md | 4 +- ...api_types_.getrecordingjobsresponseitem.md | 4 +- .../_api_types_.getrecordingsresponseitem.md | 6 +- .../_api_types_.gettracksresponseitem.md | 4 +- .../_api_types_.gettracksresponselist.md | 4 +- .../_api_types_.h264configuration.md | 4 +- docs/interfaces/_api_types_.h264decoptions.md | 8 +- docs/interfaces/_api_types_.h264options.md | 10 +- docs/interfaces/_api_types_.h264options2.md | 2 +- .../_api_types_.hostnameinformation.md | 12 +- .../_api_types_.imagestabilization.md | 12 +- .../_api_types_.imagestabilizationoptions.md | 10 +- .../_api_types_.imagingcapabilities.md | 2 +- docs/interfaces/_api_types_.imagingoptions.md | 20 +- .../_api_types_.imagingoptions20.md | 44 +- .../_api_types_.imagingoptions20extension.md | 8 +- .../_api_types_.imagingoptions20extension2.md | 8 +- .../_api_types_.imagingoptions20extension3.md | 22 +- .../interfaces/_api_types_.imagingsettings.md | 60 +- .../_api_types_.imagingsettings20.md | 52 +- .../_api_types_.imagingsettingsextension20.md | 10 +- ..._api_types_.imagingsettingsextension202.md | 10 +- ..._api_types_.imagingsettingsextension203.md | 22 +- docs/interfaces/_api_types_.imagingstatus.md | 2 +- .../interfaces/_api_types_.imagingstatus20.md | 10 +- docs/interfaces/_api_types_.intlist.md | 6 +- docs/interfaces/_api_types_.intrange.md | 4 +- .../_api_types_.intrectanglerange.md | 8 +- docs/interfaces/_api_types_.iocapabilities.md | 16 +- .../_api_types_.iocapabilitiesextension.md | 12 +- docs/interfaces/_api_types_.ipaddress.md | 10 +- .../interfaces/_api_types_.ipaddressfilter.md | 14 +- .../_api_types_.ipv4configuration.md | 14 +- .../_api_types_.ipv4networkinterface.md | 4 +- ...s_.ipv4networkinterfacesetconfiguration.md | 16 +- .../_api_types_.ipv6configuration.md | 28 +- .../_api_types_.ipv6networkinterface.md | 6 +- ...s_.ipv6networkinterfacesetconfiguration.md | 20 +- .../_api_types_.ircutfilterautoadjustment.md | 18 +- ...types_.ircutfilterautoadjustmentoptions.md | 16 +- docs/interfaces/_api_types_.itemlist.md | 12 +- .../_api_types_.itemlistdescription.md | 12 +- docs/interfaces/_api_types_.jpegdecoptions.md | 6 +- docs/interfaces/_api_types_.jpegoptions.md | 6 +- docs/interfaces/_api_types_.jpegoptions2.md | 2 +- docs/interfaces/_api_types_.layout.md | 6 +- docs/interfaces/_api_types_.layoutoptions.md | 6 +- .../interfaces/_api_types_.lensdescription.md | 6 +- docs/interfaces/_api_types_.lensprojection.md | 10 +- docs/interfaces/_api_types_.locationentity.md | 24 +- .../interfaces/_api_types_.mediaattributes.md | 12 +- .../_api_types_.mediacapabilities.md | 8 +- .../_api_types_.mediacapabilitiesextension.md | 2 +- docs/interfaces/_api_types_.mediauri.md | 8 +- .../_api_types_.messagedescription.md | 16 +- .../_api_types_.metadataattributes.md | 6 +- .../_api_types_.metadataconfiguration.md | 28 +- ...api_types_.metadataconfigurationoptions.md | 6 +- ..._.metadataconfigurationoptionsextension.md | 10 +- docs/interfaces/_api_types_.metadatafilter.md | 2 +- docs/interfaces/_api_types_.metadatainput.md | 8 +- .../_api_types_.motionexpression.md | 2 +- ...pi_types_.motionexpressionconfiguration.md | 2 +- docs/interfaces/_api_types_.moveoptions.md | 12 +- docs/interfaces/_api_types_.moveoptions20.md | 12 +- .../_api_types_.mpeg4configuration.md | 4 +- .../interfaces/_api_types_.mpeg4decoptions.md | 8 +- docs/interfaces/_api_types_.mpeg4options.md | 10 +- docs/interfaces/_api_types_.mpeg4options2.md | 2 +- .../_api_types_.multicastconfiguration.md | 8 +- .../_api_types_.networkcapabilities.md | 28 +- ...api_types_.networkcapabilitiesextension.md | 10 +- docs/interfaces/_api_types_.networkgateway.md | 8 +- docs/interfaces/_api_types_.networkhost.md | 18 +- .../_api_types_.networkinterface.md | 22 +- ...ypes_.networkinterfaceconnectionsetting.md | 6 +- .../_api_types_.networkinterfaceextension.md | 14 +- .../_api_types_.networkinterfaceinfo.md | 14 +- .../_api_types_.networkinterfacelink.md | 6 +- ...types_.networkinterfacesetconfiguration.md | 28 +- ...tworkinterfacesetconfigurationextension.md | 12 +- .../interfaces/_api_types_.networkprotocol.md | 10 +- .../_api_types_.networkzeroconfiguration.md | 12 +- ...ypes_.networkzeroconfigurationextension.md | 8 +- docs/interfaces/_api_types_.noisereduction.md | 2 +- .../_api_types_.noisereductionoptions.md | 2 +- docs/interfaces/_api_types_.ntpinformation.md | 14 +- docs/interfaces/_api_types_.onvifversion.md | 4 +- docs/interfaces/_api_types_.osdcolor.md | 2 +- .../interfaces/_api_types_.osdcoloroptions.md | 12 +- .../_api_types_.osdconfiguration.md | 18 +- .../_api_types_.osdconfigurationoptions.md | 18 +- .../_api_types_.osdimgconfiguration.md | 6 +- docs/interfaces/_api_types_.osdimgoptions.md | 6 +- .../_api_types_.osdposconfiguration.md | 10 +- .../_api_types_.osdtextconfiguration.md | 38 +- docs/interfaces/_api_types_.osdtextoptions.md | 30 +- .../_api_types_.paneconfiguration.md | 26 +- docs/interfaces/_api_types_.panelayout.md | 4 +- .../_api_types_.panelayoutoptions.md | 6 +- docs/interfaces/_api_types_.pantiltlimits.md | 2 +- docs/interfaces/_api_types_.polygon.md | 2 +- .../_api_types_.polygonconfiguration.md | 2 +- docs/interfaces/_api_types_.polyline.md | 2 +- docs/interfaces/_api_types_.polylinearray.md | 6 +- .../_api_types_.polylinearrayconfiguration.md | 2 +- .../_api_types_.prefixedipv4address.md | 4 +- .../_api_types_.prefixedipv6address.md | 4 +- docs/interfaces/_api_types_.presettour.md | 18 +- docs/interfaces/_api_types_.profile.md | 48 +- .../_api_types_.profilecapabilities.md | 2 +- .../_api_types_.profileextension.md | 16 +- docs/interfaces/_api_types_.profilestatus.md | 8 +- .../_api_types_.ptcontroldirection.md | 16 +- .../_api_types_.ptcontroldirectionoptions.md | 12 +- .../interfaces/_api_types_.ptzcapabilities.md | 2 +- .../_api_types_.ptzconfiguration.md | 64 +- .../_api_types_.ptzconfigurationextension.md | 10 +- .../_api_types_.ptzconfigurationoptions.md | 12 +- docs/interfaces/_api_types_.ptzfilter.md | 4 +- docs/interfaces/_api_types_.ptzmovestatus.md | 8 +- docs/interfaces/_api_types_.ptznode.md | 18 +- .../_api_types_.ptznodeextension.md | 8 +- .../_api_types_.ptzpositionfilter.md | 6 +- docs/interfaces/_api_types_.ptzpreset.md | 8 +- .../_api_types_.ptzpresettouroptions.md | 6 +- .../_api_types_.ptzpresettourpresetdetail.md | 8 +- ...types_.ptzpresettourpresetdetailoptions.md | 22 +- .../_api_types_.ptzpresettourspot.md | 16 +- .../_api_types_.ptzpresettourspotoptions.md | 4 +- ...i_types_.ptzpresettourstartingcondition.md | 20 +- ..._.ptzpresettourstartingconditionoptions.md | 16 +- .../_api_types_.ptzpresettourstatus.md | 10 +- .../_api_types_.ptzpresettoursupported.md | 12 +- docs/interfaces/_api_types_.ptzspaces.md | 36 +- docs/interfaces/_api_types_.ptzspeed.md | 8 +- docs/interfaces/_api_types_.ptzstatus.md | 16 +- .../_api_types_.ptzstatusfilteroptions.md | 20 +- docs/interfaces/_api_types_.ptzvector.md | 8 +- ...pi_types_.realtimestreamingcapabilities.md | 22 +- docs/interfaces/_api_types_.receiver.md | 4 +- .../_api_types_.receivercapabilities.md | 12 +- .../_api_types_.receiverconfiguration.md | 6 +- .../_api_types_.receiverstateinformation.md | 4 +- .../_api_types_.recordingcapabilities.md | 12 +- .../_api_types_.recordingconfiguration.md | 6 +- .../_api_types_.recordinginformation.md | 24 +- .../_api_types_.recordingjobconfiguration.md | 14 +- .../_api_types_.recordingjobsource.md | 18 +- ...api_types_.recordingjobstateinformation.md | 12 +- .../_api_types_.recordingjobstatesource.md | 6 +- .../_api_types_.recordingjobstatetrack.md | 12 +- .../_api_types_.recordingjobstatetracks.md | 4 +- .../_api_types_.recordingjobtrack.md | 4 +- .../_api_types_.recordingsourceinformation.md | 10 +- .../_api_types_.recordingsummary.md | 6 +- docs/interfaces/_api_types_.relativefocus.md | 8 +- .../_api_types_.relativefocusoptions.md | 4 +- .../_api_types_.relativefocusoptions20.md | 6 +- docs/interfaces/_api_types_.relayoutput.md | 2 +- .../_api_types_.relayoutputsettings.md | 6 +- docs/interfaces/_api_types_.remoteuser.md | 10 +- .../_api_types_.replaycapabilities.md | 2 +- .../_api_types_.replayconfiguration.md | 2 +- docs/interfaces/_api_types_.reverse.md | 2 +- docs/interfaces/_api_types_.reverseoptions.md | 8 +- docs/interfaces/_api_types_.rotate.md | 12 +- docs/interfaces/_api_types_.rotateoptions.md | 10 +- .../_api_types_.ruleengineconfiguration.md | 8 +- .../_api_types_.sceneorientation.md | 8 +- docs/interfaces/_api_types_.scope.md | 4 +- .../_api_types_.searchcapabilities.md | 4 +- docs/interfaces/_api_types_.searchscope.md | 16 +- .../_api_types_.securitycapabilities.md | 20 +- ...pi_types_.securitycapabilitiesextension.md | 6 +- ...i_types_.securitycapabilitiesextension2.md | 10 +- .../_api_types_.sourceidentification.md | 8 +- .../interfaces/_api_types_.sourcereference.md | 2 +- .../_api_types_.space1ddescription.md | 4 +- .../_api_types_.space2ddescription.md | 6 +- .../_api_types_.storagereferencepath.md | 12 +- docs/interfaces/_api_types_.streamsetup.md | 4 +- .../_api_types_.supportedanalyticsmodules.md | 14 +- docs/interfaces/_api_types_.supportedrules.md | 14 +- .../_api_types_.supportinformation.md | 10 +- .../_api_types_.systemcapabilities.md | 18 +- ..._api_types_.systemcapabilitiesextension.md | 28 +- docs/interfaces/_api_types_.systemdatetime.md | 22 +- docs/interfaces/_api_types_.systemlog.md | 10 +- docs/interfaces/_api_types_.systemloguri.md | 4 +- .../_api_types_.systemlogurilist.md | 4 +- docs/interfaces/_api_types_.time.md | 6 +- docs/interfaces/_api_types_.timezone.md | 2 +- .../_api_types_.tlsconfiguration.md | 2 +- .../_api_types_.tonecompensation.md | 12 +- .../_api_types_.tonecompensationoptions.md | 4 +- .../interfaces/_api_types_.trackattributes.md | 24 +- .../_api_types_.trackconfiguration.md | 4 +- .../_api_types_.trackinformation.md | 10 +- docs/interfaces/_api_types_.transformation.md | 12 +- docs/interfaces/_api_types_.transport.md | 6 +- docs/interfaces/_api_types_.user.md | 14 +- ..._api_types_.videoanalyticsconfiguration.md | 4 +- .../interfaces/_api_types_.videoattributes.md | 14 +- ...types_.videodecoderconfigurationoptions.md | 22 +- .../_api_types_.videoencoder2configuration.md | 14 +- ...ypes_.videoencoder2configurationoptions.md | 8 +- .../_api_types_.videoencoderconfiguration.md | 22 +- ...types_.videoencoderconfigurationoptions.md | 18 +- ...api_types_.videoencoderoptionsextension.md | 16 +- docs/interfaces/_api_types_.videooutput.md | 22 +- .../_api_types_.videooutputconfiguration.md | 2 +- .../_api_types_.videoratecontrol.md | 6 +- .../_api_types_.videoratecontrol2.md | 4 +- .../interfaces/_api_types_.videoresolution.md | 4 +- .../_api_types_.videoresolution2.md | 4 +- docs/interfaces/_api_types_.videosource.md | 12 +- .../_api_types_.videosourceconfiguration.md | 8 +- ...ypes_.videosourceconfigurationextension.md | 10 +- ...pes_.videosourceconfigurationextension2.md | 12 +- ..._types_.videosourceconfigurationoptions.md | 8 +- ...ideosourceconfigurationoptionsextension.md | 8 +- ...deosourceconfigurationoptionsextension2.md | 6 +- .../_api_types_.videosourceextension.md | 8 +- docs/interfaces/_api_types_.whitebalance.md | 6 +- docs/interfaces/_api_types_.whitebalance20.md | 18 +- .../_api_types_.whitebalanceoptions.md | 6 +- .../_api_types_.whitebalanceoptions20.md | 14 +- .../_api_types_.widedynamicrange.md | 4 +- .../_api_types_.widedynamicrange20.md | 8 +- .../_api_types_.widedynamicrangeoptions.md | 4 +- .../_api_types_.widedynamicrangeoptions20.md | 6 +- docs/interfaces/_api_types_.zoomlimits.md | 2 +- .../_config_interfaces_.ideviceconfig.md | 6 +- .../_config_interfaces_.isystemconfig.md | 10 +- .../_config_interfaces_.itransportpayoad.md | 6 +- .../_config_interfaces_.iusercredentials.md | 4 +- .../_manage_device_.ideviceinitconfig.md | 6 +- .../_manage_device_.imanageddevice.md | 2 +- docs/interfaces/_soap_auth_.idigestbag.md | 8 +- .../_soap_auth_.iusercredentials.md | 4 +- .../_soap_request_.iresultstructure.md | 40 + .../_soap_request_.itransportpayloadxml.md | 48 - .../_soap_request_.ixmlcontainer.md | 38 + docs/modules/_api_types_.md | 56 +- docs/modules/_browser_.md | 2 +- docs/modules/_config_browser_.md | 14 +- docs/modules/_config_interfaces_.md | 8 +- docs/modules/_config_node_.md | 16 +- docs/modules/_config_universal_.md | 12 +- docs/modules/_manage_device_.md | 2 +- docs/modules/_node_.md | 22 +- docs/modules/_soap_auth_.md | 18 +- docs/modules/_soap_request_.md | 59 +- scripts/api/ast.ts | 7 +- scripts/api/gen-api.ts | 104 -- scripts/api/parse-onvif-xsd.ts | 3 +- src/api/advancedsecurity.ts | 96 +- src/api/analytics.ts | 26 +- src/api/device.ts | 180 +-- src/api/display.ts | 20 +- src/api/imaging.ts | 22 +- src/api/media.ts | 158 +-- src/api/provisioning.ts | 16 +- src/api/ptz.ts | 56 +- src/api/receiver.ts | 16 +- src/api/recording.ts | 42 +- src/api/replay.ts | 8 +- src/api/search.ts | 28 +- src/api/types.ts | 1102 ++++++++--------- src/soap/request.ts | 34 +- 450 files changed, 5225 insertions(+), 5292 deletions(-) create mode 100644 docs/interfaces/_soap_request_.iresultstructure.md delete mode 100644 docs/interfaces/_soap_request_.itransportpayloadxml.md create mode 100644 docs/interfaces/_soap_request_.ixmlcontainer.md delete mode 100644 scripts/api/gen-api.ts diff --git a/docs/classes/_api_advancedsecurity_.onvifadvancedsecurity.md b/docs/classes/_api_advancedsecurity_.onvifadvancedsecurity.md index 89d87ad..41613c9 100644 --- a/docs/classes/_api_advancedsecurity_.onvifadvancedsecurity.md +++ b/docs/classes/_api_advancedsecurity_.onvifadvancedsecurity.md @@ -125,7 +125,7 @@ ⊕ **new ONVIFAdvancedSecurity**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFAdvancedSecurity](_api_advancedsecurity_.onvifadvancedsecurity.md) -*Defined in [api/advancedsecurity.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L5)* +*Defined in [api/advancedsecurity.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L5)* **Parameters:** @@ -145,7 +145,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/advancedsecurity.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L6)* +*Defined in [api/advancedsecurity.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L6)* ___ @@ -155,9 +155,9 @@ ___ ### AddCertPathValidationPolicyAssignment -▸ **AddCertPathValidationPolicyAssignment**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddCertPathValidationPolicyAssignment**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1234](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1234)* +*Defined in [api/advancedsecurity.ts:1234](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1234)* ``` This operation assigns a certification path validation policy to the TLS server on the device. The TLS server shall enforce the policy when authenticating TLS clients and consider a client authentic if and only if the algorithm returns valid. @@ -165,44 +165,44 @@ ___ A TLS server may use different certification path validation policies to authenticate clients. Therefore more than one certification path validation policy may be assigned to the TLS server. If the maximum number of certification path validation policies that may be assigned to the TLS server simultaneously is reached, the device shall produce a MaximumNumberOfTLSCertPathValidationPoliciesReached fault and shall not assign the requested certification path validation policy to the TLS server. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddDot1XConfiguration -▸ **AddDot1XConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddDot1XConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1273](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1273)* +*Defined in [api/advancedsecurity.ts:1273](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1273)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddServerCertificateAssignment -▸ **AddServerCertificateAssignment**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddServerCertificateAssignment**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1135](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1135)* +*Defined in [api/advancedsecurity.ts:1135](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1135)* This operation assigns a key pair and certificate along with a certification path (certificate chain) to the TLS server on the device. The TLS server shall use this information for key exchange during the TLS handshake, particularly for constructing server certificate messages as specified in RFC 4346 and RFC 2246. Certification paths are identified by their certification path IDs in the keystore. The first certificate in the certification path must be the TLS server certificate. Since each certificate has exactly one associated key pair, a reference to the key pair that is associated with the server certificate is not supplied explicitly. Devices shall obtain the private key or results of operations under the private key by suitable internal interaction with the keystore. If a device chooses to perform a TLS key exchange based on the supplied certification path, it shall use the key pair that is associated with the server certificate for key exchange and transmit the certification path to TLS clients as-is, i.e., the device shall not check conformance of the certification path to RFC 4346 norRFC 2246. In order to use the server certificate during the TLS handshake, the corresponding private key is required. Therefore, if the key pair that is associated with the server certificate, i.e., the first certificate in the certification path, does not have an associated private key, the NoPrivateKey fault is produced and the certification path is not associated to the TLS server. A TLS server may present different certification paths to different clients during the TLS handshake instead of presenting the same certification path to all clients. Therefore more than one certification path may be assigned to the TLS server. If the maximum number of certification paths that may be assigned to the TLS server simultaneously is reached, the device shall generate a MaximumNumberOfCertificationPathsReached fault and the requested certification path shall not be assigned to the TLS server. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateCertPathValidationPolicy -▸ **CreateCertPathValidationPolicy**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateCertPathValidationPolicy**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1080](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1080)* +*Defined in [api/advancedsecurity.ts:1080](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1080)* ``` This operation creates a certification path validation policy. @@ -213,31 +213,31 @@ ___ If the device cannot process the supplied certification path validation parameters, the device shall produce a CertPathValidationParameters fault and shall not create a certification path validation policy. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateCertificationPath -▸ **CreateCertificationPath**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateCertificationPath**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:955](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L955)* +*Defined in [api/advancedsecurity.ts:955](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L955)* This operation creates a sequence of certificates that may be used, e.g., for certification path validation or for TLS server authentication. Certification paths are uniquely identified using certification path IDs. Certificates are uniquely identified using certificate IDs. A certification path contains a sequence of certificate IDs. If there is a certificate ID in the sequence of supplied certificate IDs for which no certificate exists in the device’s keystore, the corresponding fault shall be produced and no certification path shall be created. The signature of each certificate in the certification path except for the last one must be verifiable with the public key contained in the next certificate in the path. If there is a certificate ID in the request other than the last ID for which the corresponding certificate cannot be verified with the public key in the certificate identified by the next certificate ID, an InvalidCertificateChain fault shall be produced and no certification path shall be created. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreatePKCS10CSR -▸ **CreatePKCS10CSR**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreatePKCS10CSR**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:842](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L842)* +*Defined in [api/advancedsecurity.ts:842](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L842)* This operation generates a DER-encoded PKCS#10 v1.7 certification request (sometimes also called certificate signing request or CSR) as specified in RFC 2986 for a public key on the device. The key pair that contains the public key for which a certification request shall be produced is specified by its key ID. If no key is stored under the requested KeyID or the key specified by the requested KeyID is not an asymmetric key pair, an invalid key ID fault shall be produced and no CSR shall be generated. @@ -245,29 +245,29 @@ A device that supports this command shall as minimum support the sha-1WithRSAEnc If the public key identified by the requested Key ID is an invalid input to the specified signature algorithm, a KeySignatureAlgorithmMismatch fault shall be produced and no CSR shall be generated. If the key pair does not have status ok, a device shall produce an InvalidKeyStatus fault and no CSR shall be generated. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateRSAKeyPair -▸ **CreateRSAKeyPair**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateRSAKeyPair**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:739](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L739)* +*Defined in [api/advancedsecurity.ts:739](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L739)* This operation triggers the asynchronous generation of an RSA key pair of a particular key length (specified as the number of bits) as specified in \[RFC 3447\], with a suitable key generation mechanism on the device. Keys, especially RSA key pairs, are uniquely identified using key IDs. If the device does not have not enough storage capacity for storing the key pair to be created, the maximum number of keys reached fault shall be produced and no key pair shall be generated. Otherwise, the operation generates a keyID for the new key and associates the generating status to it. Immediately after key generation has started, the device shall return the keyID to the client and continue to generate the key pair. The client may query the device with the GetKeyStatus operation whether the generation has finished. The client may also subscribe to Key Status events to be notified about key status changes. The device also returns a best-effort estimate of how much time it requires to create the key pair. A client may use this information as an indication how long to wait before querying the device whether key generation is completed. After the key has been successfully created, the device shall assign it the ok status. If the key generation fails, the device shall assign the key the corrupt status. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateSelfSignedCertificate -▸ **CreateSelfSignedCertificate**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateSelfSignedCertificate**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:865](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L865)* +*Defined in [api/advancedsecurity.ts:865](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L865)* This operation generates for a public key on the device a self-signed X.509 certificate that complies to RFC 5280. The X509Version parameter specifies the version of X.509 that the generated certificate shall comply to. A device that supports this command shall support the generation of X.509v3 certificates as specified in RFC 5280 and may additionally be able to handle other X.509 certificate formats as indicated by the X.509Versions capability. The key pair that contains the public key for which a self-signed certificate shall be produced is specified by its key pair ID. The subject parameter describes the entity that the public key belongs to. If the key pair does not have status ok, a device shall produce an InvalidKeyStatus fault and no certificate shall be generated. @@ -275,16 +275,16 @@ The signature algorithm parameter determines which signature algorithm shall be Certificates are uniquely identified using certificate IDs. If the command was successful, the device generates a new ID for the generated certificate and returns this ID. If the device does not have not enough storage capacity for storing the certificate to be created, the maximum number of certificates reached fault shall be produced and no certificate shall be generated. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteCRL -▸ **DeleteCRL**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteCRL**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1066](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1066)* +*Defined in [api/advancedsecurity.ts:1066](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1066)* ``` This operation deletes a certificate revocation list (CRL) from the keystore on the device. @@ -293,16 +293,16 @@ ___ After a CRL has been successfully deleted, a device may assign its former ID to other CRLs. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteCertPathValidationPolicy -▸ **DeleteCertPathValidationPolicy**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteCertPathValidationPolicy**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1112](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1112)* +*Defined in [api/advancedsecurity.ts:1112](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1112)* ``` This operation deletes a certification path validation policy from the keystore on the device. @@ -311,180 +311,180 @@ ___ After the certification path validation policy has been deleted, the device may assign its former ID to other certification path validation policies. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteCertificate -▸ **DeleteCertificate**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteCertificate**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:938](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L938)* +*Defined in [api/advancedsecurity.ts:938](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L938)* This operation deletes a certificate from the device’s keystore. The operation shall not delete the public key that is contained in the certificate from the keystore. Certificates are uniquely identified using certificate IDs. If no certificate is stored under the requested certificate ID in the keystore, an InvalidArgVal fault is produced. If there is a certificate under the requested certificate ID stored in the keystore and the certificate could not be deleted, a CertificateDeletion fault is produced. If a reference exists for the specified certificate, the certificate shall not be deleted and the corresponding fault shall be produced. After a certificate has been successfully deleted, the device may assign its former ID to other certificates. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteCertificationPath -▸ **DeleteCertificationPath**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteCertificationPath**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:993](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L993)* +*Defined in [api/advancedsecurity.ts:993](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L993)* This operation deletes a certification path from the device’s keystore. This operation shall not delete the certificates that are referenced by the certification path. Certification paths are uniquely identified using certification path IDs. If no certification path is stored under the requested certification path ID in the keystore, an InvalidArgVal fault is produced. If there is a certification path under the requested certification path ID stored in the keystore and the certification path could not be deleted, a CertificationPathDeletion fault is produced. If a reference exists for the specified certification path, the certification path shall not be deleted and the corresponding fault shall be produced. After a certification path is successfully deleted, the device may assign its former ID to other certification paths. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteDot1XConfiguration -▸ **DeleteDot1XConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteDot1XConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1300](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1300)* +*Defined in [api/advancedsecurity.ts:1300](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1300)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteKey -▸ **DeleteKey**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteKey**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:822](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L822)* +*Defined in [api/advancedsecurity.ts:822](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L822)* This operation deletes a key from the device’s keystore. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore, a device shall produce an InvalidArgVal fault. If a reference exists for the specified key, a device shall produce the corresponding fault and shall not delete the key. If there is a key under the requested key ID stored in the keystore and the key could not be deleted, a device shall produce a KeyDeletion fault. If the key has the status generating, a device shall abort the generation of the key and delete from the keystore all data generated for this key. After a key is successfully deleted, the device may assign its former ID to other keys. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteNetworkInterfaceDot1XConfiguration -▸ **DeleteNetworkInterfaceDot1XConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteNetworkInterfaceDot1XConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1327](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1327)* +*Defined in [api/advancedsecurity.ts:1327](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1327)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeletePassphrase -▸ **DeletePassphrase**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeletePassphrase**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1022](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1022)* +*Defined in [api/advancedsecurity.ts:1022](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1022)* ``` This operation deletes a passphrase from the keystore of the device. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllCRLs -▸ **GetAllCRLs**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllCRLs**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1054](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1054)* +*Defined in [api/advancedsecurity.ts:1054](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1054)* ``` This operation returns all certificate revocation lists (CRLs) that are stored in the keystore on the device. If no certificate revocation list is stored in the device’s keystore, an empty list is returned. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllCertPathValidationPolicies -▸ **GetAllCertPathValidationPolicies**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllCertPathValidationPolicies**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1100](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1100)* +*Defined in [api/advancedsecurity.ts:1100](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1100)* ``` This operation returns all certification path validation policies that are stored in the keystore on the device. If no certification path validation policy is stored in the device’s keystore, an empty list is returned. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllCertificates -▸ **GetAllCertificates**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllCertificates**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:924](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L924)* +*Defined in [api/advancedsecurity.ts:924](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L924)* This operation returns the IDs of all certificates that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which certificates are present on the device. If no certificate is stored in the device’s keystore, an empty list is returned. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllCertificationPaths -▸ **GetAllCertificationPaths**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllCertificationPaths**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:977](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L977)* +*Defined in [api/advancedsecurity.ts:977](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L977)* This operation returns the IDs of all certification paths that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which certificates are present on the device. If no certification path is stored on the device, an empty list is returned. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllDot1XConfigurations -▸ **GetAllDot1XConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllDot1XConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1282](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1282)* +*Defined in [api/advancedsecurity.ts:1282](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1282)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllKeys -▸ **GetAllKeys**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllKeys**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:808](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L808)* +*Defined in [api/advancedsecurity.ts:808](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L808)* This operation returns information about all keys that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which keys are present on the device. If no key is stored on the device, an empty list is returned. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAllPassphrases -▸ **GetAllPassphrases**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAllPassphrases**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1013](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1013)* +*Defined in [api/advancedsecurity.ts:1013](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1013)* ``` This operation returns information about all passphrases that are stored in the keystore of the device. @@ -492,224 +492,224 @@ ___ If no passphrase is stored on the device, the device shall return an empty list. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAssignedCertPathValidationPolicies -▸ **GetAssignedCertPathValidationPolicies**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAssignedCertPathValidationPolicies**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1264](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1264)* +*Defined in [api/advancedsecurity.ts:1264](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1264)* ``` This operation returns the IDs of all certification path validation policies that are assigned to the TLS server on the device. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAssignedServerCertificates -▸ **GetAssignedServerCertificates**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAssignedServerCertificates**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1202](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1202)* +*Defined in [api/advancedsecurity.ts:1202](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1202)* This operation returns the IDs of all key pairs and certificates (including certification paths) that are assigned to the TLS server on the device. This operation may be used, e.g., if a client lost track of the certification path assignments on the device. If no certification path is assigned to the TLS server, an empty list is returned. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCRL -▸ **GetCRL**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCRL**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1044](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1044)* +*Defined in [api/advancedsecurity.ts:1044](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1044)* ``` This operation returns a specific certificate revocation list (CRL) from the keystore on the device. Certification revocation lists are uniquely identified using CRLIDs. If no CRL is stored under the requested CRLID, the device shall produce a CRLID fault. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCertPathValidationPolicy -▸ **GetCertPathValidationPolicy**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCertPathValidationPolicy**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1090](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1090)* +*Defined in [api/advancedsecurity.ts:1090](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1090)* ``` This operation returns a certification path validation policy from the keystore on the device. Certification path validation policies are uniquely identified using certification path validation policy IDs. If no certification path validation policy is stored under the requested certification path validation policy ID, the device shall produce a CertPathValidationPolicyID fault. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCertificate -▸ **GetCertificate**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCertificate**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:913](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L913)* +*Defined in [api/advancedsecurity.ts:913](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L913)* This operation returns a specific certificate from the device’s keystore. Certificates are uniquely identified using certificate IDs. If no certificate is stored under the requested certificate ID in the keystore, an InvalidArgVal fault is produced. It shall be noted that this command does not return the private key that is associated to the public key in the certificate. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCertificationPath -▸ **GetCertificationPath**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCertificationPath**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:966](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L966)* +*Defined in [api/advancedsecurity.ts:966](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L966)* This operation returns a specific certification path from the device’s keystore. Certification paths are uniquely identified using certification path IDs. If no certification path is stored under the requested ID in the keystore, an InvalidArgVal fault is produced. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetClientAuthenticationRequired -▸ **GetClientAuthenticationRequired**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetClientAuthenticationRequired**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1223](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1223)* +*Defined in [api/advancedsecurity.ts:1223](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1223)* ``` This operation returns whether TLS client authentication is active. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDot1XConfiguration -▸ **GetDot1XConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDot1XConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1291](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1291)* +*Defined in [api/advancedsecurity.ts:1291](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1291)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetEnabledTLSVersions -▸ **GetEnabledTLSVersions**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetEnabledTLSVersions**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1191](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1191)* +*Defined in [api/advancedsecurity.ts:1191](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1191)* This operation retrieves the version(s) of TLS which are currently enabled on the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetKeyStatus -▸ **GetKeyStatus**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetKeyStatus**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:785](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L785)* +*Defined in [api/advancedsecurity.ts:785](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L785)* This operation returns the status of a key. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore, an InvalidKeyID fault is produced. Otherwise, the status of the key is returned. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNetworkInterfaceDot1XConfiguration -▸ **GetNetworkInterfaceDot1XConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNetworkInterfaceDot1XConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1318](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1318)* +*Defined in [api/advancedsecurity.ts:1318](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1318)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPrivateKeyStatus -▸ **GetPrivateKeyStatus**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPrivateKeyStatus**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:797](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L797)* +*Defined in [api/advancedsecurity.ts:797](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L797)* This operation returns whether a key pair contains a private key. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore or the key identified by the requested key ID does not identify a key pair, the device shall produce an InvalidKeyID fault. Otherwise, this operation returns true if the key pair identified by the key ID contains a private key, and false otherwise. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:721](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L721)* +*Defined in [api/advancedsecurity.ts:721](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L721)* Returns the capabilities of the security configuraiton service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveCertPathValidationPolicyAssignment -▸ **RemoveCertPathValidationPolicyAssignment**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveCertPathValidationPolicyAssignment**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1244](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1244)* +*Defined in [api/advancedsecurity.ts:1244](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1244)* ``` This operation removes a certification path validation policy assignment from the TLS server on the device. If the certification path validation policy identified by the requested CertPathValidationPolicyID is not associated to the TLS server, the device shall produce a CertPathValidationPolicy fault. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveServerCertificateAssignment -▸ **RemoveServerCertificateAssignment**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveServerCertificateAssignment**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1145](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1145)* +*Defined in [api/advancedsecurity.ts:1145](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1145)* This operation removes a key pair and certificate assignment (including certification path) to the TLS server on the device. Certification paths are identified using certification path IDs. If the supplied certification path ID is not associated to the TLS server, an InvalidArgVal fault is produced. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ReplaceCertPathValidationPolicyAssignment -▸ **ReplaceCertPathValidationPolicyAssignment**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ReplaceCertPathValidationPolicyAssignment**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1255](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1255)* +*Defined in [api/advancedsecurity.ts:1255](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1255)* ``` This operation replaces a certification path validation policy assignment to the TLS server on the device with another certification path validation policy assignment. @@ -717,16 +717,16 @@ ___ If no certification path validation policy exists under the requested NewCertPathValidationPolicyID in the device’s keystore, the device shall produce a NewCertPathValidationPolicyID fault and shall not remove the association of the old certification path validation policy to the TLS server. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ReplaceServerCertificateAssignment -▸ **ReplaceServerCertificateAssignment**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ReplaceServerCertificateAssignment**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1169](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1169)* +*Defined in [api/advancedsecurity.ts:1169](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1169)* This operation replaces an existing key pair and certificate assignment to the TLS server on the device by a new key pair and certificate assignment (including certification paths). @@ -734,16 +734,16 @@ After the replacement, the TLS server shall use the new certificate and certific Certification paths are identified using certification path IDs. If the supplied old certification path ID is not associated to the TLS server, or no certification path exists under the new certification path ID, the corresponding InvalidArgVal faults are produced and the associations are unchanged. The first certificate in the new certification path must be the TLS server certificate. Since each certificate has exactly one associated key pair, a reference to the key pair that is associated with the new server certificate is not supplied explicitly. Devices shall obtain the private key or results of operations under the private key by suitable internal interaction with the keystore. If a device chooses to perform a TLS key exchange based on the new certification path, it shall use the key pair that is associated with the server certificate for key exchange and transmit the certification path to TLS clients as-is, i.e., the device shall not check conformance of the certification path to RFC 4346 norRFC 2246. In order to use the server certificate during the TLS handshake, the corresponding private key is required. Therefore, if the key pair that is associated with the server certificate, i.e., the first certificate in the certification path, does not have an associated private key, the NoPrivateKey fault is produced and the certification path is not associated to the TLS server. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetClientAuthenticationRequired -▸ **SetClientAuthenticationRequired**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetClientAuthenticationRequired**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1214](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1214)* +*Defined in [api/advancedsecurity.ts:1214](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1214)* ``` This operation activates or deactivates TLS client authentication for the TLS server on the device. @@ -752,42 +752,42 @@ ___ The device shall execute this command regardless of the TLS enabled/disabled state configured in the ONVIF Device Management Service. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetEnabledTLSVersions -▸ **SetEnabledTLSVersions**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetEnabledTLSVersions**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1182](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1182)* +*Defined in [api/advancedsecurity.ts:1182](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1182)* This operation sets the version(s) of TLS which the device shall use. Valid values are taken from the TLSServerSupported capability. A client initiates a TLS session by sending a ClientHello with the hightest TLS version it supports. This suggests to the server that the client can accept any TLS version up to and including that version. The server then chooses the TLS version to use. This is generally the highest TLS version the server supports that is within the range of the client. For example, if a ClientHello indicates TLS version 1.1, the server can proceed with TLS 1.0 or TLS 1.1. In the event that an ONVIF installation wishes to disable certain version(s) of TLS, it may do so with this operation. For example, to disable TLS 1.0 on a device signaling support for TLS versions 1.0, 1.1, and 1.2, the enabled version list may be set to "1.1 1.2", omitting 1.0. If a client then attempts to connect with a ClientHello containing TLS 1.0, the server shall send a "protocol\_version" alert message and close the connection. This handshake indicates to the client that TLS 1.0 is not supported by the server. The client must try again with a higher TLS version suggestion. An empty list is not permitted. Disabling all versions of TLS is not the intent of this operation. See AddServerCertificateAssignment and RemoveServerCertificateAssignment. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetNetworkInterfaceDot1XConfiguration -▸ **SetNetworkInterfaceDot1XConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetNetworkInterfaceDot1XConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1309](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1309)* +*Defined in [api/advancedsecurity.ts:1309](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1309)* (to be written) -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### UploadCRL -▸ **UploadCRL**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **UploadCRL**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1034](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1034)* +*Defined in [api/advancedsecurity.ts:1034](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1034)* ``` This operation uploads a certificate revocation list (CRL) as specified in [RFC 5280] to the keystore on the device. @@ -796,16 +796,16 @@ ___ If the device does not support the signature algorithm that was used to sign the supplied CRL, the device shall produce an UnsupportedSignatureAlgorithm fault and shall not store the supplied CRL. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### UploadCertificate -▸ **UploadCertificate**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **UploadCertificate**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:902](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L902)* +*Defined in [api/advancedsecurity.ts:902](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L902)* This operation uploads an X.509 certificate as specified by \[RFC 5280\] in DER encoding and the public key in the certificate to a device’s keystore. A device that supports this command shall be able to handle X.509v3 certificates as specified in RFC 5280 and may additionally be able to handle other X.509 certificate formats as indicated by the X.509Versions capability. A device that supports this command shall support sha1-WithRSAEncryption as certificate signature algorithm. @@ -815,16 +815,16 @@ The uploaded certificate has to be linked to a key pair in the keystore. If no p If the device does not have not enough storage capacity for storing the certificate to be uploaded, the maximum number of certificates reached fault shall be produced and no certificate shall be uploaded. If the device does not have not enough storage capacity for storing the key pair that eventually has to be created, the device shall generate a maximum number of keys reached fault. Furthermore the device shall not generate a key pair and no certificate shall be stored. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### UploadCertificateWithPrivateKeyInPKCS12 -▸ **UploadCertificateWithPrivateKeyInPKCS12**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **UploadCertificateWithPrivateKeyInPKCS12**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:774](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L774)* +*Defined in [api/advancedsecurity.ts:774](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L774)* ``` This operation uploads a certification path consisting of X.509 certificates as specified by [RFC 5280] in DER encoding along with a private key to a device’s keystore. @@ -843,16 +843,16 @@ ___ If an EncryptionPassphraseID is supplied, but a KeyBag is provided instead of a PKCS8ShroudedKeyBag, the device shall ignore the supplied EncryptionPassphraseID when processing the KeyBag. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### UploadKeyPairInPKCS8 -▸ **UploadKeyPairInPKCS8**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **UploadKeyPairInPKCS8**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:752](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L752)* +*Defined in [api/advancedsecurity.ts:752](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L752)* ``` This operation uploads a key pair in a PKCS#8 data structure as specified in [RFC 5958, RFC 5959]. @@ -862,31 +862,31 @@ ___ OneAsymmetricKey ASN.1 structure which contains both the private key and the corresponding public key. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### UploadPassphrase -▸ **UploadPassphrase**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **UploadPassphrase**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/advancedsecurity.ts:1002](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L1002)* +*Defined in [api/advancedsecurity.ts:1002](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L1002)* ``` This operation uploads a passphrase to the keystore of the device. ``` -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` AddCertPathValidationPolicyAssignment -▸ **AddCertPathValidationPolicyAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddCertPathValidationPolicyAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:599](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L599)* +*Defined in [api/advancedsecurity.ts:599](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L599)* ``` This operation assigns a certification path validation policy to the TLS server on the device. The TLS server shall enforce the policy when authenticating TLS clients and consider a client authentic if and only if the algorithm returns valid. @@ -894,44 +894,44 @@ ___ A TLS server may use different certification path validation policies to authenticate clients. Therefore more than one certification path validation policy may be assigned to the TLS server. If the maximum number of certification path validation policies that may be assigned to the TLS server simultaneously is reached, the device shall produce a MaximumNumberOfTLSCertPathValidationPoliciesReached fault and shall not assign the requested certification path validation policy to the TLS server. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddDot1XConfiguration -▸ **AddDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:646](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L646)* +*Defined in [api/advancedsecurity.ts:646](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L646)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddServerCertificateAssignment -▸ **AddServerCertificateAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddServerCertificateAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:484](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L484)* +*Defined in [api/advancedsecurity.ts:484](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L484)* This operation assigns a key pair and certificate along with a certification path (certificate chain) to the TLS server on the device. The TLS server shall use this information for key exchange during the TLS handshake, particularly for constructing server certificate messages as specified in RFC 4346 and RFC 2246. Certification paths are identified by their certification path IDs in the keystore. The first certificate in the certification path must be the TLS server certificate. Since each certificate has exactly one associated key pair, a reference to the key pair that is associated with the server certificate is not supplied explicitly. Devices shall obtain the private key or results of operations under the private key by suitable internal interaction with the keystore. If a device chooses to perform a TLS key exchange based on the supplied certification path, it shall use the key pair that is associated with the server certificate for key exchange and transmit the certification path to TLS clients as-is, i.e., the device shall not check conformance of the certification path to RFC 4346 norRFC 2246. In order to use the server certificate during the TLS handshake, the corresponding private key is required. Therefore, if the key pair that is associated with the server certificate, i.e., the first certificate in the certification path, does not have an associated private key, the NoPrivateKey fault is produced and the certification path is not associated to the TLS server. A TLS server may present different certification paths to different clients during the TLS handshake instead of presenting the same certification path to all clients. Therefore more than one certification path may be assigned to the TLS server. If the maximum number of certification paths that may be assigned to the TLS server simultaneously is reached, the device shall generate a MaximumNumberOfCertificationPathsReached fault and the requested certification path shall not be assigned to the TLS server. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateCertPathValidationPolicy -▸ **CreateCertPathValidationPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateCertPathValidationPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:421](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L421)* +*Defined in [api/advancedsecurity.ts:421](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L421)* ``` This operation creates a certification path validation policy. @@ -942,31 +942,31 @@ ___ If the device cannot process the supplied certification path validation parameters, the device shall produce a CertPathValidationParameters fault and shall not create a certification path validation policy. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateCertificationPath -▸ **CreateCertificationPath**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateCertificationPath**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:274](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L274)* +*Defined in [api/advancedsecurity.ts:274](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L274)* This operation creates a sequence of certificates that may be used, e.g., for certification path validation or for TLS server authentication. Certification paths are uniquely identified using certification path IDs. Certificates are uniquely identified using certificate IDs. A certification path contains a sequence of certificate IDs. If there is a certificate ID in the sequence of supplied certificate IDs for which no certificate exists in the device’s keystore, the corresponding fault shall be produced and no certification path shall be created. The signature of each certificate in the certification path except for the last one must be verifiable with the public key contained in the next certificate in the path. If there is a certificate ID in the request other than the last ID for which the corresponding certificate cannot be verified with the public key in the certificate identified by the next certificate ID, an InvalidCertificateChain fault shall be produced and no certification path shall be created. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreatePKCS10CSR -▸ **CreatePKCS10CSR**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreatePKCS10CSR**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:149](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L149)* +*Defined in [api/advancedsecurity.ts:149](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L149)* This operation generates a DER-encoded PKCS#10 v1.7 certification request (sometimes also called certificate signing request or CSR) as specified in RFC 2986 for a public key on the device. The key pair that contains the public key for which a certification request shall be produced is specified by its key ID. If no key is stored under the requested KeyID or the key specified by the requested KeyID is not an asymmetric key pair, an invalid key ID fault shall be produced and no CSR shall be generated. @@ -974,29 +974,29 @@ A device that supports this command shall as minimum support the sha-1WithRSAEnc If the public key identified by the requested Key ID is an invalid input to the specified signature algorithm, a KeySignatureAlgorithmMismatch fault shall be produced and no CSR shall be generated. If the key pair does not have status ok, a device shall produce an InvalidKeyStatus fault and no CSR shall be generated. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateRSAKeyPair -▸ **CreateRSAKeyPair**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateRSAKeyPair**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:32](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L32)* +*Defined in [api/advancedsecurity.ts:32](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L32)* This operation triggers the asynchronous generation of an RSA key pair of a particular key length (specified as the number of bits) as specified in \[RFC 3447\], with a suitable key generation mechanism on the device. Keys, especially RSA key pairs, are uniquely identified using key IDs. If the device does not have not enough storage capacity for storing the key pair to be created, the maximum number of keys reached fault shall be produced and no key pair shall be generated. Otherwise, the operation generates a keyID for the new key and associates the generating status to it. Immediately after key generation has started, the device shall return the keyID to the client and continue to generate the key pair. The client may query the device with the GetKeyStatus operation whether the generation has finished. The client may also subscribe to Key Status events to be notified about key status changes. The device also returns a best-effort estimate of how much time it requires to create the key pair. A client may use this information as an indication how long to wait before querying the device whether key generation is completed. After the key has been successfully created, the device shall assign it the ok status. If the key generation fails, the device shall assign the key the corrupt status. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateSelfSignedCertificate -▸ **CreateSelfSignedCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateSelfSignedCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:174](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L174)* +*Defined in [api/advancedsecurity.ts:174](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L174)* This operation generates for a public key on the device a self-signed X.509 certificate that complies to RFC 5280. The X509Version parameter specifies the version of X.509 that the generated certificate shall comply to. A device that supports this command shall support the generation of X.509v3 certificates as specified in RFC 5280 and may additionally be able to handle other X.509 certificate formats as indicated by the X.509Versions capability. The key pair that contains the public key for which a self-signed certificate shall be produced is specified by its key pair ID. The subject parameter describes the entity that the public key belongs to. If the key pair does not have status ok, a device shall produce an InvalidKeyStatus fault and no certificate shall be generated. @@ -1004,16 +1004,16 @@ The signature algorithm parameter determines which signature algorithm shall be Certificates are uniquely identified using certificate IDs. If the command was successful, the device generates a new ID for the generated certificate and returns this ID. If the device does not have not enough storage capacity for storing the certificate to be created, the maximum number of certificates reached fault shall be produced and no certificate shall be generated. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteCRL -▸ **DeleteCRL**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteCRL**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:405](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L405)* +*Defined in [api/advancedsecurity.ts:405](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L405)* ``` This operation deletes a certificate revocation list (CRL) from the keystore on the device. @@ -1022,16 +1022,16 @@ ___ After a CRL has been successfully deleted, a device may assign its former ID to other CRLs. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteCertPathValidationPolicy -▸ **DeleteCertPathValidationPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteCertPathValidationPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:459](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L459)* +*Defined in [api/advancedsecurity.ts:459](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L459)* ``` This operation deletes a certification path validation policy from the keystore on the device. @@ -1040,180 +1040,180 @@ ___ After the certification path validation policy has been deleted, the device may assign its former ID to other certification path validation policies. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteCertificate -▸ **DeleteCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:255](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L255)* +*Defined in [api/advancedsecurity.ts:255](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L255)* This operation deletes a certificate from the device’s keystore. The operation shall not delete the public key that is contained in the certificate from the keystore. Certificates are uniquely identified using certificate IDs. If no certificate is stored under the requested certificate ID in the keystore, an InvalidArgVal fault is produced. If there is a certificate under the requested certificate ID stored in the keystore and the certificate could not be deleted, a CertificateDeletion fault is produced. If a reference exists for the specified certificate, the certificate shall not be deleted and the corresponding fault shall be produced. After a certificate has been successfully deleted, the device may assign its former ID to other certificates. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteCertificationPath -▸ **DeleteCertificationPath**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteCertificationPath**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:318](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L318)* +*Defined in [api/advancedsecurity.ts:318](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L318)* This operation deletes a certification path from the device’s keystore. This operation shall not delete the certificates that are referenced by the certification path. Certification paths are uniquely identified using certification path IDs. If no certification path is stored under the requested certification path ID in the keystore, an InvalidArgVal fault is produced. If there is a certification path under the requested certification path ID stored in the keystore and the certification path could not be deleted, a CertificationPathDeletion fault is produced. If a reference exists for the specified certification path, the certification path shall not be deleted and the corresponding fault shall be produced. After a certification path is successfully deleted, the device may assign its former ID to other certification paths. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteDot1XConfiguration -▸ **DeleteDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:679](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L679)* +*Defined in [api/advancedsecurity.ts:679](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L679)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteKey -▸ **DeleteKey**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteKey**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:127](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L127)* +*Defined in [api/advancedsecurity.ts:127](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L127)* This operation deletes a key from the device’s keystore. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore, a device shall produce an InvalidArgVal fault. If a reference exists for the specified key, a device shall produce the corresponding fault and shall not delete the key. If there is a key under the requested key ID stored in the keystore and the key could not be deleted, a device shall produce a KeyDeletion fault. If the key has the status generating, a device shall abort the generation of the key and delete from the keystore all data generated for this key. After a key is successfully deleted, the device may assign its former ID to other keys. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteNetworkInterfaceDot1XConfiguration -▸ **DeleteNetworkInterfaceDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteNetworkInterfaceDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:712](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L712)* +*Defined in [api/advancedsecurity.ts:712](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L712)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeletePassphrase -▸ **DeletePassphrase**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeletePassphrase**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:353](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L353)* +*Defined in [api/advancedsecurity.ts:353](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L353)* ``` This operation deletes a passphrase from the keystore of the device. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllCRLs -▸ **GetAllCRLs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllCRLs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:391](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L391)* +*Defined in [api/advancedsecurity.ts:391](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L391)* ``` This operation returns all certificate revocation lists (CRLs) that are stored in the keystore on the device. If no certificate revocation list is stored in the device’s keystore, an empty list is returned. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllCertPathValidationPolicies -▸ **GetAllCertPathValidationPolicies**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllCertPathValidationPolicies**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:445](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L445)* +*Defined in [api/advancedsecurity.ts:445](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L445)* ``` This operation returns all certification path validation policies that are stored in the keystore on the device. If no certification path validation policy is stored in the device’s keystore, an empty list is returned. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllCertificates -▸ **GetAllCertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllCertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:239](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L239)* +*Defined in [api/advancedsecurity.ts:239](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L239)* This operation returns the IDs of all certificates that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which certificates are present on the device. If no certificate is stored in the device’s keystore, an empty list is returned. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllCertificationPaths -▸ **GetAllCertificationPaths**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllCertificationPaths**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:300](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L300)* +*Defined in [api/advancedsecurity.ts:300](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L300)* This operation returns the IDs of all certification paths that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which certificates are present on the device. If no certification path is stored on the device, an empty list is returned. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllDot1XConfigurations -▸ **GetAllDot1XConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllDot1XConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:657](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L657)* +*Defined in [api/advancedsecurity.ts:657](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L657)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllKeys -▸ **GetAllKeys**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllKeys**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:111](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L111)* +*Defined in [api/advancedsecurity.ts:111](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L111)* This operation returns information about all keys that are stored in the device’s keystore. This operation may be used, e.g., if a client lost track of which keys are present on the device. If no key is stored on the device, an empty list is returned. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAllPassphrases -▸ **GetAllPassphrases**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAllPassphrases**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:342](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L342)* +*Defined in [api/advancedsecurity.ts:342](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L342)* ``` This operation returns information about all passphrases that are stored in the keystore of the device. @@ -1221,224 +1221,224 @@ ___ If no passphrase is stored on the device, the device shall return an empty list. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAssignedCertPathValidationPolicies -▸ **GetAssignedCertPathValidationPolicies**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAssignedCertPathValidationPolicies**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:635](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L635)* +*Defined in [api/advancedsecurity.ts:635](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L635)* ``` This operation returns the IDs of all certification path validation policies that are assigned to the TLS server on the device. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAssignedServerCertificates -▸ **GetAssignedServerCertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAssignedServerCertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:561](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L561)* +*Defined in [api/advancedsecurity.ts:561](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L561)* This operation returns the IDs of all key pairs and certificates (including certification paths) that are assigned to the TLS server on the device. This operation may be used, e.g., if a client lost track of the certification path assignments on the device. If no certification path is assigned to the TLS server, an empty list is returned. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCRL -▸ **GetCRL**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCRL**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:379](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L379)* +*Defined in [api/advancedsecurity.ts:379](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L379)* ``` This operation returns a specific certificate revocation list (CRL) from the keystore on the device. Certification revocation lists are uniquely identified using CRLIDs. If no CRL is stored under the requested CRLID, the device shall produce a CRLID fault. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCertPathValidationPolicy -▸ **GetCertPathValidationPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCertPathValidationPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:433](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L433)* +*Defined in [api/advancedsecurity.ts:433](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L433)* ``` This operation returns a certification path validation policy from the keystore on the device. Certification path validation policies are uniquely identified using certification path validation policy IDs. If no certification path validation policy is stored under the requested certification path validation policy ID, the device shall produce a CertPathValidationPolicyID fault. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCertificate -▸ **GetCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:226](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L226)* +*Defined in [api/advancedsecurity.ts:226](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L226)* This operation returns a specific certificate from the device’s keystore. Certificates are uniquely identified using certificate IDs. If no certificate is stored under the requested certificate ID in the keystore, an InvalidArgVal fault is produced. It shall be noted that this command does not return the private key that is associated to the public key in the certificate. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCertificationPath -▸ **GetCertificationPath**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCertificationPath**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:287](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L287)* +*Defined in [api/advancedsecurity.ts:287](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L287)* This operation returns a specific certification path from the device’s keystore. Certification paths are uniquely identified using certification path IDs. If no certification path is stored under the requested ID in the keystore, an InvalidArgVal fault is produced. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetClientAuthenticationRequired -▸ **GetClientAuthenticationRequired**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetClientAuthenticationRequired**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:586](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L586)* +*Defined in [api/advancedsecurity.ts:586](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L586)* ``` This operation returns whether TLS client authentication is active. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDot1XConfiguration -▸ **GetDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:668](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L668)* +*Defined in [api/advancedsecurity.ts:668](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L668)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetEnabledTLSVersions -▸ **GetEnabledTLSVersions**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetEnabledTLSVersions**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:548](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L548)* +*Defined in [api/advancedsecurity.ts:548](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L548)* This operation retrieves the version(s) of TLS which are currently enabled on the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetKeyStatus -▸ **GetKeyStatus**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetKeyStatus**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:84](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L84)* +*Defined in [api/advancedsecurity.ts:84](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L84)* This operation returns the status of a key. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore, an InvalidKeyID fault is produced. Otherwise, the status of the key is returned. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNetworkInterfaceDot1XConfiguration -▸ **GetNetworkInterfaceDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNetworkInterfaceDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:701](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L701)* +*Defined in [api/advancedsecurity.ts:701](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L701)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPrivateKeyStatus -▸ **GetPrivateKeyStatus**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPrivateKeyStatus**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L98)* +*Defined in [api/advancedsecurity.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L98)* This operation returns whether a key pair contains a private key. Keys are uniquely identified using key IDs. If no key is stored under the requested key ID in the keystore or the key identified by the requested key ID does not identify a key pair, the device shall produce an InvalidKeyID fault. Otherwise, this operation returns true if the key pair identified by the key ID contains a private key, and false otherwise. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L12)* +*Defined in [api/advancedsecurity.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L12)* Returns the capabilities of the security configuraiton service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveCertPathValidationPolicyAssignment -▸ **RemoveCertPathValidationPolicyAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveCertPathValidationPolicyAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:611](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L611)* +*Defined in [api/advancedsecurity.ts:611](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L611)* ``` This operation removes a certification path validation policy assignment from the TLS server on the device. If the certification path validation policy identified by the requested CertPathValidationPolicyID is not associated to the TLS server, the device shall produce a CertPathValidationPolicy fault. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveServerCertificateAssignment -▸ **RemoveServerCertificateAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveServerCertificateAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:496](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L496)* +*Defined in [api/advancedsecurity.ts:496](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L496)* This operation removes a key pair and certificate assignment (including certification path) to the TLS server on the device. Certification paths are identified using certification path IDs. If the supplied certification path ID is not associated to the TLS server, an InvalidArgVal fault is produced. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ReplaceCertPathValidationPolicyAssignment -▸ **ReplaceCertPathValidationPolicyAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ReplaceCertPathValidationPolicyAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:624](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L624)* +*Defined in [api/advancedsecurity.ts:624](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L624)* ``` This operation replaces a certification path validation policy assignment to the TLS server on the device with another certification path validation policy assignment. @@ -1446,16 +1446,16 @@ ___ If no certification path validation policy exists under the requested NewCertPathValidationPolicyID in the device’s keystore, the device shall produce a NewCertPathValidationPolicyID fault and shall not remove the association of the old certification path validation policy to the TLS server. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ReplaceServerCertificateAssignment -▸ **ReplaceServerCertificateAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ReplaceServerCertificateAssignment**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:522](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L522)* +*Defined in [api/advancedsecurity.ts:522](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L522)* This operation replaces an existing key pair and certificate assignment to the TLS server on the device by a new key pair and certificate assignment (including certification paths). @@ -1463,16 +1463,16 @@ After the replacement, the TLS server shall use the new certificate and certific Certification paths are identified using certification path IDs. If the supplied old certification path ID is not associated to the TLS server, or no certification path exists under the new certification path ID, the corresponding InvalidArgVal faults are produced and the associations are unchanged. The first certificate in the new certification path must be the TLS server certificate. Since each certificate has exactly one associated key pair, a reference to the key pair that is associated with the new server certificate is not supplied explicitly. Devices shall obtain the private key or results of operations under the private key by suitable internal interaction with the keystore. If a device chooses to perform a TLS key exchange based on the new certification path, it shall use the key pair that is associated with the server certificate for key exchange and transmit the certification path to TLS clients as-is, i.e., the device shall not check conformance of the certification path to RFC 4346 norRFC 2246. In order to use the server certificate during the TLS handshake, the corresponding private key is required. Therefore, if the key pair that is associated with the server certificate, i.e., the first certificate in the certification path, does not have an associated private key, the NoPrivateKey fault is produced and the certification path is not associated to the TLS server. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetClientAuthenticationRequired -▸ **SetClientAuthenticationRequired**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetClientAuthenticationRequired**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:575](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L575)* +*Defined in [api/advancedsecurity.ts:575](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L575)* ``` This operation activates or deactivates TLS client authentication for the TLS server on the device. @@ -1481,42 +1481,42 @@ ___ The device shall execute this command regardless of the TLS enabled/disabled state configured in the ONVIF Device Management Service. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetEnabledTLSVersions -▸ **SetEnabledTLSVersions**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetEnabledTLSVersions**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:537](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L537)* +*Defined in [api/advancedsecurity.ts:537](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L537)* This operation sets the version(s) of TLS which the device shall use. Valid values are taken from the TLSServerSupported capability. A client initiates a TLS session by sending a ClientHello with the hightest TLS version it supports. This suggests to the server that the client can accept any TLS version up to and including that version. The server then chooses the TLS version to use. This is generally the highest TLS version the server supports that is within the range of the client. For example, if a ClientHello indicates TLS version 1.1, the server can proceed with TLS 1.0 or TLS 1.1. In the event that an ONVIF installation wishes to disable certain version(s) of TLS, it may do so with this operation. For example, to disable TLS 1.0 on a device signaling support for TLS versions 1.0, 1.1, and 1.2, the enabled version list may be set to "1.1 1.2", omitting 1.0. If a client then attempts to connect with a ClientHello containing TLS 1.0, the server shall send a "protocol\_version" alert message and close the connection. This handshake indicates to the client that TLS 1.0 is not supported by the server. The client must try again with a higher TLS version suggestion. An empty list is not permitted. Disabling all versions of TLS is not the intent of this operation. See AddServerCertificateAssignment and RemoveServerCertificateAssignment. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetNetworkInterfaceDot1XConfiguration -▸ **SetNetworkInterfaceDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetNetworkInterfaceDot1XConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:690](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L690)* +*Defined in [api/advancedsecurity.ts:690](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L690)* (to be written) -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` UploadCRL -▸ **UploadCRL**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **UploadCRL**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:367](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L367)* +*Defined in [api/advancedsecurity.ts:367](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L367)* ``` This operation uploads a certificate revocation list (CRL) as specified in [RFC 5280] to the keystore on the device. @@ -1525,16 +1525,16 @@ ___ If the device does not support the signature algorithm that was used to sign the supplied CRL, the device shall produce an UnsupportedSignatureAlgorithm fault and shall not store the supplied CRL. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` UploadCertificate -▸ **UploadCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **UploadCertificate**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:213](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L213)* +*Defined in [api/advancedsecurity.ts:213](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L213)* This operation uploads an X.509 certificate as specified by \[RFC 5280\] in DER encoding and the public key in the certificate to a device’s keystore. A device that supports this command shall be able to handle X.509v3 certificates as specified in RFC 5280 and may additionally be able to handle other X.509 certificate formats as indicated by the X.509Versions capability. A device that supports this command shall support sha1-WithRSAEncryption as certificate signature algorithm. @@ -1544,16 +1544,16 @@ The uploaded certificate has to be linked to a key pair in the keystore. If no p If the device does not have not enough storage capacity for storing the certificate to be uploaded, the maximum number of certificates reached fault shall be produced and no certificate shall be uploaded. If the device does not have not enough storage capacity for storing the key pair that eventually has to be created, the device shall generate a maximum number of keys reached fault. Furthermore the device shall not generate a key pair and no certificate shall be stored. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` UploadCertificateWithPrivateKeyInPKCS12 -▸ **UploadCertificateWithPrivateKeyInPKCS12**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **UploadCertificateWithPrivateKeyInPKCS12**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L71)* +*Defined in [api/advancedsecurity.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L71)* ``` This operation uploads a certification path consisting of X.509 certificates as specified by [RFC 5280] in DER encoding along with a private key to a device’s keystore. @@ -1572,16 +1572,16 @@ ___ If an EncryptionPassphraseID is supplied, but a KeyBag is provided instead of a PKCS8ShroudedKeyBag, the device shall ignore the supplied EncryptionPassphraseID when processing the KeyBag. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` UploadKeyPairInPKCS8 -▸ **UploadKeyPairInPKCS8**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **UploadKeyPairInPKCS8**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:47](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L47)* +*Defined in [api/advancedsecurity.ts:47](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L47)* ``` This operation uploads a key pair in a PKCS#8 data structure as specified in [RFC 5958, RFC 5959]. @@ -1591,22 +1591,22 @@ ___ OneAsymmetricKey ASN.1 structure which contains both the private key and the corresponding public key. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` UploadPassphrase -▸ **UploadPassphrase**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **UploadPassphrase**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/advancedsecurity.ts:329](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/advancedsecurity.ts#L329)* +*Defined in [api/advancedsecurity.ts:329](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/advancedsecurity.ts#L329)* ``` This operation uploads a passphrase to the keystore of the device. ``` -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_analytics_.onvifanalytics.md b/docs/classes/_api_analytics_.onvifanalytics.md index 6402a45..d727f03 100644 --- a/docs/classes/_api_analytics_.onvifanalytics.md +++ b/docs/classes/_api_analytics_.onvifanalytics.md @@ -55,7 +55,7 @@ ⊕ **new ONVIFAnalytics**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFAnalytics](_api_analytics_.onvifanalytics.md) -*Defined in [api/analytics.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L5)* +*Defined in [api/analytics.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L5)* **Parameters:** @@ -75,7 +75,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/analytics.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L6)* +*Defined in [api/analytics.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L6)* ___ @@ -85,9 +85,9 @@ ___ ### CreateAnalyticsModules -▸ **CreateAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:289](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L289)* +*Defined in [api/analytics.ts:289](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L289)* 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. @@ -102,16 +102,16 @@ The device shall ensure that a corresponding analytics engine starts operation w | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AnalyticsModule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateRules -▸ **CreateRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:202](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L202)* +*Defined in [api/analytics.ts:202](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L202)* 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. @@ -124,16 +124,16 @@ Although this method is mandatory a device implementation must not support addin | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Rule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteAnalyticsModules -▸ **DeleteAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModuleName: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModuleName: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:298](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L298)* +*Defined in [api/analytics.ts:298](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L298)* Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names. @@ -144,16 +144,16 @@ Remove one or more analytics modules from a VideoAnalyticsConfiguration referenc | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AnalyticsModuleName | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteRules -▸ **DeleteRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleName: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleName: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:211](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L211)* +*Defined in [api/analytics.ts:211](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L211)* Remove one or more rules from a VideoAnalyticsConfiguration. @@ -164,16 +164,16 @@ Remove one or more rules from a VideoAnalyticsConfiguration. | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | RuleName | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAnalyticsModuleOptions -▸ **GetAnalyticsModuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Type: *`any`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAnalyticsModuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Type: *`any`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:265](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L265)* +*Defined in [api/analytics.ts:265](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L265)* Return the options for the supported analytics modules that specify an Option attribute. @@ -184,16 +184,16 @@ Return the options for the supported analytics modules that specify an Option at | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Type | `any` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAnalyticsModules -▸ **GetAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:307](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L307)* +*Defined in [api/analytics.ts:307](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L307)* List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. @@ -203,16 +203,16 @@ List the currently assigned set of analytics modules of a VideoAnalyticsConfigur | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRuleOptions -▸ **GetRuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleType: *`any`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleType: *`any`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:229](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L229)* +*Defined in [api/analytics.ts:229](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L229)* Return the options for the supported rules that specify an Option attribute. @@ -223,16 +223,16 @@ Return the options for the supported rules that specify an Option attribute. | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | RuleType | `any` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRules -▸ **GetRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:220](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L220)* +*Defined in [api/analytics.ts:220](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L220)* List the currently assigned set of rules of a VideoAnalyticsConfiguration. @@ -242,29 +242,29 @@ List the currently assigned set of rules of a VideoAnalyticsConfiguration. | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:245](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L245)* +*Defined in [api/analytics.ts:245](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L245)* Returns the capabilities of the analytics service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSupportedAnalyticsModules -▸ **GetSupportedAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSupportedAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:256](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L256)* +*Defined in [api/analytics.ts:256](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L256)* List all analytics modules that are supported by the given VideoAnalyticsConfiguration. The result of this method may depend on the overall Video analytics configuration of the device, which is available via the current set of profiles. @@ -274,16 +274,16 @@ List all analytics modules that are supported by the given VideoAnalyticsConfigu | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSupportedRules -▸ **GetSupportedRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSupportedRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:185](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L185)* +*Defined in [api/analytics.ts:185](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L185)* List all rules that are supported by the given VideoAnalyticsConfiguration. The result of this method may depend on the overall Video analytics configuration of the device, which is available via the current set of profiles. @@ -293,16 +293,16 @@ List all rules that are supported by the given VideoAnalyticsConfiguration. The | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ModifyAnalyticsModules -▸ **ModifyAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ModifyAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:317](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L317)* +*Defined in [api/analytics.ts:317](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L317)* 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. @@ -313,16 +313,16 @@ Modify the settings of one or more analytics modules of a VideoAnalyticsConfigur | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AnalyticsModule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ModifyRules -▸ **ModifyRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ModifyRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/analytics.ts:238](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L238)* +*Defined in [api/analytics.ts:238](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L238)* Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names. @@ -333,16 +333,16 @@ Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referen | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Rule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` CreateAnalyticsModules -▸ **CreateAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:138](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L138)* +*Defined in [api/analytics.ts:138](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L138)* 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. @@ -357,16 +357,16 @@ The device shall ensure that a corresponding analytics engine starts operation w | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AnalyticsModule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateRules -▸ **CreateRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:35](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L35)* +*Defined in [api/analytics.ts:35](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L35)* 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. @@ -379,16 +379,16 @@ Although this method is mandatory a device implementation must not support addin | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Rule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteAnalyticsModules -▸ **DeleteAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModuleName: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModuleName: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:149](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L149)* +*Defined in [api/analytics.ts:149](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L149)* Remove one or more analytics modules from a VideoAnalyticsConfiguration referenced by their names. @@ -399,16 +399,16 @@ Remove one or more analytics modules from a VideoAnalyticsConfiguration referenc | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AnalyticsModuleName | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteRules -▸ **DeleteRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleName: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleName: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L46)* +*Defined in [api/analytics.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L46)* Remove one or more rules from a VideoAnalyticsConfiguration. @@ -419,16 +419,16 @@ Remove one or more rules from a VideoAnalyticsConfiguration. | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | RuleName | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAnalyticsModuleOptions -▸ **GetAnalyticsModuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Type?: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAnalyticsModuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Type?: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:112](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L112)* +*Defined in [api/analytics.ts:112](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L112)* Return the options for the supported analytics modules that specify an Option attribute. @@ -439,16 +439,16 @@ Return the options for the supported analytics modules that specify an Option at | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` Type | `any` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAnalyticsModules -▸ **GetAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:160](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L160)* +*Defined in [api/analytics.ts:160](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L160)* List the currently assigned set of analytics modules of a VideoAnalyticsConfiguration. @@ -458,16 +458,16 @@ List the currently assigned set of analytics modules of a VideoAnalyticsConfigur | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRuleOptions -▸ **GetRuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleType?: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRuleOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, RuleType?: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:68](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L68)* +*Defined in [api/analytics.ts:68](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L68)* Return the options for the supported rules that specify an Option attribute. @@ -478,16 +478,16 @@ Return the options for the supported rules that specify an Option attribute. | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` RuleType | `any` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRules -▸ **GetRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:57](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L57)* +*Defined in [api/analytics.ts:57](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L57)* List the currently assigned set of rules of a VideoAnalyticsConfiguration. @@ -497,29 +497,29 @@ List the currently assigned set of rules of a VideoAnalyticsConfiguration. | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:88](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L88)* +*Defined in [api/analytics.ts:88](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L88)* Returns the capabilities of the analytics service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSupportedAnalyticsModules -▸ **GetSupportedAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSupportedAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:101](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L101)* +*Defined in [api/analytics.ts:101](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L101)* List all analytics modules that are supported by the given VideoAnalyticsConfiguration. The result of this method may depend on the overall Video analytics configuration of the device, which is available via the current set of profiles. @@ -529,16 +529,16 @@ List all analytics modules that are supported by the given VideoAnalyticsConfigu | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSupportedRules -▸ **GetSupportedRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSupportedRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L16)* +*Defined in [api/analytics.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L16)* List all rules that are supported by the given VideoAnalyticsConfiguration. The result of this method may depend on the overall Video analytics configuration of the device, which is available via the current set of profiles. @@ -548,16 +548,16 @@ List all rules that are supported by the given VideoAnalyticsConfiguration. The | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ModifyAnalyticsModules -▸ **ModifyAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ModifyAnalyticsModules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AnalyticsModule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:172](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L172)* +*Defined in [api/analytics.ts:172](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L172)* 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. @@ -568,16 +568,16 @@ Modify the settings of one or more analytics modules of a VideoAnalyticsConfigur | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AnalyticsModule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ModifyRules -▸ **ModifyRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ModifyRules**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Rule: *[Config](../interfaces/_api_types_.config.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/analytics.ts:79](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/analytics.ts#L79)* +*Defined in [api/analytics.ts:79](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/analytics.ts#L79)* Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referenced by their names. @@ -588,7 +588,7 @@ Modify one or more rules of a VideoAnalyticsConfiguration. The rules are referen | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Rule | [Config](../interfaces/_api_types_.config.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_device_.onvifdevice.md b/docs/classes/_api_device_.onvifdevice.md index 7ec0ed7..2d034eb 100644 --- a/docs/classes/_api_device_.onvifdevice.md +++ b/docs/classes/_api_device_.onvifdevice.md @@ -209,7 +209,7 @@ ⊕ **new ONVIFDevice**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFDevice](_api_device_.onvifdevice.md) -*Defined in [api/device.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L5)* +*Defined in [api/device.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L5)* **Parameters:** @@ -229,7 +229,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/device.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L6)* +*Defined in [api/device.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L6)* ___ @@ -239,9 +239,9 @@ ___ ### AddIPAddressFilter -▸ **AddIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1596](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1596)* +*Defined in [api/device.ts:1596](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1596)* This operation adds an IP filter address to a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support adding of IP filtering addresses through the AddIPAddressFilter command. @@ -251,16 +251,16 @@ This operation adds an IP filter address to a device. If the device supports dev | ------ | ------ | | IPAddressFilter | [IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddScopes -▸ **AddScopes**(ScopeItem: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddScopes**(ScopeItem: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1260](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1260)* +*Defined in [api/device.ts:1260](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1260)* 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. @@ -270,16 +270,16 @@ This operation adds new configurable scope parameters to a device. The scope par | ------ | ------ | | ScopeItem | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateCertificate -▸ **CreateCertificate**(CertificateID: *`string`*, Subject: *`string`*, ValidNotBefore: *`string`*, ValidNotAfter: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateCertificate**(CertificateID: *`string`*, Subject: *`string`*, ValidNotBefore: *`string`*, ValidNotAfter: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1643](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1643)* +*Defined in [api/device.ts:1643](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1643)* This operation generates a private/public key pair and also can create a self-signed device certificate as a result of key pair generation. The certificate is created using a suitable onboard key pair generation mechanism. If a device supports onboard key pair generation, the device that supports TLS shall support this certificate creation command. And also, if a device supports onboard key pair generation, the device that support IEEE 802.1X shall support this command for the purpose of key pair generation. Certificates and key pairs are identified using certificate IDs. These IDs are either chosen by the certificate generation requester or by the device (in case that no ID value is given). @@ -292,16 +292,16 @@ This operation generates a private/public key pair and also can create a self-si | ValidNotBefore | `string` | | ValidNotAfter | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateDot1XConfiguration -▸ **CreateDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1853](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1853)* +*Defined in [api/device.ts:1853](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1853)* This operation newly creates IEEE 802.1X configuration parameter set of the device. The device shall support this command if it supports IEEE 802.1X. If the device receives this request with already existing configuration token (Dot1XConfigurationToken) specification, the device should respond with 'ter:ReferenceToken ' error to indicate there is some configuration conflict. @@ -311,16 +311,16 @@ This operation newly creates IEEE 802.1X configuration parameter set of the devi | ------ | ------ | | Dot1XConfiguration | [Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateStorageConfiguration -▸ **CreateStorageConfiguration**(StorageConfiguration: *`any`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateStorageConfiguration**(StorageConfiguration: *`any`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1999](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1999)* +*Defined in [api/device.ts:1999](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1999)* This operation creates a new storage configuration. The configuration data shall be created in the device and shall be persistent (remain after reboot). @@ -330,16 +330,16 @@ This operation creates a new storage configuration. The configuration data shall | ------ | ------ | | StorageConfiguration | `any` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateUsers -▸ **CreateUsers**(User: *[User](../interfaces/_api_types_.user.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateUsers**(User: *[User](../interfaces/_api_types_.user.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1381](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1381)* +*Defined in [api/device.ts:1381](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1381)* 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. @@ -349,16 +349,16 @@ This operation creates new device users and corresponding credentials on a devic | ------ | ------ | | User | [User](../interfaces/_api_types_.user.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteCertificates -▸ **DeleteCertificates**(CertificateID: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteCertificates**(CertificateID: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1685](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1685)* +*Defined in [api/device.ts:1685](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1685)* This operation deletes a certificate or multiple certificates. The device MAY also delete a private/public key pair which is coupled with the certificate to be deleted. The device that support either TLS or IEEE 802.1X shall support the deletion of a certificate or multiple certificates through this command. Either all certificates are deleted successfully or a fault message shall be returned without deleting any certificate. @@ -368,16 +368,16 @@ This operation deletes a certificate or multiple certificates. The device MAY al | ------ | ------ | | CertificateID | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteDot1XConfiguration -▸ **DeleteDot1XConfiguration**(Dot1XConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteDot1XConfiguration**(Dot1XConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1894](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1894)* +*Defined in [api/device.ts:1894](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1894)* This operation deletes an IEEE 802.1X configuration parameter set from the device. Which configuration should be deleted is specified by the 'Dot1XConfigurationToken' in the request. A device that support IEEE 802.1X shall support this command. @@ -387,16 +387,16 @@ This operation deletes an IEEE 802.1X configuration parameter set from the devic | ------ | ------ | | Dot1XConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteGeoLocation -▸ **DeleteGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:2053](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L2053)* +*Defined in [api/device.ts:2053](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L2053)* This operation deletes the given geo location entries. @@ -406,16 +406,16 @@ This operation deletes the given geo location entries. | ------ | ------ | | Location | [LocationEntity](../interfaces/_api_types_.locationentity.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteStorageConfiguration -▸ **DeleteStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:2026](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L2026)* +*Defined in [api/device.ts:2026](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L2026)* This operation deletes the given storage configuration and configuration change shall always be persistent. @@ -425,16 +425,16 @@ This operation deletes the given storage configuration and configuration change | ------ | ------ | | Token | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteUsers -▸ **DeleteUsers**(Username: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteUsers**(Username: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1391](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1391)* +*Defined in [api/device.ts:1391](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1391)* 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. @@ -444,42 +444,42 @@ This operation deletes users on a device. The device shall support deletion of d | ------ | ------ | | Username | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAccessPolicy -▸ **GetAccessPolicy**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAccessPolicy**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1619](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1619)* +*Defined in [api/device.ts:1619](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1619)* Access to different services and sub-sets of services should be subject to access control. The WS-Security framework gives the prerequisite for end-point authentication. Authorization decisions can then be taken using an access security policy. This standard does not mandate any particular policy description format or security policy but this is up to the device manufacturer or system provider to choose policy and policy description format of choice. However, an access policy (in arbitrary format) can be requested using this command. If the device supports access policy settings based on WS-Security authentication, then the device shall support this command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCACertificates -▸ **GetCACertificates**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCACertificates**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1796](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1796)* +*Defined in [api/device.ts:1796](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1796)* CA certificates will be loaded into a device and be used for the sake of following two cases. The one is for the purpose of TLS client authentication in TLS server function. The other one is for the purpose of Authentication Server authentication in IEEE 802.1X function. This operation gets all CA certificates loaded into a device. A device that supports either TLS client authentication or IEEE 802.1X shall support this command and the returned certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCapabilities -▸ **GetCapabilities**(Category: *[CapabilityCategory](../enums/_api_types_.capabilitycategory.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCapabilities**(Category: *[CapabilityCategory](../enums/_api_types_.capabilitycategory.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1418](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1418)* +*Defined in [api/device.ts:1418](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1418)* This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the GetServiceCapabilities methods. @@ -489,16 +489,16 @@ This method has been replaced by the more generic GetServices method. For capabi | ------ | ------ | | Category | [CapabilityCategory](../enums/_api_types_.capabilitycategory.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCertificateInformation -▸ **GetCertificateInformation**(CertificateID: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCertificateInformation**(CertificateID: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1827](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1827)* +*Defined in [api/device.ts:1827](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1827)* This operation requests the information of a certificate specified by certificate ID. The device should respond with its “Issuer DN”, “Subject DN”, “Key usage”, "Extended key usage”, “Key Length”, “Version”, “Serial Number”, “Signature Algorithm” and “Validity” data as the information of the certificate, as long as the device can retrieve such information from the specified certificate. A device that supports either TLS or IEEE 802.1X should support this command. @@ -508,120 +508,120 @@ This operation requests the information of a certificate specified by certificat | ------ | ------ | | CertificateID | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCertificates -▸ **GetCertificates**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCertificates**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1656](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1656)* +*Defined in [api/device.ts:1656](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1656)* This operation gets all device server certificates (including self-signed) for the purpose of TLS authentication and all device client certificates for the purpose of IEEE 802.1X authentication. This command lists only the TLS server certificates and IEEE 802.1X client certificates for the device (neither trusted CA certificates nor trusted root certificates). The certificates are returned as binary data. A device that supports TLS shall support this command and the certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCertificatesStatus -▸ **GetCertificatesStatus**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCertificatesStatus**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1665](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1665)* +*Defined in [api/device.ts:1665](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1665)* This operation is specific to TLS functionality. This operation gets the status (enabled/disabled) of the device TLS server certificates. A device that supports TLS shall support this command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetClientCertificateMode -▸ **GetClientCertificateMode**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetClientCertificateMode**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1728](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1728)* +*Defined in [api/device.ts:1728](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1728)* This operation is specific to TLS functionality. This operation gets the status (enabled/disabled) of the device TLS client authentication. A device that supports TLS shall support this command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDNS -▸ **GetDNS**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDNS**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1452](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1452)* +*Defined in [api/device.ts:1452](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1452)* This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDPAddresses -▸ **GetDPAddresses**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDPAddresses**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1318](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1318)* +*Defined in [api/device.ts:1318](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1318)* This operation gets the remote DP address or addresses from a device. If the device supports remote discovery, as specified in Section 7.4, the device shall support retrieval of the remote DP address(es) through the GetDPAddresses command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDeviceInformation -▸ **GetDeviceInformation**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDeviceInformation**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1140](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1140)* +*Defined in [api/device.ts:1140](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1140)* This operation gets basic device information from the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDiscoveryMode -▸ **GetDiscoveryMode**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDiscoveryMode**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1280](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1280)* +*Defined in [api/device.ts:1280](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1280)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDot11Capabilities -▸ **GetDot11Capabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDot11Capabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1902](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1902)* +*Defined in [api/device.ts:1902](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1902)* This operation returns the IEEE802.11 capabilities. The device shall support this operation. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDot11Status -▸ **GetDot11Status**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDot11Status**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1910](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1910)* +*Defined in [api/device.ts:1910](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1910)* This operation returns the status of a wireless network interface. The device shall support this command. @@ -631,16 +631,16 @@ This operation returns the status of a wireless network interface. The device sh | ------ | ------ | | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDot1XConfiguration -▸ **GetDot1XConfiguration**(Dot1XConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDot1XConfiguration**(Dot1XConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1873](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1873)* +*Defined in [api/device.ts:1873](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1873)* This operation gets one IEEE 802.1X configuration parameter set from the device by specifying the configuration token (Dot1XConfigurationToken). A device that supports IEEE 802.1X shall support this command. Regardless of whether the 802.1X method in the retrieved configuration has a password or not, the device shall not include the Password element in the response. @@ -650,146 +650,146 @@ This operation gets one IEEE 802.1X configuration parameter set from the device | ------ | ------ | | Dot1XConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDot1XConfigurations -▸ **GetDot1XConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDot1XConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1885](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1885)* +*Defined in [api/device.ts:1885](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1885)* This operation gets all the existing IEEE 802.1X configuration parameter sets from the device. The device shall respond with all the IEEE 802.1X configurations so that the client can get to know how many IEEE 802.1X configurations are existing and how they are configured. A device that support IEEE 802.1X shall support this command. Regardless of whether the 802.1X method in the retrieved configuration has a password or not, the device shall not include the Password element in the response. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDynamicDNS -▸ **GetDynamicDNS**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDynamicDNS**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1489](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1489)* +*Defined in [api/device.ts:1489](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1489)* This operation gets the dynamic DNS settings from a device. If the device supports dynamic DNS as specified in \[RFC 2136\] and \[RFC 4702\], it shall be possible to get the type, name and TTL through the GetDynamicDNS command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetEndpointReference -▸ **GetEndpointReference**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetEndpointReference**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1337](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1337)* +*Defined in [api/device.ts:1337](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1337)* A client can ask for the device service endpoint reference address property that can be used to derive the password equivalent for remote user operation. The device shall support the GetEndpointReference command returning the address property of the device service endpoint reference. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetGeoLocation -▸ **GetGeoLocation**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetGeoLocation**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:2035](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L2035)* +*Defined in [api/device.ts:2035](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L2035)* This operation lists all existing geo location configurations for the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetHostname -▸ **GetHostname**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetHostname**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1426](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1426)* +*Defined in [api/device.ts:1426](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1426)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetIPAddressFilter -▸ **GetIPAddressFilter**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetIPAddressFilter**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1577](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1577)* +*Defined in [api/device.ts:1577](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1577)* This operation gets the IP address filter settings from a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support the GetIPAddressFilter command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNTP -▸ **GetNTP**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNTP**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1468](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1468)* +*Defined in [api/device.ts:1468](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1468)* This operation gets the NTP settings from a device. If the device supports NTP, it shall be possible to get the NTP server settings through the GetNTP command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNetworkDefaultGateway -▸ **GetNetworkDefaultGateway**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNetworkDefaultGateway**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1543](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1543)* +*Defined in [api/device.ts:1543](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1543)* This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es). -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNetworkInterfaces -▸ **GetNetworkInterfaces**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNetworkInterfaces**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1507](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1507)* +*Defined in [api/device.ts:1507](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1507)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNetworkProtocols -▸ **GetNetworkProtocols**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNetworkProtocols**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1527](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1527)* +*Defined in [api/device.ts:1527](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1527)* This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPkcs10Request -▸ **GetPkcs10Request**(CertificateID: *`string`*, Subject: *`string`*, Attributes: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPkcs10Request**(CertificateID: *`string`*, Subject: *`string`*, Attributes: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1699](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1699)* +*Defined in [api/device.ts:1699](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1699)* This operation requests a PKCS #10 certificate signature request from the device. The returned information field shall be either formatted exactly as specified in \[PKCS#10\] or PEM encoded \[PKCS#10\] format. In order for this command to work, the device must already have a private/public key pair. This key pair should be referred by CertificateID as specified in the input parameter description. This CertificateID refers to the key pair generated using CreateCertificate command. A device that support onboard key pair generation that supports either TLS or IEEE 802.1X using client certificate shall support this command. @@ -801,83 +801,83 @@ This operation requests a PKCS #10 certificate signature request from the device | Subject | `string` | | Attributes | [BinaryData](../interfaces/_api_types_.binarydata.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRelayOutputs -▸ **GetRelayOutputs**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRelayOutputs**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1745](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1745)* +*Defined in [api/device.ts:1745](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1745)* This operation gets a list of all available relay outputs and their settings. This method has been depricated with version 2.0. Refer to the DeviceIO service. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRemoteDiscoveryMode -▸ **GetRemoteDiscoveryMode**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRemoteDiscoveryMode**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1299](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1299)* +*Defined in [api/device.ts:1299](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1299)* This operation gets the remote discovery mode of a device. See Section 7.4 for the definition of remote discovery extensions. A device that supports remote discovery shall support retrieval of the remote discovery mode setting through the GetRemoteDiscoveryMode command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRemoteUser -▸ **GetRemoteUser**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRemoteUser**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1347](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1347)* +*Defined in [api/device.ts:1347](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1347)* This operation returns the configured remote user (if any). A device supporting remote user handling shall support this operation. The user is only valid for the WS-UserToken profile or as a HTTP / RTSP user. The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetScopes -▸ **GetScopes**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetScopes**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1240](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1240)* +*Defined in [api/device.ts:1240](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1240)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1133](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1133)* +*Defined in [api/device.ts:1133](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1133)* Returns the capabilities of the device service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServices -▸ **GetServices**(IncludeCapability: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServices**(IncludeCapability: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1126](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1126)* +*Defined in [api/device.ts:1126](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1126)* Returns information about services on the device. @@ -887,16 +887,16 @@ Returns information about services on the device. | ------ | ------ | | IncludeCapability | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetStorageConfiguration -▸ **GetStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:2008](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L2008)* +*Defined in [api/device.ts:2008](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L2008)* This operation retrieves the Storage configuration associated with the given storage configuration token. @@ -906,55 +906,55 @@ This operation retrieves the Storage configuration associated with the given sto | ------ | ------ | | Token | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetStorageConfigurations -▸ **GetStorageConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetStorageConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1989](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1989)* +*Defined in [api/device.ts:1989](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1989)* This operation lists all existing storage configurations for the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSystemBackup -▸ **GetSystemBackup**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSystemBackup**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1210](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1210)* +*Defined in [api/device.ts:1210](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1210)* This operation is retrieves system backup configuration file(s) from a device. The device should support return of back up configuration file(s) through the GetSystemBackup command. The backup is returned with reference to a name and mime-type together with binary data. The exact format of the backup configuration files is outside the scope of this standard. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSystemDateAndTime -▸ **GetSystemDateAndTime**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSystemDateAndTime**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1165](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1165)* +*Defined in [api/device.ts:1165](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1165)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSystemLog -▸ **GetSystemLog**(LogType: *[SystemLogType](../enums/_api_types_.systemlogtype.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSystemLog**(LogType: *[SystemLogType](../enums/_api_types_.systemlogtype.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1217](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1217)* +*Defined in [api/device.ts:1217](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1217)* This operation gets a system log from the device. The exact format of the system logs is outside the scope of this standard. @@ -964,81 +964,81 @@ This operation gets a system log from the device. The exact format of the system | ------ | ------ | | LogType | [SystemLogType](../enums/_api_types_.systemlogtype.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSystemSupportInformation -▸ **GetSystemSupportInformation**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSystemSupportInformation**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1224](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1224)* +*Defined in [api/device.ts:1224](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1224)* This operation gets arbitary device diagnostics information from the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSystemUris -▸ **GetSystemUris**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSystemUris**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1936](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1936)* +*Defined in [api/device.ts:1936](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1936)* This operation is used to retrieve URIs from which system information may be downloaded using HTTP. URIs may be returned for the following system information: System Logs. Multiple system logs may be returned, of different types. The exact format of the system logs is outside the scope of this specification. Support Information. This consists of arbitrary device diagnostics information from a device. The exact format of the diagnostic information is outside the scope of this specification. System Backup. The received file is a backup file that can be used to restore the current device configuration at a later date. The exact format of the backup configuration file is outside the scope of this specification. If the device allows retrieval of system logs, support information or system backup data, it should make them available via HTTP GET. If it does, it shall support the GetSystemUris command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetUsers -▸ **GetUsers**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetUsers**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1368](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1368)* +*Defined in [api/device.ts:1368](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1368)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetWsdlUrl -▸ **GetWsdlUrl**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetWsdlUrl**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1410](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1410)* +*Defined in [api/device.ts:1410](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1410)* It is possible for an endpoint to request a URL that can be used to retrieve the complete schema and WSDL definitions of a device. The command gives in return a URL entry point where all the necessary product specific WSDL and schema definitions can be retrieved. The device shall provide a URL for WSDL and schema download through the GetWsdlUrl command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetZeroConfiguration -▸ **GetZeroConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetZeroConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1561](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1561)* +*Defined in [api/device.ts:1561](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1561)* This operation gets the zero-configuration from a device. If the device supports dynamic IP configuration according to \[RFC3927\], it shall support the return of IPv4 zero configuration address and status through the GetZeroConfiguration command. Devices supporting zero configuration on more than one interface shall use the extension to list the additional interface settings. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### LoadCACertificates -▸ **LoadCACertificates**(CACertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **LoadCACertificates**(CACertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1842](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1842)* +*Defined in [api/device.ts:1842](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1842)* This command is used when it is necessary to load trusted CA certificates or trusted root certificates for the purpose of verification for its counterpart i.e. client certificate verification in TLS function or server certificate verification in IEEE 802.1X function. A device that support either TLS or IEEE 802.1X shall support this command. As for the supported certificate format, either DER format or PEM format is possible to be used. But a device that support this command shall support at least DER format as supported format type. The device may sort the received certificate(s) based on the public key and subject information in the certificate(s). Either all CA certificates are loaded successfully or a fault message shall be returned without loading any CA certificate. @@ -1048,16 +1048,16 @@ This command is used when it is necessary to load trusted CA certificates or tru | ------ | ------ | | CACertificate | [Certificate](../interfaces/_api_types_.certificate.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### LoadCertificateWithPrivateKey -▸ **LoadCertificateWithPrivateKey**(CertificateWithPrivateKey: *[CertificateWithPrivateKey](../interfaces/_api_types_.certificatewithprivatekey.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **LoadCertificateWithPrivateKey**(CertificateWithPrivateKey: *[CertificateWithPrivateKey](../interfaces/_api_types_.certificatewithprivatekey.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1815](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1815)* +*Defined in [api/device.ts:1815](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1815)* There might be some cases that a Certificate Authority or some other equivalent creates a certificate without having PKCS#10 certificate signing request. In such cases, the certificate will be bundled in conjunction with its private key. This command will be used for such use case scenarios. The certificate ID in the request is optionally set to the ID value the client wish to have. If the certificate ID is not specified in the request, device can choose the ID accordingly. This operation imports a private/public key pair into the device. The certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. A device that does not support onboard key pair generation and support either TLS or IEEE 802.1X using client certificate shall support this command. A device that support onboard key pair generation MAY support this command. The security policy of a device that supports this operation should make sure that the private key is sufficiently protected. @@ -1067,16 +1067,16 @@ There might be some cases that a Certificate Authority or some other equivalent | ------ | ------ | | CertificateWithPrivateKey | [CertificateWithPrivateKey](../interfaces/_api_types_.certificatewithprivatekey.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### LoadCertificates -▸ **LoadCertificates**(NVTCertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **LoadCertificates**(NVTCertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1719](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1719)* +*Defined in [api/device.ts:1719](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1719)* TLS server certificate(s) or IEEE 802.1X client certificate(s) created using the PKCS#10 certificate request command can be loaded into the device using this command (see Section 8.4.13). The certificate ID in the request shall be present. The device may sort the received certificate(s) based on the public key and subject information in the certificate(s). The certificate ID in the request will be the ID value the client wish to have. The device is supposed to scan the generated key pairs present in the device to identify which is the correspondent key pair with the loaded certificate and then make the link between the certificate and the key pair. A device that supports onboard key pair generation that support either TLS or IEEE 802.1X shall support this command. The certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. This command is applicable to any device type, although the parameter name is called for historical reasons NVTCertificate. @@ -1086,16 +1086,16 @@ TLS server certificate(s) or IEEE 802.1X client certificate(s) created using the | ------ | ------ | | NVTCertificate | [Certificate](../interfaces/_api_types_.certificate.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveIPAddressFilter -▸ **RemoveIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1605](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1605)* +*Defined in [api/device.ts:1605](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1605)* This operation deletes an IP filter address from a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support deletion of IP filtering addresses through the RemoveIPAddressFilter command. @@ -1105,16 +1105,16 @@ This operation deletes an IP filter address from a device. If the device support | ------ | ------ | | IPAddressFilter | [IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveScopes -▸ **RemoveScopes**(ScopeItem: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveScopes**(ScopeItem: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1271](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1271)* +*Defined in [api/device.ts:1271](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1271)* This operation deletes scope-configurable scope parameters from a device. The scope parameters are used in the device discovery to match a probe message, see Section 7. The device shall support deletion of discovery scope parameters through the RemoveScopes command. Table @@ -1124,16 +1124,16 @@ This operation deletes scope-configurable scope parameters from a device. The sc | ------ | ------ | | ScopeItem | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RestoreSystem -▸ **RestoreSystem**(BackupFiles: *[BackupFile](../interfaces/_api_types_.backupfile.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RestoreSystem**(BackupFiles: *[BackupFile](../interfaces/_api_types_.backupfile.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1200](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1200)* +*Defined in [api/device.ts:1200](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1200)* This operation restores the system backup configuration files(s) previously retrieved from a device. The device should support restore of backup configuration file(s) through the RestoreSystem command. The exact format of the backup configuration file(s) is outside the scope of this standard. If the command is supported, it shall accept backup files returned by the GetSystemBackup command. @@ -1143,16 +1143,16 @@ This operation restores the system backup configuration files(s) previously retr | ------ | ------ | | BackupFiles | [BackupFile](../interfaces/_api_types_.backupfile.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ScanAvailableDot11Networks -▸ **ScanAvailableDot11Networks**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ScanAvailableDot11Networks**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1918](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1918)* +*Defined in [api/device.ts:1918](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1918)* This operation returns a lists of the wireless networks in range of the device. A device should support this operation. @@ -1162,16 +1162,16 @@ This operation returns a lists of the wireless networks in range of the device. | ------ | ------ | | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SendAuxiliaryCommand -▸ **SendAuxiliaryCommand**(AuxiliaryCommand: *[AuxiliaryData](../modules/_api_types_.md#auxiliarydata)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SendAuxiliaryCommand**(AuxiliaryCommand: *[AuxiliaryData](../modules/_api_types_.md#auxiliarydata)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1784](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1784)* +*Defined in [api/device.ts:1784](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1784)* 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. @@ -1185,16 +1185,16 @@ A device that indicates auxiliary service capability shall support this command. | ------ | ------ | | AuxiliaryCommand | [AuxiliaryData](../modules/_api_types_.md#auxiliarydata) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetAccessPolicy -▸ **SetAccessPolicy**(PolicyFile: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetAccessPolicy**(PolicyFile: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1628](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1628)* +*Defined in [api/device.ts:1628](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1628)* This command sets the device access security policy (for more details on the access security policy see the Get command). If the device supports access policy settings based on WS-Security authentication, then the device shall support this command. @@ -1204,16 +1204,16 @@ This command sets the device access security policy (for more details on the acc | ------ | ------ | | PolicyFile | [BinaryData](../interfaces/_api_types_.binarydata.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetCertificatesStatus -▸ **SetCertificatesStatus**(CertificateStatus: *[CertificateStatus](../interfaces/_api_types_.certificatestatus.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetCertificatesStatus**(CertificateStatus: *[CertificateStatus](../interfaces/_api_types_.certificatestatus.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1674](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1674)* +*Defined in [api/device.ts:1674](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1674)* This operation is specific to TLS functionality. This operation sets the status (enable/disable) of the device TLS server certificates. A device that supports TLS shall support this command. Typically only one device server certificate is allowed to be enabled at a time. @@ -1223,16 +1223,16 @@ This operation is specific to TLS functionality. This operation sets the status | ------ | ------ | | CertificateStatus | [CertificateStatus](../interfaces/_api_types_.certificatestatus.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetClientCertificateMode -▸ **SetClientCertificateMode**(Enabled: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetClientCertificateMode**(Enabled: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1737](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1737)* +*Defined in [api/device.ts:1737](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1737)* This operation is specific to TLS functionality. This operation sets the status (enabled/disabled) of the device TLS client authentication. A device that supports TLS shall support this command. @@ -1242,16 +1242,16 @@ This operation is specific to TLS functionality. This operation sets the status | ------ | ------ | | Enabled | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetDNS -▸ **SetDNS**(FromDHCP: *`boolean`*, SearchDomain: *`string`*, DNSManual: *[IPAddress](../interfaces/_api_types_.ipaddress.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetDNS**(FromDHCP: *`boolean`*, SearchDomain: *`string`*, DNSManual: *[IPAddress](../interfaces/_api_types_.ipaddress.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1460](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1460)* +*Defined in [api/device.ts:1460](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1460)* This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command. @@ -1263,16 +1263,16 @@ This operation sets the DNS settings on a device. It shall be possible to set th | SearchDomain | `string` | | DNSManual | [IPAddress](../interfaces/_api_types_.ipaddress.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetDPAddresses -▸ **SetDPAddresses**(DPAddress: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetDPAddresses**(DPAddress: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1327](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1327)* +*Defined in [api/device.ts:1327](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1327)* This operation sets the remote DP address or addresses on a device. If the device supports remote discovery, as specified in Section 7.4, the device shall support configuration of the remote DP address(es) through the SetDPAddresses command. @@ -1282,16 +1282,16 @@ This operation sets the remote DP address or addresses on a device. If the devic | ------ | ------ | | DPAddress | [NetworkHost](../interfaces/_api_types_.networkhost.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetDiscoveryMode -▸ **SetDiscoveryMode**(DiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetDiscoveryMode**(DiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1289](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1289)* +*Defined in [api/device.ts:1289](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1289)* 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. @@ -1301,16 +1301,16 @@ This operation sets the discovery mode operation of a device. See Section 7.2 fo | ------ | ------ | | DiscoveryMode | [DiscoveryMode](../enums/_api_types_.discoverymode.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetDot1XConfiguration -▸ **SetDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1862](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1862)* +*Defined in [api/device.ts:1862](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1862)* While the CreateDot1XConfiguration command is trying to create a new configuration parameter set, this operation modifies existing IEEE 802.1X configuration parameter set of the device. A device that support IEEE 802.1X shall support this command. @@ -1320,16 +1320,16 @@ While the CreateDot1XConfiguration command is trying to create a new configurati | ------ | ------ | | Dot1XConfiguration | [Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetDynamicDNS -▸ **SetDynamicDNS**(Type: *[DynamicDNSType](../enums/_api_types_.dynamicdnstype.md)*, Name: *[DNSName](../modules/_api_types_.md#dnsname)*, TTL: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetDynamicDNS**(Type: *[DynamicDNSType](../enums/_api_types_.dynamicdnstype.md)*, Name: *[DNSName](../modules/_api_types_.md#dnsname)*, TTL: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1498](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1498)* +*Defined in [api/device.ts:1498](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1498)* This operation sets the dynamic DNS settings on a device. If the device supports dynamic DNS as specified in \[RFC 2136\] and \[RFC 4702\], it shall be possible to set the type, name and TTL through the SetDynamicDNS command. @@ -1341,16 +1341,16 @@ This operation sets the dynamic DNS settings on a device. If the device supports | Name | [DNSName](../modules/_api_types_.md#dnsname) | | TTL | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetGeoLocation -▸ **SetGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:2044](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L2044)* +*Defined in [api/device.ts:2044](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L2044)* This operation allows to modify one or more geo configuration entries. @@ -1360,16 +1360,16 @@ This operation allows to modify one or more geo configuration entries. | ------ | ------ | | Location | [LocationEntity](../interfaces/_api_types_.locationentity.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetHostname -▸ **SetHostname**(Name: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetHostname**(Name: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1437](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1437)* +*Defined in [api/device.ts:1437](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1437)* This operation sets the hostname on a device. It shall be possible to set the device hostname configurations through the SetHostname command. A device shall accept string formated according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. @@ -1379,16 +1379,16 @@ This operation sets the hostname on a device. It shall be possible to set the de | ------ | ------ | | Name | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetHostnameFromDHCP -▸ **SetHostnameFromDHCP**(FromDHCP: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetHostnameFromDHCP**(FromDHCP: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1444](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1444)* +*Defined in [api/device.ts:1444](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1444)* This operation controls whether the hostname is set manually or retrieved via DHCP. @@ -1398,16 +1398,16 @@ This operation controls whether the hostname is set manually or retrieved via DH | ------ | ------ | | FromDHCP | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetIPAddressFilter -▸ **SetIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1587](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1587)* +*Defined in [api/device.ts:1587](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1587)* This operation sets the IP address filter settings on a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support configuration of IP filtering rules through the SetIPAddressFilter command. @@ -1417,16 +1417,16 @@ This operation sets the IP address filter settings on a device. If the device su | ------ | ------ | | IPAddressFilter | [IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetNTP -▸ **SetNTP**(FromDHCP: *`boolean`*, NTPManual: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetNTP**(FromDHCP: *`boolean`*, NTPManual: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1480](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1480)* +*Defined in [api/device.ts:1480](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1480)* This operation sets the NTP settings on a device. If the device supports NTP, it shall be possible to set the NTP server settings through the SetNTP command. A device shall accept string formated according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. Changes to the NTP server list will not affect the clock mode DateTimeType. Use SetSystemDateAndTime to activate NTP operation. @@ -1437,16 +1437,16 @@ This operation sets the NTP settings on a device. If the device supports NTP, it | FromDHCP | `boolean` | | NTPManual | [NetworkHost](../interfaces/_api_types_.networkhost.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetNetworkDefaultGateway -▸ **SetNetworkDefaultGateway**(IPv4Address: *[IPv4Address]()*, IPv6Address: *[IPv6Address]()*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetNetworkDefaultGateway**(IPv4Address: *[IPv4Address]()*, IPv6Address: *[IPv6Address]()*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1551](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1551)* +*Defined in [api/device.ts:1551](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1551)* This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command. @@ -1457,16 +1457,16 @@ This operation sets the default gateway settings on a device. The device shall s | IPv4Address | [IPv4Address]() | | IPv6Address | [IPv6Address]() | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetNetworkInterfaces -▸ **SetNetworkInterfaces**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, NetworkInterface: *[NetworkInterfaceSetConfiguration](../interfaces/_api_types_.networkinterfacesetconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetNetworkInterfaces**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, NetworkInterface: *[NetworkInterfaceSetConfiguration](../interfaces/_api_types_.networkinterfacesetconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1519](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1519)* +*Defined in [api/device.ts:1519](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1519)* 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. @@ -1477,16 +1477,16 @@ This operation sets the network interface configuration on a device. The device | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | NetworkInterface | [NetworkInterfaceSetConfiguration](../interfaces/_api_types_.networkinterfacesetconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetNetworkProtocols -▸ **SetNetworkProtocols**(NetworkProtocols: *[NetworkProtocol](../interfaces/_api_types_.networkprotocol.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetNetworkProtocols**(NetworkProtocols: *[NetworkProtocol](../interfaces/_api_types_.networkprotocol.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1535](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1535)* +*Defined in [api/device.ts:1535](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1535)* This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command. @@ -1496,16 +1496,16 @@ This operation configures defined network protocols on a device. The device shal | ------ | ------ | | NetworkProtocols | [NetworkProtocol](../interfaces/_api_types_.networkprotocol.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRelayOutputSettings -▸ **SetRelayOutputSettings**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Properties: *[RelayOutputSettings](../interfaces/_api_types_.relayoutputsettings.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRelayOutputSettings**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Properties: *[RelayOutputSettings](../interfaces/_api_types_.relayoutputsettings.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1753](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1753)* +*Defined in [api/device.ts:1753](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1753)* This operation sets the settings of a relay output. This method has been depricated with version 2.0. Refer to the DeviceIO service. @@ -1516,16 +1516,16 @@ This operation sets the settings of a relay output. This method has been deprica | RelayOutputToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Properties | [RelayOutputSettings](../interfaces/_api_types_.relayoutputsettings.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRelayOutputState -▸ **SetRelayOutputState**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, LogicalState: *[RelayLogicalState](../enums/_api_types_.relaylogicalstate.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRelayOutputState**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, LogicalState: *[RelayLogicalState](../enums/_api_types_.relaylogicalstate.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1761](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1761)* +*Defined in [api/device.ts:1761](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1761)* This operation sets the state of a relay output. This method has been depricated with version 2.0. Refer to the DeviceIO service. @@ -1536,16 +1536,16 @@ This operation sets the state of a relay output. This method has been depricated | RelayOutputToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | LogicalState | [RelayLogicalState](../enums/_api_types_.relaylogicalstate.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRemoteDiscoveryMode -▸ **SetRemoteDiscoveryMode**(RemoteDiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRemoteDiscoveryMode**(RemoteDiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1309](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1309)* +*Defined in [api/device.ts:1309](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1309)* This operation sets the remote discovery mode of operation of a device. See Section 7.4 for the definition of remote discovery remote extensions. A device that supports remote discovery shall support configuration of the discovery mode setting through the SetRemoteDiscoveryMode command. @@ -1555,16 +1555,16 @@ This operation sets the remote discovery mode of operation of a device. See Sect | ------ | ------ | | RemoteDiscoveryMode | [DiscoveryMode](../enums/_api_types_.discoverymode.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRemoteUser -▸ **SetRemoteUser**(RemoteUser: *[RemoteUser](../interfaces/_api_types_.remoteuser.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRemoteUser**(RemoteUser: *[RemoteUser](../interfaces/_api_types_.remoteuser.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1359](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1359)* +*Defined in [api/device.ts:1359](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1359)* This operation sets the remote user. A device supporting remote user handling shall support this operation. The user is only valid for the WS-UserToken profile or as a HTTP / RTSP user. The password that is set shall always be the original (not derived) password. If UseDerivedPassword is set password derivation shall be done by the device when connecting to a remote device.The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification. To remove the remote user SetRemoteUser should be called without the RemoteUser parameter. @@ -1574,16 +1574,16 @@ This operation sets the remote user. A device supporting remote user handling sh | ------ | ------ | | RemoteUser | [RemoteUser](../interfaces/_api_types_.remoteuser.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetScopes -▸ **SetScopes**(Scopes: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetScopes**(Scopes: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1251](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1251)* +*Defined in [api/device.ts:1251](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1251)* This operation sets the scope parameters of a device. The scope parameters are used in the device discovery to match a probe message. This operation replaces all existing configurable scope parameters (not fixed parameters). If this shall be avoided, one should use the scope add command instead. The device shall support configuration of discovery scope parameters through the SetScopes command. @@ -1593,16 +1593,16 @@ This operation sets the scope parameters of a device. The scope parameters are u | ------ | ------ | | Scopes | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetStorageConfiguration -▸ **SetStorageConfiguration**(StorageConfiguration: *`any`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetStorageConfiguration**(StorageConfiguration: *`any`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:2017](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L2017)* +*Defined in [api/device.ts:2017](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L2017)* This operation modifies an existing Storage configuration. @@ -1612,16 +1612,16 @@ This operation modifies an existing Storage configuration. | ------ | ------ | | StorageConfiguration | `any` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetSystemDateAndTime -▸ **SetSystemDateAndTime**(DateTimeType: *[SetDateTimeType](../enums/_api_types_.setdatetimetype.md)*, DaylightSavings: *`boolean`*, TimeZone: *[TimeZone](../interfaces/_api_types_.timezone.md)*, UTCDateTime: *[DateTime](../interfaces/_api_types_.datetime.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetSystemDateAndTime**(DateTimeType: *[SetDateTimeType](../enums/_api_types_.setdatetimetype.md)*, DaylightSavings: *`boolean`*, TimeZone: *[TimeZone](../interfaces/_api_types_.timezone.md)*, UTCDateTime: *[DateTime](../interfaces/_api_types_.datetime.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1155](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1155)* +*Defined in [api/device.ts:1155](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1155)* 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. @@ -1634,16 +1634,16 @@ This operation sets the device system date and time. The device shall support th | TimeZone | [TimeZone](../interfaces/_api_types_.timezone.md) | | UTCDateTime | [DateTime](../interfaces/_api_types_.datetime.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetSystemFactoryDefault -▸ **SetSystemFactoryDefault**(FactoryDefault: *[FactoryDefaultType](../enums/_api_types_.factorydefaulttype.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetSystemFactoryDefault**(FactoryDefault: *[FactoryDefaultType](../enums/_api_types_.factorydefaulttype.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1172](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1172)* +*Defined in [api/device.ts:1172](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1172)* This operation reloads the parameters on the device to their factory default values. @@ -1653,16 +1653,16 @@ This operation reloads the parameters on the device to their factory default val | ------ | ------ | | FactoryDefault | [FactoryDefaultType](../enums/_api_types_.factorydefaulttype.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetUser -▸ **SetUser**(User: *[User](../interfaces/_api_types_.user.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetUser**(User: *[User](../interfaces/_api_types_.user.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1400](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1400)* +*Defined in [api/device.ts:1400](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1400)* This operation updates the settings for one or several users on a device for authentication purposes. The device shall support update of device users and their credentials through the SetUser command. Either all change requests are processed successfully or a fault message shall be returned and no change requests be processed. @@ -1672,16 +1672,16 @@ This operation updates the settings for one or several users on a device for aut | ------ | ------ | | User | [User](../interfaces/_api_types_.user.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetZeroConfiguration -▸ **SetZeroConfiguration**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Enabled: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetZeroConfiguration**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Enabled: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1568](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1568)* +*Defined in [api/device.ts:1568](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1568)* This operation sets the zero-configuration. Use GetCapalities to get if zero-zero-configuration is supported or not. @@ -1692,59 +1692,59 @@ This operation sets the zero-configuration. Use GetCapalities to get if zero-zer | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Enabled | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### StartFirmwareUpgrade -▸ **StartFirmwareUpgrade**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **StartFirmwareUpgrade**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1958](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1958)* +*Defined in [api/device.ts:1958](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1958)* This operation initiates a firmware upgrade using the HTTP POST mechanism. The response to the command includes an HTTP URL to which the upgrade file may be uploaded. The actual upgrade takes place as soon as the HTTP POST operation has completed. The device should support firmware upgrade through the StartFirmwareUpgrade command. The exact format of the firmware data is outside the scope of this specification. Firmware upgrade over HTTP may be achieved using the following steps: Client calls StartFirmwareUpgrade. Server responds with upload URI and optional delay value. Client waits for delay duration if specified by server. Client transmits the firmware image to the upload URI using HTTP POST. Server reprograms itself using the uploaded image, then reboots. If the firmware upgrade fails because the upgrade file was invalid, the HTTP POST response shall be “415 Unsupported Media Type”. If the firmware upgrade fails due to an error at the device, the HTTP POST response shall be “500 Internal Server Error”. The value of the Content-Type header in the HTTP POST request shall be “application/octetstream”. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### StartSystemRestore -▸ **StartSystemRestore**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **StartSystemRestore**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1980](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1980)* +*Defined in [api/device.ts:1980](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1980)* This operation initiates a system restore from backed up configuration data using the HTTP POST mechanism. The response to the command includes an HTTP URL to which the backup file may be uploaded. The actual restore takes place as soon as the HTTP POST operation has completed. Devices should support system restore through the StartSystemRestore command. The exact format of the backup configuration data is outside the scope of this specification. System restore over HTTP may be achieved using the following steps: Client calls StartSystemRestore. Server responds with upload URI. Client transmits the configuration data to the upload URI using HTTP POST. Server applies the uploaded configuration, then reboots if necessary. If the system restore fails because the uploaded file was invalid, the HTTP POST response shall be “415 Unsupported Media Type”. If the system restore fails due to an error at the device, the HTTP POST response shall be “500 Internal Server Error”. The value of the Content-Type header in the HTTP POST request shall be “application/octetstream”. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SystemReboot -▸ **SystemReboot**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SystemReboot**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1189](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1189)* +*Defined in [api/device.ts:1189](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1189)* This operation reboots the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### UpgradeSystemFirmware -▸ **UpgradeSystemFirmware**(Firmware: *[AttachmentData](../interfaces/_api_types_.attachmentdata.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **UpgradeSystemFirmware**(Firmware: *[AttachmentData](../interfaces/_api_types_.attachmentdata.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/device.ts:1182](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1182)* +*Defined in [api/device.ts:1182](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1182)* This operation upgrades a device firmware version. After a successful upgrade the response message is sent before the device reboots. The device should support firmware upgrade through the UpgradeSystemFirmware command. The exact format of the firmware data is outside the scope of this standard. @@ -1754,16 +1754,16 @@ This operation upgrades a device firmware version. After a successful upgrade th | ------ | ------ | | Firmware | [AttachmentData](../interfaces/_api_types_.attachmentdata.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` AddIPAddressFilter -▸ **AddIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:582](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L582)* +*Defined in [api/device.ts:582](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L582)* This operation adds an IP filter address to a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support adding of IP filtering addresses through the AddIPAddressFilter command. @@ -1773,16 +1773,16 @@ This operation adds an IP filter address to a device. If the device supports dev | ------ | ------ | | IPAddressFilter | [IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddScopes -▸ **AddScopes**(ScopeItem: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddScopes**(ScopeItem: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:174](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L174)* +*Defined in [api/device.ts:174](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L174)* 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. @@ -1792,16 +1792,16 @@ This operation adds new configurable scope parameters to a device. The scope par | ------ | ------ | | ScopeItem | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateCertificate -▸ **CreateCertificate**(CertificateID?: *`undefined` \| `string`*, Subject?: *`undefined` \| `string`*, ValidNotBefore?: *`undefined` \| `string`*, ValidNotAfter?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateCertificate**(CertificateID?: *`undefined` \| `string`*, Subject?: *`undefined` \| `string`*, ValidNotBefore?: *`undefined` \| `string`*, ValidNotAfter?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:637](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L637)* +*Defined in [api/device.ts:637](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L637)* This operation generates a private/public key pair and also can create a self-signed device certificate as a result of key pair generation. The certificate is created using a suitable onboard key pair generation mechanism. If a device supports onboard key pair generation, the device that supports TLS shall support this certificate creation command. And also, if a device supports onboard key pair generation, the device that support IEEE 802.1X shall support this command for the purpose of key pair generation. Certificates and key pairs are identified using certificate IDs. These IDs are either chosen by the certificate generation requester or by the device (in case that no ID value is given). @@ -1814,16 +1814,16 @@ This operation generates a private/public key pair and also can create a self-si | `Optional` ValidNotBefore | `undefined` \| `string` | | `Optional` ValidNotAfter | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateDot1XConfiguration -▸ **CreateDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:881](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L881)* +*Defined in [api/device.ts:881](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L881)* This operation newly creates IEEE 802.1X configuration parameter set of the device. The device shall support this command if it supports IEEE 802.1X. If the device receives this request with already existing configuration token (Dot1XConfigurationToken) specification, the device should respond with 'ter:ReferenceToken ' error to indicate there is some configuration conflict. @@ -1833,16 +1833,16 @@ This operation newly creates IEEE 802.1X configuration parameter set of the devi | ------ | ------ | | Dot1XConfiguration | [Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateStorageConfiguration -▸ **CreateStorageConfiguration**(StorageConfiguration: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateStorageConfiguration**(StorageConfiguration: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1051](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1051)* +*Defined in [api/device.ts:1051](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1051)* This operation creates a new storage configuration. The configuration data shall be created in the device and shall be persistent (remain after reboot). @@ -1852,16 +1852,16 @@ This operation creates a new storage configuration. The configuration data shall | ------ | ------ | | StorageConfiguration | `any` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateUsers -▸ **CreateUsers**(User: *[User](../interfaces/_api_types_.user.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateUsers**(User: *[User](../interfaces/_api_types_.user.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:319](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L319)* +*Defined in [api/device.ts:319](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L319)* 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. @@ -1871,16 +1871,16 @@ This operation creates new device users and corresponding credentials on a devic | ------ | ------ | | User | [User](../interfaces/_api_types_.user.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteCertificates -▸ **DeleteCertificates**(CertificateID: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteCertificates**(CertificateID: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:687](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L687)* +*Defined in [api/device.ts:687](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L687)* This operation deletes a certificate or multiple certificates. The device MAY also delete a private/public key pair which is coupled with the certificate to be deleted. The device that support either TLS or IEEE 802.1X shall support the deletion of a certificate or multiple certificates through this command. Either all certificates are deleted successfully or a fault message shall be returned without deleting any certificate. @@ -1890,16 +1890,16 @@ This operation deletes a certificate or multiple certificates. The device MAY al | ------ | ------ | | CertificateID | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteDot1XConfiguration -▸ **DeleteDot1XConfiguration**(Dot1XConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteDot1XConfiguration**(Dot1XConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:930](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L930)* +*Defined in [api/device.ts:930](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L930)* This operation deletes an IEEE 802.1X configuration parameter set from the device. Which configuration should be deleted is specified by the 'Dot1XConfigurationToken' in the request. A device that support IEEE 802.1X shall support this command. @@ -1909,16 +1909,16 @@ This operation deletes an IEEE 802.1X configuration parameter set from the devic | ------ | ------ | | `Optional` Dot1XConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteGeoLocation -▸ **DeleteGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1117](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1117)* +*Defined in [api/device.ts:1117](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1117)* This operation deletes the given geo location entries. @@ -1928,16 +1928,16 @@ This operation deletes the given geo location entries. | ------ | ------ | | Location | [LocationEntity](../interfaces/_api_types_.locationentity.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteStorageConfiguration -▸ **DeleteStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1084](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1084)* +*Defined in [api/device.ts:1084](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1084)* This operation deletes the given storage configuration and configuration change shall always be persistent. @@ -1947,16 +1947,16 @@ This operation deletes the given storage configuration and configuration change | ------ | ------ | | Token | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteUsers -▸ **DeleteUsers**(Username: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteUsers**(Username: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:331](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L331)* +*Defined in [api/device.ts:331](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L331)* 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. @@ -1966,42 +1966,42 @@ This operation deletes users on a device. The device shall support deletion of d | ------ | ------ | | Username | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAccessPolicy -▸ **GetAccessPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAccessPolicy**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:609](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L609)* +*Defined in [api/device.ts:609](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L609)* Access to different services and sub-sets of services should be subject to access control. The WS-Security framework gives the prerequisite for end-point authentication. Authorization decisions can then be taken using an access security policy. This standard does not mandate any particular policy description format or security policy but this is up to the device manufacturer or system provider to choose policy and policy description format of choice. However, an access policy (in arbitrary format) can be requested using this command. If the device supports access policy settings based on WS-Security authentication, then the device shall support this command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCACertificates -▸ **GetCACertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCACertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:816](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L816)* +*Defined in [api/device.ts:816](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L816)* CA certificates will be loaded into a device and be used for the sake of following two cases. The one is for the purpose of TLS client authentication in TLS server function. The other one is for the purpose of Authentication Server authentication in IEEE 802.1X function. This operation gets all CA certificates loaded into a device. A device that supports either TLS client authentication or IEEE 802.1X shall support this command and the returned certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCapabilities -▸ **GetCapabilities**(Category?: *[CapabilityCategory](../enums/_api_types_.capabilitycategory.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCapabilities**(Category?: *[CapabilityCategory](../enums/_api_types_.capabilitycategory.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:364](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L364)* +*Defined in [api/device.ts:364](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L364)* This method has been replaced by the more generic GetServices method. For capabilities of individual services refer to the GetServiceCapabilities methods. @@ -2011,16 +2011,16 @@ This method has been replaced by the more generic GetServices method. For capabi | ------ | ------ | | `Optional` Category | [CapabilityCategory](../enums/_api_types_.capabilitycategory.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCertificateInformation -▸ **GetCertificateInformation**(CertificateID: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCertificateInformation**(CertificateID: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:851](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L851)* +*Defined in [api/device.ts:851](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L851)* This operation requests the information of a certificate specified by certificate ID. The device should respond with its “Issuer DN”, “Subject DN”, “Key usage”, "Extended key usage”, “Key Length”, “Version”, “Serial Number”, “Signature Algorithm” and “Validity” data as the information of the certificate, as long as the device can retrieve such information from the specified certificate. A device that supports either TLS or IEEE 802.1X should support this command. @@ -2030,120 +2030,120 @@ This operation requests the information of a certificate specified by certificat | ------ | ------ | | CertificateID | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCertificates -▸ **GetCertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCertificates**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:652](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L652)* +*Defined in [api/device.ts:652](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L652)* This operation gets all device server certificates (including self-signed) for the purpose of TLS authentication and all device client certificates for the purpose of IEEE 802.1X authentication. This command lists only the TLS server certificates and IEEE 802.1X client certificates for the device (neither trusted CA certificates nor trusted root certificates). The certificates are returned as binary data. A device that supports TLS shall support this command and the certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCertificatesStatus -▸ **GetCertificatesStatus**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCertificatesStatus**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:663](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L663)* +*Defined in [api/device.ts:663](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L663)* This operation is specific to TLS functionality. This operation gets the status (enabled/disabled) of the device TLS server certificates. A device that supports TLS shall support this command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetClientCertificateMode -▸ **GetClientCertificateMode**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetClientCertificateMode**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:736](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L736)* +*Defined in [api/device.ts:736](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L736)* This operation is specific to TLS functionality. This operation gets the status (enabled/disabled) of the device TLS client authentication. A device that supports TLS shall support this command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDNS -▸ **GetDNS**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDNS**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:406](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L406)* +*Defined in [api/device.ts:406](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L406)* This operation gets the DNS settings from a device. The device shall return its DNS configurations through the GetDNS command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDPAddresses -▸ **GetDPAddresses**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDPAddresses**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:244](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L244)* +*Defined in [api/device.ts:244](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L244)* This operation gets the remote DP address or addresses from a device. If the device supports remote discovery, as specified in Section 7.4, the device shall support retrieval of the remote DP address(es) through the GetDPAddresses command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDeviceInformation -▸ **GetDeviceInformation**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDeviceInformation**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L30)* +*Defined in [api/device.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L30)* This operation gets basic device information from the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDiscoveryMode -▸ **GetDiscoveryMode**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDiscoveryMode**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:198](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L198)* +*Defined in [api/device.ts:198](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L198)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDot11Capabilities -▸ **GetDot11Capabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDot11Capabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:940](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L940)* +*Defined in [api/device.ts:940](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L940)* This operation returns the IEEE802.11 capabilities. The device shall support this operation. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDot11Status -▸ **GetDot11Status**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDot11Status**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:950](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L950)* +*Defined in [api/device.ts:950](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L950)* This operation returns the status of a wireless network interface. The device shall support this command. @@ -2153,16 +2153,16 @@ This operation returns the status of a wireless network interface. The device sh | ------ | ------ | | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDot1XConfiguration -▸ **GetDot1XConfiguration**(Dot1XConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDot1XConfiguration**(Dot1XConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:905](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L905)* +*Defined in [api/device.ts:905](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L905)* This operation gets one IEEE 802.1X configuration parameter set from the device by specifying the configuration token (Dot1XConfigurationToken). A device that supports IEEE 802.1X shall support this command. Regardless of whether the 802.1X method in the retrieved configuration has a password or not, the device shall not include the Password element in the response. @@ -2172,146 +2172,146 @@ This operation gets one IEEE 802.1X configuration parameter set from the device | ------ | ------ | | Dot1XConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDot1XConfigurations -▸ **GetDot1XConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDot1XConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:919](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L919)* +*Defined in [api/device.ts:919](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L919)* This operation gets all the existing IEEE 802.1X configuration parameter sets from the device. The device shall respond with all the IEEE 802.1X configurations so that the client can get to know how many IEEE 802.1X configurations are existing and how they are configured. A device that support IEEE 802.1X shall support this command. Regardless of whether the 802.1X method in the retrieved configuration has a password or not, the device shall not include the Password element in the response. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDynamicDNS -▸ **GetDynamicDNS**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDynamicDNS**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:451](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L451)* +*Defined in [api/device.ts:451](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L451)* This operation gets the dynamic DNS settings from a device. If the device supports dynamic DNS as specified in \[RFC 2136\] and \[RFC 4702\], it shall be possible to get the type, name and TTL through the GetDynamicDNS command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetEndpointReference -▸ **GetEndpointReference**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetEndpointReference**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:267](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L267)* +*Defined in [api/device.ts:267](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L267)* A client can ask for the device service endpoint reference address property that can be used to derive the password equivalent for remote user operation. The device shall support the GetEndpointReference command returning the address property of the device service endpoint reference. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetGeoLocation -▸ **GetGeoLocation**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetGeoLocation**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1095](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1095)* +*Defined in [api/device.ts:1095](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1095)* This operation lists all existing geo location configurations for the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetHostname -▸ **GetHostname**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetHostname**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:374](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L374)* +*Defined in [api/device.ts:374](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L374)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetIPAddressFilter -▸ **GetIPAddressFilter**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetIPAddressFilter**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:559](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L559)* +*Defined in [api/device.ts:559](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L559)* This operation gets the IP address filter settings from a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support the GetIPAddressFilter command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNTP -▸ **GetNTP**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNTP**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:426](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L426)* +*Defined in [api/device.ts:426](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L426)* This operation gets the NTP settings from a device. If the device supports NTP, it shall be possible to get the NTP server settings through the GetNTP command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNetworkDefaultGateway -▸ **GetNetworkDefaultGateway**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNetworkDefaultGateway**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:517](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L517)* +*Defined in [api/device.ts:517](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L517)* This operation gets the default gateway settings from a device. The device shall support the GetNetworkDefaultGateway command returning configured default gateway address(es). -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNetworkInterfaces -▸ **GetNetworkInterfaces**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNetworkInterfaces**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:473](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L473)* +*Defined in [api/device.ts:473](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L473)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNetworkProtocols -▸ **GetNetworkProtocols**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNetworkProtocols**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:497](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L497)* +*Defined in [api/device.ts:497](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L497)* This operation gets defined network protocols from a device. The device shall support the GetNetworkProtocols command returning configured network protocols. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPkcs10Request -▸ **GetPkcs10Request**(CertificateID: *`string`*, Subject?: *`undefined` \| `string`*, Attributes?: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPkcs10Request**(CertificateID: *`string`*, Subject?: *`undefined` \| `string`*, Attributes?: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:703](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L703)* +*Defined in [api/device.ts:703](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L703)* This operation requests a PKCS #10 certificate signature request from the device. The returned information field shall be either formatted exactly as specified in \[PKCS#10\] or PEM encoded \[PKCS#10\] format. In order for this command to work, the device must already have a private/public key pair. This key pair should be referred by CertificateID as specified in the input parameter description. This CertificateID refers to the key pair generated using CreateCertificate command. A device that support onboard key pair generation that supports either TLS or IEEE 802.1X using client certificate shall support this command. @@ -2323,83 +2323,83 @@ This operation requests a PKCS #10 certificate signature request from the device | `Optional` Subject | `undefined` \| `string` | | `Optional` Attributes | [BinaryData](../interfaces/_api_types_.binarydata.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRelayOutputs -▸ **GetRelayOutputs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRelayOutputs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:757](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L757)* +*Defined in [api/device.ts:757](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L757)* This operation gets a list of all available relay outputs and their settings. This method has been depricated with version 2.0. Refer to the DeviceIO service. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRemoteDiscoveryMode -▸ **GetRemoteDiscoveryMode**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRemoteDiscoveryMode**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:221](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L221)* +*Defined in [api/device.ts:221](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L221)* This operation gets the remote discovery mode of a device. See Section 7.4 for the definition of remote discovery extensions. A device that supports remote discovery shall support retrieval of the remote discovery mode setting through the GetRemoteDiscoveryMode command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRemoteUser -▸ **GetRemoteUser**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRemoteUser**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:279](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L279)* +*Defined in [api/device.ts:279](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L279)* This operation returns the configured remote user (if any). A device supporting remote user handling shall support this operation. The user is only valid for the WS-UserToken profile or as a HTTP / RTSP user. The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetScopes -▸ **GetScopes**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetScopes**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:150](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L150)* +*Defined in [api/device.ts:150](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L150)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L21)* +*Defined in [api/device.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L21)* Returns the capabilities of the device service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServices -▸ **GetServices**(IncludeCapability: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServices**(IncludeCapability: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L12)* +*Defined in [api/device.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L12)* Returns information about services on the device. @@ -2409,16 +2409,16 @@ Returns information about services on the device. | ------ | ------ | | IncludeCapability | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetStorageConfiguration -▸ **GetStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetStorageConfiguration**(Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1062](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1062)* +*Defined in [api/device.ts:1062](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1062)* This operation retrieves the Storage configuration associated with the given storage configuration token. @@ -2428,55 +2428,55 @@ This operation retrieves the Storage configuration associated with the given sto | ------ | ------ | | Token | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetStorageConfigurations -▸ **GetStorageConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetStorageConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1039](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1039)* +*Defined in [api/device.ts:1039](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1039)* This operation lists all existing storage configurations for the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSystemBackup -▸ **GetSystemBackup**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSystemBackup**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:114](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L114)* +*Defined in [api/device.ts:114](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L114)* This operation is retrieves system backup configuration file(s) from a device. The device should support return of back up configuration file(s) through the GetSystemBackup command. The backup is returned with reference to a name and mime-type together with binary data. The exact format of the backup configuration files is outside the scope of this standard. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSystemDateAndTime -▸ **GetSystemDateAndTime**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSystemDateAndTime**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L59)* +*Defined in [api/device.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L59)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSystemLog -▸ **GetSystemLog**(LogType: *[SystemLogType](../enums/_api_types_.systemlogtype.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSystemLog**(LogType: *[SystemLogType](../enums/_api_types_.systemlogtype.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:123](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L123)* +*Defined in [api/device.ts:123](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L123)* This operation gets a system log from the device. The exact format of the system logs is outside the scope of this standard. @@ -2486,81 +2486,81 @@ This operation gets a system log from the device. The exact format of the system | ------ | ------ | | LogType | [SystemLogType](../enums/_api_types_.systemlogtype.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSystemSupportInformation -▸ **GetSystemSupportInformation**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSystemSupportInformation**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:132](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L132)* +*Defined in [api/device.ts:132](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L132)* This operation gets arbitary device diagnostics information from the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSystemUris -▸ **GetSystemUris**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSystemUris**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:980](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L980)* +*Defined in [api/device.ts:980](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L980)* This operation is used to retrieve URIs from which system information may be downloaded using HTTP. URIs may be returned for the following system information: System Logs. Multiple system logs may be returned, of different types. The exact format of the system logs is outside the scope of this specification. Support Information. This consists of arbitrary device diagnostics information from a device. The exact format of the diagnostic information is outside the scope of this specification. System Backup. The received file is a backup file that can be used to restore the current device configuration at a later date. The exact format of the backup configuration file is outside the scope of this specification. If the device allows retrieval of system logs, support information or system backup data, it should make them available via HTTP GET. If it does, it shall support the GetSystemUris command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetUsers -▸ **GetUsers**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetUsers**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:304](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L304)* +*Defined in [api/device.ts:304](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L304)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetWsdlUrl -▸ **GetWsdlUrl**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetWsdlUrl**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:354](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L354)* +*Defined in [api/device.ts:354](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L354)* It is possible for an endpoint to request a URL that can be used to retrieve the complete schema and WSDL definitions of a device. The command gives in return a URL entry point where all the necessary product specific WSDL and schema definitions can be retrieved. The device shall provide a URL for WSDL and schema download through the GetWsdlUrl command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetZeroConfiguration -▸ **GetZeroConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetZeroConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:539](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L539)* +*Defined in [api/device.ts:539](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L539)* This operation gets the zero-configuration from a device. If the device supports dynamic IP configuration according to \[RFC3927\], it shall support the return of IPv4 zero configuration address and status through the GetZeroConfiguration command. Devices supporting zero configuration on more than one interface shall use the extension to list the additional interface settings. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` LoadCACertificates -▸ **LoadCACertificates**(CACertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **LoadCACertificates**(CACertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:868](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L868)* +*Defined in [api/device.ts:868](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L868)* This command is used when it is necessary to load trusted CA certificates or trusted root certificates for the purpose of verification for its counterpart i.e. client certificate verification in TLS function or server certificate verification in IEEE 802.1X function. A device that support either TLS or IEEE 802.1X shall support this command. As for the supported certificate format, either DER format or PEM format is possible to be used. But a device that support this command shall support at least DER format as supported format type. The device may sort the received certificate(s) based on the public key and subject information in the certificate(s). Either all CA certificates are loaded successfully or a fault message shall be returned without loading any CA certificate. @@ -2570,16 +2570,16 @@ This command is used when it is necessary to load trusted CA certificates or tru | ------ | ------ | | CACertificate | [Certificate](../interfaces/_api_types_.certificate.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` LoadCertificateWithPrivateKey -▸ **LoadCertificateWithPrivateKey**(CertificateWithPrivateKey: *[CertificateWithPrivateKey](../interfaces/_api_types_.certificatewithprivatekey.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **LoadCertificateWithPrivateKey**(CertificateWithPrivateKey: *[CertificateWithPrivateKey](../interfaces/_api_types_.certificatewithprivatekey.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:837](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L837)* +*Defined in [api/device.ts:837](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L837)* There might be some cases that a Certificate Authority or some other equivalent creates a certificate without having PKCS#10 certificate signing request. In such cases, the certificate will be bundled in conjunction with its private key. This command will be used for such use case scenarios. The certificate ID in the request is optionally set to the ID value the client wish to have. If the certificate ID is not specified in the request, device can choose the ID accordingly. This operation imports a private/public key pair into the device. The certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. A device that does not support onboard key pair generation and support either TLS or IEEE 802.1X using client certificate shall support this command. A device that support onboard key pair generation MAY support this command. The security policy of a device that supports this operation should make sure that the private key is sufficiently protected. @@ -2589,16 +2589,16 @@ There might be some cases that a Certificate Authority or some other equivalent | ------ | ------ | | CertificateWithPrivateKey | [CertificateWithPrivateKey](../interfaces/_api_types_.certificatewithprivatekey.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` LoadCertificates -▸ **LoadCertificates**(NVTCertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **LoadCertificates**(NVTCertificate: *[Certificate](../interfaces/_api_types_.certificate.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:725](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L725)* +*Defined in [api/device.ts:725](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L725)* TLS server certificate(s) or IEEE 802.1X client certificate(s) created using the PKCS#10 certificate request command can be loaded into the device using this command (see Section 8.4.13). The certificate ID in the request shall be present. The device may sort the received certificate(s) based on the public key and subject information in the certificate(s). The certificate ID in the request will be the ID value the client wish to have. The device is supposed to scan the generated key pairs present in the device to identify which is the correspondent key pair with the loaded certificate and then make the link between the certificate and the key pair. A device that supports onboard key pair generation that support either TLS or IEEE 802.1X shall support this command. The certificates shall be encoded using ASN.1 \[X.681\], \[X.682\], \[X.683\] DER \[X.690\] encoding rules. This command is applicable to any device type, although the parameter name is called for historical reasons NVTCertificate. @@ -2608,16 +2608,16 @@ TLS server certificate(s) or IEEE 802.1X client certificate(s) created using the | ------ | ------ | | NVTCertificate | [Certificate](../interfaces/_api_types_.certificate.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveIPAddressFilter -▸ **RemoveIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:593](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L593)* +*Defined in [api/device.ts:593](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L593)* This operation deletes an IP filter address from a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support deletion of IP filtering addresses through the RemoveIPAddressFilter command. @@ -2627,16 +2627,16 @@ This operation deletes an IP filter address from a device. If the device support | ------ | ------ | | IPAddressFilter | [IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveScopes -▸ **RemoveScopes**(ScopeItem: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveScopes**(ScopeItem: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:187](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L187)* +*Defined in [api/device.ts:187](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L187)* This operation deletes scope-configurable scope parameters from a device. The scope parameters are used in the device discovery to match a probe message, see Section 7. The device shall support deletion of discovery scope parameters through the RemoveScopes command. Table @@ -2646,16 +2646,16 @@ This operation deletes scope-configurable scope parameters from a device. The sc | ------ | ------ | | ScopeItem | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RestoreSystem -▸ **RestoreSystem**(BackupFiles: *[BackupFile](../interfaces/_api_types_.backupfile.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RestoreSystem**(BackupFiles: *[BackupFile](../interfaces/_api_types_.backupfile.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L102)* +*Defined in [api/device.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L102)* This operation restores the system backup configuration files(s) previously retrieved from a device. The device should support restore of backup configuration file(s) through the RestoreSystem command. The exact format of the backup configuration file(s) is outside the scope of this standard. If the command is supported, it shall accept backup files returned by the GetSystemBackup command. @@ -2665,16 +2665,16 @@ This operation restores the system backup configuration files(s) previously retr | ------ | ------ | | BackupFiles | [BackupFile](../interfaces/_api_types_.backupfile.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ScanAvailableDot11Networks -▸ **ScanAvailableDot11Networks**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ScanAvailableDot11Networks**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:960](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L960)* +*Defined in [api/device.ts:960](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L960)* This operation returns a lists of the wireless networks in range of the device. A device should support this operation. @@ -2684,16 +2684,16 @@ This operation returns a lists of the wireless networks in range of the device. | ------ | ------ | | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SendAuxiliaryCommand -▸ **SendAuxiliaryCommand**(AuxiliaryCommand: *[AuxiliaryData](../modules/_api_types_.md#auxiliarydata)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SendAuxiliaryCommand**(AuxiliaryCommand: *[AuxiliaryData](../modules/_api_types_.md#auxiliarydata)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:802](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L802)* +*Defined in [api/device.ts:802](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L802)* 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. @@ -2707,16 +2707,16 @@ A device that indicates auxiliary service capability shall support this command. | ------ | ------ | | AuxiliaryCommand | [AuxiliaryData](../modules/_api_types_.md#auxiliarydata) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetAccessPolicy -▸ **SetAccessPolicy**(PolicyFile: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetAccessPolicy**(PolicyFile: *[BinaryData](../interfaces/_api_types_.binarydata.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:620](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L620)* +*Defined in [api/device.ts:620](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L620)* This command sets the device access security policy (for more details on the access security policy see the Get command). If the device supports access policy settings based on WS-Security authentication, then the device shall support this command. @@ -2726,16 +2726,16 @@ This command sets the device access security policy (for more details on the acc | ------ | ------ | | PolicyFile | [BinaryData](../interfaces/_api_types_.binarydata.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetCertificatesStatus -▸ **SetCertificatesStatus**(CertificateStatus?: *[CertificateStatus]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetCertificatesStatus**(CertificateStatus?: *[CertificateStatus]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:674](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L674)* +*Defined in [api/device.ts:674](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L674)* This operation is specific to TLS functionality. This operation sets the status (enable/disable) of the device TLS server certificates. A device that supports TLS shall support this command. Typically only one device server certificate is allowed to be enabled at a time. @@ -2745,16 +2745,16 @@ This operation is specific to TLS functionality. This operation sets the status | ------ | ------ | | `Optional` CertificateStatus | [CertificateStatus]() | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetClientCertificateMode -▸ **SetClientCertificateMode**(Enabled: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetClientCertificateMode**(Enabled: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:747](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L747)* +*Defined in [api/device.ts:747](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L747)* This operation is specific to TLS functionality. This operation sets the status (enabled/disabled) of the device TLS client authentication. A device that supports TLS shall support this command. @@ -2764,16 +2764,16 @@ This operation is specific to TLS functionality. This operation sets the status | ------ | ------ | | Enabled | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetDNS -▸ **SetDNS**(FromDHCP: *`boolean`*, SearchDomain?: *`undefined` \| `string`*, DNSManual?: *[IPAddress](../interfaces/_api_types_.ipaddress.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetDNS**(FromDHCP: *`boolean`*, SearchDomain?: *`undefined` \| `string`*, DNSManual?: *[IPAddress](../interfaces/_api_types_.ipaddress.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:416](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L416)* +*Defined in [api/device.ts:416](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L416)* This operation sets the DNS settings on a device. It shall be possible to set the device DNS configurations through the SetDNS command. @@ -2785,16 +2785,16 @@ This operation sets the DNS settings on a device. It shall be possible to set th | `Optional` SearchDomain | `undefined` \| `string` | | `Optional` DNSManual | [IPAddress](../interfaces/_api_types_.ipaddress.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetDPAddresses -▸ **SetDPAddresses**(DPAddress?: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetDPAddresses**(DPAddress?: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:255](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L255)* +*Defined in [api/device.ts:255](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L255)* This operation sets the remote DP address or addresses on a device. If the device supports remote discovery, as specified in Section 7.4, the device shall support configuration of the remote DP address(es) through the SetDPAddresses command. @@ -2804,16 +2804,16 @@ This operation sets the remote DP address or addresses on a device. If the devic | ------ | ------ | | `Optional` DPAddress | [NetworkHost](../interfaces/_api_types_.networkhost.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetDiscoveryMode -▸ **SetDiscoveryMode**(DiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetDiscoveryMode**(DiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:209](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L209)* +*Defined in [api/device.ts:209](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L209)* 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. @@ -2823,16 +2823,16 @@ This operation sets the discovery mode operation of a device. See Section 7.2 fo | ------ | ------ | | DiscoveryMode | [DiscoveryMode](../enums/_api_types_.discoverymode.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetDot1XConfiguration -▸ **SetDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetDot1XConfiguration**(Dot1XConfiguration: *[Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:892](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L892)* +*Defined in [api/device.ts:892](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L892)* While the CreateDot1XConfiguration command is trying to create a new configuration parameter set, this operation modifies existing IEEE 802.1X configuration parameter set of the device. A device that support IEEE 802.1X shall support this command. @@ -2842,16 +2842,16 @@ While the CreateDot1XConfiguration command is trying to create a new configurati | ------ | ------ | | Dot1XConfiguration | [Dot1XConfiguration](../interfaces/_api_types_.dot1xconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetDynamicDNS -▸ **SetDynamicDNS**(Type: *[DynamicDNSType](../enums/_api_types_.dynamicdnstype.md)*, Name?: *[DNSName](../modules/_api_types_.md#dnsname)*, TTL?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetDynamicDNS**(Type: *[DynamicDNSType](../enums/_api_types_.dynamicdnstype.md)*, Name?: *[DNSName](../modules/_api_types_.md#dnsname)*, TTL?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:462](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L462)* +*Defined in [api/device.ts:462](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L462)* This operation sets the dynamic DNS settings on a device. If the device supports dynamic DNS as specified in \[RFC 2136\] and \[RFC 4702\], it shall be possible to set the type, name and TTL through the SetDynamicDNS command. @@ -2863,16 +2863,16 @@ This operation sets the dynamic DNS settings on a device. If the device supports | `Optional` Name | [DNSName](../modules/_api_types_.md#dnsname) | | `Optional` TTL | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetGeoLocation -▸ **SetGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetGeoLocation**(Location: *[LocationEntity](../interfaces/_api_types_.locationentity.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1106](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1106)* +*Defined in [api/device.ts:1106](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1106)* This operation allows to modify one or more geo configuration entries. @@ -2882,16 +2882,16 @@ This operation allows to modify one or more geo configuration entries. | ------ | ------ | | Location | [LocationEntity](../interfaces/_api_types_.locationentity.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetHostname -▸ **SetHostname**(Name: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetHostname**(Name: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:387](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L387)* +*Defined in [api/device.ts:387](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L387)* This operation sets the hostname on a device. It shall be possible to set the device hostname configurations through the SetHostname command. A device shall accept string formated according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. @@ -2901,16 +2901,16 @@ This operation sets the hostname on a device. It shall be possible to set the de | ------ | ------ | | Name | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetHostnameFromDHCP -▸ **SetHostnameFromDHCP**(FromDHCP: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetHostnameFromDHCP**(FromDHCP: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:396](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L396)* +*Defined in [api/device.ts:396](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L396)* This operation controls whether the hostname is set manually or retrieved via DHCP. @@ -2920,16 +2920,16 @@ This operation controls whether the hostname is set manually or retrieved via DH | ------ | ------ | | FromDHCP | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetIPAddressFilter -▸ **SetIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetIPAddressFilter**(IPAddressFilter: *[IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:571](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L571)* +*Defined in [api/device.ts:571](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L571)* This operation sets the IP address filter settings on a device. If the device supports device access control based on IP filtering rules (denied or accepted ranges of IP addresses), the device shall support configuration of IP filtering rules through the SetIPAddressFilter command. @@ -2939,16 +2939,16 @@ This operation sets the IP address filter settings on a device. If the device su | ------ | ------ | | IPAddressFilter | [IPAddressFilter](../interfaces/_api_types_.ipaddressfilter.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetNTP -▸ **SetNTP**(FromDHCP: *`boolean`*, NTPManual?: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetNTP**(FromDHCP: *`boolean`*, NTPManual?: *[NetworkHost](../interfaces/_api_types_.networkhost.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:440](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L440)* +*Defined in [api/device.ts:440](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L440)* This operation sets the NTP settings on a device. If the device supports NTP, it shall be possible to set the NTP server settings through the SetNTP command. A device shall accept string formated according to RFC 1123 section 2.1 or alternatively to RFC 952, other string shall be considered as invalid strings. Changes to the NTP server list will not affect the clock mode DateTimeType. Use SetSystemDateAndTime to activate NTP operation. @@ -2959,16 +2959,16 @@ This operation sets the NTP settings on a device. If the device supports NTP, it | FromDHCP | `boolean` | | `Optional` NTPManual | [NetworkHost](../interfaces/_api_types_.networkhost.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetNetworkDefaultGateway -▸ **SetNetworkDefaultGateway**(IPv4Address?: *[IPv4Address]()*, IPv6Address?: *[IPv6Address]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetNetworkDefaultGateway**(IPv4Address?: *[IPv4Address]()*, IPv6Address?: *[IPv6Address]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:527](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L527)* +*Defined in [api/device.ts:527](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L527)* This operation sets the default gateway settings on a device. The device shall support configuration of default gateway through the SetNetworkDefaultGateway command. @@ -2979,16 +2979,16 @@ This operation sets the default gateway settings on a device. The device shall s | `Optional` IPv4Address | [IPv4Address]() | | `Optional` IPv6Address | [IPv6Address]() | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetNetworkInterfaces -▸ **SetNetworkInterfaces**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, NetworkInterface: *[NetworkInterfaceSetConfiguration](../interfaces/_api_types_.networkinterfacesetconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetNetworkInterfaces**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, NetworkInterface: *[NetworkInterfaceSetConfiguration](../interfaces/_api_types_.networkinterfacesetconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:487](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L487)* +*Defined in [api/device.ts:487](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L487)* 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. @@ -2999,16 +2999,16 @@ This operation sets the network interface configuration on a device. The device | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | NetworkInterface | [NetworkInterfaceSetConfiguration](../interfaces/_api_types_.networkinterfacesetconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetNetworkProtocols -▸ **SetNetworkProtocols**(NetworkProtocols: *[NetworkProtocol](../interfaces/_api_types_.networkprotocol.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetNetworkProtocols**(NetworkProtocols: *[NetworkProtocol](../interfaces/_api_types_.networkprotocol.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:507](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L507)* +*Defined in [api/device.ts:507](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L507)* This operation configures defined network protocols on a device. The device shall support configuration of defined network protocols through the SetNetworkProtocols command. @@ -3018,16 +3018,16 @@ This operation configures defined network protocols on a device. The device shal | ------ | ------ | | NetworkProtocols | [NetworkProtocol](../interfaces/_api_types_.networkprotocol.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRelayOutputSettings -▸ **SetRelayOutputSettings**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Properties: *[RelayOutputSettings](../interfaces/_api_types_.relayoutputsettings.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRelayOutputSettings**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Properties: *[RelayOutputSettings](../interfaces/_api_types_.relayoutputsettings.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:767](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L767)* +*Defined in [api/device.ts:767](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L767)* This operation sets the settings of a relay output. This method has been depricated with version 2.0. Refer to the DeviceIO service. @@ -3038,16 +3038,16 @@ This operation sets the settings of a relay output. This method has been deprica | RelayOutputToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Properties | [RelayOutputSettings](../interfaces/_api_types_.relayoutputsettings.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRelayOutputState -▸ **SetRelayOutputState**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, LogicalState: *[RelayLogicalState](../enums/_api_types_.relaylogicalstate.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRelayOutputState**(RelayOutputToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, LogicalState: *[RelayLogicalState](../enums/_api_types_.relaylogicalstate.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:777](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L777)* +*Defined in [api/device.ts:777](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L777)* This operation sets the state of a relay output. This method has been depricated with version 2.0. Refer to the DeviceIO service. @@ -3058,16 +3058,16 @@ This operation sets the state of a relay output. This method has been depricated | RelayOutputToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | LogicalState | [RelayLogicalState](../enums/_api_types_.relaylogicalstate.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRemoteDiscoveryMode -▸ **SetRemoteDiscoveryMode**(RemoteDiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRemoteDiscoveryMode**(RemoteDiscoveryMode: *[DiscoveryMode](../enums/_api_types_.discoverymode.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:233](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L233)* +*Defined in [api/device.ts:233](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L233)* This operation sets the remote discovery mode of operation of a device. See Section 7.4 for the definition of remote discovery remote extensions. A device that supports remote discovery shall support configuration of the discovery mode setting through the SetRemoteDiscoveryMode command. @@ -3077,16 +3077,16 @@ This operation sets the remote discovery mode of operation of a device. See Sect | ------ | ------ | | RemoteDiscoveryMode | [DiscoveryMode](../enums/_api_types_.discoverymode.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRemoteUser -▸ **SetRemoteUser**(RemoteUser?: *[RemoteUser]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRemoteUser**(RemoteUser?: *[RemoteUser]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:293](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L293)* +*Defined in [api/device.ts:293](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L293)* This operation sets the remote user. A device supporting remote user handling shall support this operation. The user is only valid for the WS-UserToken profile or as a HTTP / RTSP user. The password that is set shall always be the original (not derived) password. If UseDerivedPassword is set password derivation shall be done by the device when connecting to a remote device.The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification. To remove the remote user SetRemoteUser should be called without the RemoteUser parameter. @@ -3096,16 +3096,16 @@ This operation sets the remote user. A device supporting remote user handling sh | ------ | ------ | | `Optional` RemoteUser | [RemoteUser]() | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetScopes -▸ **SetScopes**(Scopes: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetScopes**(Scopes: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:163](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L163)* +*Defined in [api/device.ts:163](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L163)* This operation sets the scope parameters of a device. The scope parameters are used in the device discovery to match a probe message. This operation replaces all existing configurable scope parameters (not fixed parameters). If this shall be avoided, one should use the scope add command instead. The device shall support configuration of discovery scope parameters through the SetScopes command. @@ -3115,16 +3115,16 @@ This operation sets the scope parameters of a device. The scope parameters are u | ------ | ------ | | Scopes | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetStorageConfiguration -▸ **SetStorageConfiguration**(StorageConfiguration: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetStorageConfiguration**(StorageConfiguration: *`any`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1073](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1073)* +*Defined in [api/device.ts:1073](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1073)* This operation modifies an existing Storage configuration. @@ -3134,16 +3134,16 @@ This operation modifies an existing Storage configuration. | ------ | ------ | | StorageConfiguration | `any` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetSystemDateAndTime -▸ **SetSystemDateAndTime**(DateTimeType: *[SetDateTimeType](../enums/_api_types_.setdatetimetype.md)*, DaylightSavings: *`boolean`*, TimeZone?: *[TimeZone]()*, UTCDateTime?: *[DateTime](../interfaces/_api_types_.datetime.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetSystemDateAndTime**(DateTimeType: *[SetDateTimeType](../enums/_api_types_.setdatetimetype.md)*, DaylightSavings: *`boolean`*, TimeZone?: *[TimeZone]()*, UTCDateTime?: *[DateTime](../interfaces/_api_types_.datetime.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:47](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L47)* +*Defined in [api/device.ts:47](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L47)* 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. @@ -3156,16 +3156,16 @@ This operation sets the device system date and time. The device shall support th | `Optional` TimeZone | [TimeZone]() | | `Optional` UTCDateTime | [DateTime](../interfaces/_api_types_.datetime.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetSystemFactoryDefault -▸ **SetSystemFactoryDefault**(FactoryDefault: *[FactoryDefaultType](../enums/_api_types_.factorydefaulttype.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetSystemFactoryDefault**(FactoryDefault: *[FactoryDefaultType](../enums/_api_types_.factorydefaulttype.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:68](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L68)* +*Defined in [api/device.ts:68](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L68)* This operation reloads the parameters on the device to their factory default values. @@ -3175,16 +3175,16 @@ This operation reloads the parameters on the device to their factory default val | ------ | ------ | | FactoryDefault | [FactoryDefaultType](../enums/_api_types_.factorydefaulttype.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetUser -▸ **SetUser**(User: *[User](../interfaces/_api_types_.user.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetUser**(User: *[User](../interfaces/_api_types_.user.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:342](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L342)* +*Defined in [api/device.ts:342](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L342)* This operation updates the settings for one or several users on a device for authentication purposes. The device shall support update of device users and their credentials through the SetUser command. Either all change requests are processed successfully or a fault message shall be returned and no change requests be processed. @@ -3194,16 +3194,16 @@ This operation updates the settings for one or several users on a device for aut | ------ | ------ | | User | [User](../interfaces/_api_types_.user.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetZeroConfiguration -▸ **SetZeroConfiguration**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Enabled: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetZeroConfiguration**(InterfaceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Enabled: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:548](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L548)* +*Defined in [api/device.ts:548](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L548)* This operation sets the zero-configuration. Use GetCapalities to get if zero-zero-configuration is supported or not. @@ -3214,59 +3214,59 @@ This operation sets the zero-configuration. Use GetCapalities to get if zero-zer | InterfaceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Enabled | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` StartFirmwareUpgrade -▸ **StartFirmwareUpgrade**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **StartFirmwareUpgrade**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1004](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1004)* +*Defined in [api/device.ts:1004](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1004)* This operation initiates a firmware upgrade using the HTTP POST mechanism. The response to the command includes an HTTP URL to which the upgrade file may be uploaded. The actual upgrade takes place as soon as the HTTP POST operation has completed. The device should support firmware upgrade through the StartFirmwareUpgrade command. The exact format of the firmware data is outside the scope of this specification. Firmware upgrade over HTTP may be achieved using the following steps: Client calls StartFirmwareUpgrade. Server responds with upload URI and optional delay value. Client waits for delay duration if specified by server. Client transmits the firmware image to the upload URI using HTTP POST. Server reprograms itself using the uploaded image, then reboots. If the firmware upgrade fails because the upgrade file was invalid, the HTTP POST response shall be “415 Unsupported Media Type”. If the firmware upgrade fails due to an error at the device, the HTTP POST response shall be “500 Internal Server Error”. The value of the Content-Type header in the HTTP POST request shall be “application/octetstream”. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` StartSystemRestore -▸ **StartSystemRestore**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **StartSystemRestore**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:1028](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L1028)* +*Defined in [api/device.ts:1028](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L1028)* This operation initiates a system restore from backed up configuration data using the HTTP POST mechanism. The response to the command includes an HTTP URL to which the backup file may be uploaded. The actual restore takes place as soon as the HTTP POST operation has completed. Devices should support system restore through the StartSystemRestore command. The exact format of the backup configuration data is outside the scope of this specification. System restore over HTTP may be achieved using the following steps: Client calls StartSystemRestore. Server responds with upload URI. Client transmits the configuration data to the upload URI using HTTP POST. Server applies the uploaded configuration, then reboots if necessary. If the system restore fails because the uploaded file was invalid, the HTTP POST response shall be “415 Unsupported Media Type”. If the system restore fails due to an error at the device, the HTTP POST response shall be “500 Internal Server Error”. The value of the Content-Type header in the HTTP POST request shall be “application/octetstream”. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SystemReboot -▸ **SystemReboot**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SystemReboot**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:89](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L89)* +*Defined in [api/device.ts:89](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L89)* This operation reboots the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` UpgradeSystemFirmware -▸ **UpgradeSystemFirmware**(Firmware: *[AttachmentData](../interfaces/_api_types_.attachmentdata.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **UpgradeSystemFirmware**(Firmware: *[AttachmentData](../interfaces/_api_types_.attachmentdata.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/device.ts:80](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/device.ts#L80)* +*Defined in [api/device.ts:80](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/device.ts#L80)* This operation upgrades a device firmware version. After a successful upgrade the response message is sent before the device reboots. The device should support firmware upgrade through the UpgradeSystemFirmware command. The exact format of the firmware data is outside the scope of this standard. @@ -3276,7 +3276,7 @@ This operation upgrades a device firmware version. After a successful upgrade th | ------ | ------ | | Firmware | [AttachmentData](../interfaces/_api_types_.attachmentdata.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_display_.onvifdisplay.md b/docs/classes/_api_display_.onvifdisplay.md index 1b72f99..a4dd38e 100644 --- a/docs/classes/_api_display_.onvifdisplay.md +++ b/docs/classes/_api_display_.onvifdisplay.md @@ -49,7 +49,7 @@ ⊕ **new ONVIFDisplay**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFDisplay](_api_display_.onvifdisplay.md) -*Defined in [api/display.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L5)* +*Defined in [api/display.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L5)* **Parameters:** @@ -69,7 +69,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/display.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L6)* +*Defined in [api/display.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L6)* ___ @@ -79,9 +79,9 @@ ___ ### CreatePaneConfiguration -▸ **CreatePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreatePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:197](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L197)* +*Defined in [api/display.ts:197](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L197)* Create a new pane configuration describing the streaming and coding settings for a display area. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities. The content of the Token field may be ignored by the device. @@ -92,16 +92,16 @@ Create a new pane configuration describing the streaming and coding settings for | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneConfiguration | [PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeletePaneConfiguration -▸ **DeletePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeletePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:207](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L207)* +*Defined in [api/display.ts:207](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L207)* Delete a pane configuration. A service must respond with an error if the pane configuration is in use by the current layout. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities. @@ -112,16 +112,16 @@ Delete a pane configuration. A service must respond with an error if the pane co | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetDisplayOptions -▸ **GetDisplayOptions**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetDisplayOptions**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:153](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L153)* +*Defined in [api/display.ts:153](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L153)* The Display Options contain the supported layouts (LayoutOptions) and the decoding and encoding capabilities (CodingCapabilities) of the device. The GetDisplayOptions command returns both, Layout and Coding Capabilities, of a VideoOutput. @@ -131,16 +131,16 @@ The Display Options contain the supported layouts (LayoutOptions) and the decodi | ------ | ------ | | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetLayout -▸ **GetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:132](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L132)* +*Defined in [api/display.ts:132](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L132)* Return the current layout of a video output. The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas. @@ -150,16 +150,16 @@ Return the current layout of a video output. The Layout assigns a pane configura | ------ | ------ | | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPaneConfiguration -▸ **GetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Pane: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Pane: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:171](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L171)* +*Defined in [api/display.ts:171](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L171)* Retrieve the pane configuration for a pane token. @@ -170,16 +170,16 @@ Retrieve the pane configuration for a pane token. | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Pane | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPaneConfigurations -▸ **GetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:164](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L164)* +*Defined in [api/display.ts:164](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L164)* List all currently defined panes of a device for a specified video output (regardless if this pane is visible at a moment). A Pane is a display area on the monitor that is attached to a video output. A pane has a PaneConfiguration that describes which entities are associated with the pane. A client has to configure the pane according to the connection to be established by setting the AudioOutput and/or AudioSourceToken. If a Token is not set, the corresponding session will not be established. @@ -189,29 +189,29 @@ List all currently defined panes of a device for a specified video output (regar | ------ | ------ | | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:123](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L123)* +*Defined in [api/display.ts:123](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L123)* Returns the capabilities of the display service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetLayout -▸ **SetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Layout: *[Layout](../interfaces/_api_types_.layout.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Layout: *[Layout](../interfaces/_api_types_.layout.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:144](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L144)* +*Defined in [api/display.ts:144](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L144)* Change the layout of a display (e.g. change from single view to split screen view).The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas. A device implementation shall be tolerant against rounding errors when matching a layout against its fixed set of layouts by accepting differences of at least one percent. @@ -222,16 +222,16 @@ Change the layout of a display (e.g. change from single view to split screen vie | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Layout | [Layout](../interfaces/_api_types_.layout.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetPaneConfiguration -▸ **SetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:187](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L187)* +*Defined in [api/display.ts:187](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L187)* This command changes the configuration of the specified pane (tbd) @@ -242,16 +242,16 @@ This command changes the configuration of the specified pane (tbd) | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneConfiguration | [PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetPaneConfigurations -▸ **SetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/display.ts:180](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L180)* +*Defined in [api/display.ts:180](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L180)* Modify one or more configurations of the specified video output. This method will only modify the provided configurations and leave the others unchanged. Use DeletePaneConfiguration to remove pane configurations. @@ -262,16 +262,16 @@ Modify one or more configurations of the specified video output. This method wil | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneConfiguration | [PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` CreatePaneConfiguration -▸ **CreatePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreatePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L102)* +*Defined in [api/display.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L102)* Create a new pane configuration describing the streaming and coding settings for a display area. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities. The content of the Token field may be ignored by the device. @@ -282,16 +282,16 @@ Create a new pane configuration describing the streaming and coding settings for | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneConfiguration | [PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeletePaneConfiguration -▸ **DeletePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeletePaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:114](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L114)* +*Defined in [api/display.ts:114](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L114)* Delete a pane configuration. A service must respond with an error if the pane configuration is in use by the current layout. This optional method is only supported by devices that signal support of dynamic pane creation via their capabilities. @@ -302,16 +302,16 @@ Delete a pane configuration. A service must respond with an error if the pane co | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetDisplayOptions -▸ **GetDisplayOptions**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetDisplayOptions**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:48](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L48)* +*Defined in [api/display.ts:48](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L48)* The Display Options contain the supported layouts (LayoutOptions) and the decoding and encoding capabilities (CodingCapabilities) of the device. The GetDisplayOptions command returns both, Layout and Coding Capabilities, of a VideoOutput. @@ -321,16 +321,16 @@ The Display Options contain the supported layouts (LayoutOptions) and the decodi | ------ | ------ | | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetLayout -▸ **GetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L23)* +*Defined in [api/display.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L23)* Return the current layout of a video output. The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas. @@ -340,16 +340,16 @@ Return the current layout of a video output. The Layout assigns a pane configura | ------ | ------ | | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPaneConfiguration -▸ **GetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Pane: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Pane: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L70)* +*Defined in [api/display.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L70)* Retrieve the pane configuration for a pane token. @@ -360,16 +360,16 @@ Retrieve the pane configuration for a pane token. | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Pane | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPaneConfigurations -▸ **GetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:61](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L61)* +*Defined in [api/display.ts:61](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L61)* List all currently defined panes of a device for a specified video output (regardless if this pane is visible at a moment). A Pane is a display area on the monitor that is attached to a video output. A pane has a PaneConfiguration that describes which entities are associated with the pane. A client has to configure the pane according to the connection to be established by setting the AudioOutput and/or AudioSourceToken. If a Token is not set, the corresponding session will not be established. @@ -379,29 +379,29 @@ List all currently defined panes of a device for a specified video output (regar | ------ | ------ | | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L12)* +*Defined in [api/display.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L12)* Returns the capabilities of the display service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetLayout -▸ **SetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Layout: *[Layout](../interfaces/_api_types_.layout.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetLayout**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Layout: *[Layout](../interfaces/_api_types_.layout.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:37](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L37)* +*Defined in [api/display.ts:37](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L37)* Change the layout of a display (e.g. change from single view to split screen view).The Layout assigns a pane configuration to a certain area of the display. The layout settings directly affect a specific video output. The layout consists of a list of PaneConfigurations and their associated display areas. A device implementation shall be tolerant against rounding errors when matching a layout against its fixed set of layouts by accepting differences of at least one percent. @@ -412,16 +412,16 @@ Change the layout of a display (e.g. change from single view to split screen vie | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Layout | [Layout](../interfaces/_api_types_.layout.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetPaneConfiguration -▸ **SetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetPaneConfiguration**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:90](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L90)* +*Defined in [api/display.ts:90](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L90)* This command changes the configuration of the specified pane (tbd) @@ -432,16 +432,16 @@ This command changes the configuration of the specified pane (tbd) | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneConfiguration | [PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetPaneConfigurations -▸ **SetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetPaneConfigurations**(VideoOutput: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PaneConfiguration: *[PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/display.ts:81](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/display.ts#L81)* +*Defined in [api/display.ts:81](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/display.ts#L81)* Modify one or more configurations of the specified video output. This method will only modify the provided configurations and leave the others unchanged. Use DeletePaneConfiguration to remove pane configurations. @@ -452,7 +452,7 @@ Modify one or more configurations of the specified video output. This method wil | VideoOutput | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PaneConfiguration | [PaneConfiguration](../interfaces/_api_types_.paneconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_imaging_.onvifimaging.md b/docs/classes/_api_imaging_.onvifimaging.md index f4d0685..ebac775 100644 --- a/docs/classes/_api_imaging_.onvifimaging.md +++ b/docs/classes/_api_imaging_.onvifimaging.md @@ -51,7 +51,7 @@ ⊕ **new ONVIFImaging**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFImaging](_api_imaging_.onvifimaging.md) -*Defined in [api/imaging.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L5)* +*Defined in [api/imaging.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L5)* **Parameters:** @@ -71,7 +71,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/imaging.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L6)* +*Defined in [api/imaging.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L6)* ___ @@ -81,9 +81,9 @@ ___ ### GetCurrentPreset -▸ **GetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:209](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L209)* +*Defined in [api/imaging.ts:209](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L209)* Via this command the last Imaging Preset applied can be requested. If the camera configuration does not match any of the existing Imaging Presets, the output of GetCurrentPreset shall be Empty. GetCurrentPreset shall return 0 if Imaging Presets are not supported by the Video Source. @@ -93,16 +93,16 @@ Via this command the last Imaging Preset applied can be requested. If the camera | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetImagingSettings -▸ **GetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:137](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L137)* +*Defined in [api/imaging.ts:137](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L137)* Get the ImagingConfiguration for the requested VideoSource. @@ -112,16 +112,16 @@ Get the ImagingConfiguration for the requested VideoSource. | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetMoveOptions -▸ **GetMoveOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetMoveOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:178](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L178)* +*Defined in [api/imaging.ts:178](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L178)* Imaging move operation options supported for the Video source. @@ -131,16 +131,16 @@ Imaging move operation options supported for the Video source. | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetOptions -▸ **GetOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:155](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L155)* +*Defined in [api/imaging.ts:155](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L155)* This operation gets the valid ranges for the imaging parameters that have device specific ranges. This command is mandatory for all device implementing the imaging service. The command returns all supported parameters and their ranges such that these can be applied to the SetImagingSettings command. For read-only parameters which cannot be modified via the SetImagingSettings command only a single option or identical Min and Max values is provided. @@ -150,16 +150,16 @@ This operation gets the valid ranges for the imaging parameters that have device | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPresets -▸ **GetPresets**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPresets**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:200](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L200)* +*Defined in [api/imaging.ts:200](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L200)* Via this command the list of available Imaging Presets can be requested. @@ -169,29 +169,29 @@ Via this command the list of available Imaging Presets can be requested. | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:130](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L130)* +*Defined in [api/imaging.ts:130](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L130)* Returns the capabilities of the imaging service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetStatus -▸ **GetStatus**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetStatus**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:193](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L193)* +*Defined in [api/imaging.ts:193](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L193)* 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. @@ -201,16 +201,16 @@ Via this command the current status of the Move operation can be requested. Supp | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### Move -▸ **Move**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Focus: *[FocusMove](../interfaces/_api_types_.focusmove.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **Move**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Focus: *[FocusMove](../interfaces/_api_types_.focusmove.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:171](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L171)* +*Defined in [api/imaging.ts:171](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L171)* The Move command moves the focus lens in an absolute, a relative or in a continuous manner from its current position. The speed argument is optional for absolute and relative control, but required for continuous. If no speed argument is used, the default speed is used. Focus adjustments through this operation will turn off the autofocus. A device with support for remote focus control should support absolute, relative or continuous control through the Move operation. The supported MoveOpions are signalled via the GetMoveOptions command. At least one focus control capability is required for this operation to be functional. The move operation contains the following commands: Absolute – Requires position parameter and optionally takes a speed argument. A unitless type is used by default for focus positioning and speed. Optionally, if supported, the position may be requested in m-1 units. Relative – Requires distance parameter and optionally takes a speed argument. Negative distance means negative direction. Continuous – Requires a speed argument. Negative speed argument means negative direction. @@ -221,16 +221,16 @@ The Move command moves the focus lens in an absolute, a relative or in a continu | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Focus | [FocusMove](../interfaces/_api_types_.focusmove.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetCurrentPreset -▸ **SetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:219](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L219)* +*Defined in [api/imaging.ts:219](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L219)* The SetCurrentPreset command shall request a given Imaging Preset to be applied to the specified Video Source. SetCurrentPreset shall only be available for Video Sources with Imaging Presets Capability. Imaging Presets are defined by the Manufacturer, and offered as a tool to simplify Imaging Settings adjustments for specific scene content. When the new Imaging Preset is applied by SetCurrentPreset, the Device shall adjust the Video Source settings to match those defined by the specified Imaging Preset. @@ -241,16 +241,16 @@ The SetCurrentPreset command shall request a given Imaging Preset to be applied | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetImagingSettings -▸ **SetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ImagingSettings: *[ImagingSettings20](../interfaces/_api_types_.imagingsettings20.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ImagingSettings: *[ImagingSettings20](../interfaces/_api_types_.imagingsettings20.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:144](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L144)* +*Defined in [api/imaging.ts:144](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L144)* Set the ImagingConfiguration for the requested VideoSource. @@ -262,16 +262,16 @@ Set the ImagingConfiguration for the requested VideoSource. | ImagingSettings | [ImagingSettings20](../interfaces/_api_types_.imagingsettings20.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### Stop -▸ **Stop**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **Stop**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/imaging.ts:186](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L186)* +*Defined in [api/imaging.ts:186](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L186)* The Stop command stops all ongoing focus movements of the lense. A device with support for remote focus control as signalled via the GetMoveOptions supports this command. The operation will not affect ongoing autofocus operation. @@ -281,16 +281,16 @@ The Stop command stops all ongoing focus movements of the lense. A device with s | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` GetCurrentPreset -▸ **GetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:109](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L109)* +*Defined in [api/imaging.ts:109](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L109)* Via this command the last Imaging Preset applied can be requested. If the camera configuration does not match any of the existing Imaging Presets, the output of GetCurrentPreset shall be Empty. GetCurrentPreset shall return 0 if Imaging Presets are not supported by the Video Source. @@ -300,16 +300,16 @@ Via this command the last Imaging Preset applied can be requested. If the camera | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetImagingSettings -▸ **GetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L21)* +*Defined in [api/imaging.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L21)* Get the ImagingConfiguration for the requested VideoSource. @@ -319,16 +319,16 @@ Get the ImagingConfiguration for the requested VideoSource. | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetMoveOptions -▸ **GetMoveOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetMoveOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L70)* +*Defined in [api/imaging.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L70)* Imaging move operation options supported for the Video source. @@ -338,16 +338,16 @@ Imaging move operation options supported for the Video source. | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetOptions -▸ **GetOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetOptions**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:43](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L43)* +*Defined in [api/imaging.ts:43](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L43)* This operation gets the valid ranges for the imaging parameters that have device specific ranges. This command is mandatory for all device implementing the imaging service. The command returns all supported parameters and their ranges such that these can be applied to the SetImagingSettings command. For read-only parameters which cannot be modified via the SetImagingSettings command only a single option or identical Min and Max values is provided. @@ -357,16 +357,16 @@ This operation gets the valid ranges for the imaging parameters that have device | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPresets -▸ **GetPresets**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPresets**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L98)* +*Defined in [api/imaging.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L98)* Via this command the list of available Imaging Presets can be requested. @@ -376,29 +376,29 @@ Via this command the list of available Imaging Presets can be requested. | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L12)* +*Defined in [api/imaging.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L12)* Returns the capabilities of the imaging service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetStatus -▸ **GetStatus**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetStatus**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:89](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L89)* +*Defined in [api/imaging.ts:89](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L89)* 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. @@ -408,16 +408,16 @@ Via this command the current status of the Move operation can be requested. Supp | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` Move -▸ **Move**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Focus: *[FocusMove](../interfaces/_api_types_.focusmove.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **Move**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Focus: *[FocusMove](../interfaces/_api_types_.focusmove.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:61](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L61)* +*Defined in [api/imaging.ts:61](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L61)* The Move command moves the focus lens in an absolute, a relative or in a continuous manner from its current position. The speed argument is optional for absolute and relative control, but required for continuous. If no speed argument is used, the default speed is used. Focus adjustments through this operation will turn off the autofocus. A device with support for remote focus control should support absolute, relative or continuous control through the Move operation. The supported MoveOpions are signalled via the GetMoveOptions command. At least one focus control capability is required for this operation to be functional. The move operation contains the following commands: Absolute – Requires position parameter and optionally takes a speed argument. A unitless type is used by default for focus positioning and speed. Optionally, if supported, the position may be requested in m-1 units. Relative – Requires distance parameter and optionally takes a speed argument. Negative distance means negative direction. Continuous – Requires a speed argument. Negative speed argument means negative direction. @@ -428,16 +428,16 @@ The Move command moves the focus lens in an absolute, a relative or in a continu | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Focus | [FocusMove](../interfaces/_api_types_.focusmove.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetCurrentPreset -▸ **SetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetCurrentPreset**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:121](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L121)* +*Defined in [api/imaging.ts:121](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L121)* The SetCurrentPreset command shall request a given Imaging Preset to be applied to the specified Video Source. SetCurrentPreset shall only be available for Video Sources with Imaging Presets Capability. Imaging Presets are defined by the Manufacturer, and offered as a tool to simplify Imaging Settings adjustments for specific scene content. When the new Imaging Preset is applied by SetCurrentPreset, the Device shall adjust the Video Source settings to match those defined by the specified Imaging Preset. @@ -448,16 +448,16 @@ The SetCurrentPreset command shall request a given Imaging Preset to be applied | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetImagingSettings -▸ **SetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ImagingSettings: *[ImagingSettings20](../interfaces/_api_types_.imagingsettings20.md)*, ForcePersistence?: *`undefined` \| `false` \| `true`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetImagingSettings**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ImagingSettings: *[ImagingSettings20](../interfaces/_api_types_.imagingsettings20.md)*, ForcePersistence?: *`undefined` \| `false` \| `true`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L30)* +*Defined in [api/imaging.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L30)* Set the ImagingConfiguration for the requested VideoSource. @@ -469,16 +469,16 @@ Set the ImagingConfiguration for the requested VideoSource. | ImagingSettings | [ImagingSettings20](../interfaces/_api_types_.imagingsettings20.md) | | `Optional` ForcePersistence | `undefined` \| `false` \| `true` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` Stop -▸ **Stop**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **Stop**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/imaging.ts:80](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/imaging.ts#L80)* +*Defined in [api/imaging.ts:80](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/imaging.ts#L80)* The Stop command stops all ongoing focus movements of the lense. A device with support for remote focus control as signalled via the GetMoveOptions supports this command. The operation will not affect ongoing autofocus operation. @@ -488,7 +488,7 @@ The Stop command stops all ongoing focus movements of the lense. A device with s | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_index_.managedonvifapi.md b/docs/classes/_api_index_.managedonvifapi.md index dbcc6f0..884e0cc 100644 --- a/docs/classes/_api_index_.managedonvifapi.md +++ b/docs/classes/_api_index_.managedonvifapi.md @@ -38,7 +38,7 @@ ⊕ **new ManagedONVIFApi**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ManagedONVIFApi](_api_index_.managedonvifapi.md) -*Defined in [api/index.ts:27](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L27)* +*Defined in [api/index.ts:27](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L27)* **Parameters:** @@ -58,7 +58,7 @@ ___ **● AdvancedSecurity**: *[ONVIFAdvancedSecurity](_api_advancedsecurity_.onvifadvancedsecurity.md)* = new ONVIFAdvancedSecurity(this.config) -*Defined in [api/index.ts:27](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L27)* +*Defined in [api/index.ts:27](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L27)* ___ @@ -67,7 +67,7 @@ ___ **● Analytics**: *[ONVIFAnalytics](_api_analytics_.onvifanalytics.md)* = new ONVIFAnalytics(this.config) -*Defined in [api/index.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L18)* +*Defined in [api/index.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L18)* ___ @@ -76,7 +76,7 @@ ___ **● Device**: *[ONVIFDevice](_api_device_.onvifdevice.md)* = new ONVIFDevice(this.config) -*Defined in [api/index.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L16)* +*Defined in [api/index.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L16)* ___ @@ -85,7 +85,7 @@ ___ **● Display**: *[ONVIFDisplay](_api_display_.onvifdisplay.md)* = new ONVIFDisplay(this.config) -*Defined in [api/index.ts:19](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L19)* +*Defined in [api/index.ts:19](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L19)* ___ @@ -94,7 +94,7 @@ ___ **● Imaging**: *[ONVIFImaging](_api_imaging_.onvifimaging.md)* = new ONVIFImaging(this.config) -*Defined in [api/index.ts:20](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L20)* +*Defined in [api/index.ts:20](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L20)* ___ @@ -103,7 +103,7 @@ ___ **● Media**: *[ONVIFMedia](_api_media_.onvifmedia.md)* = new ONVIFMedia(this.config) -*Defined in [api/index.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L17)* +*Defined in [api/index.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L17)* ___ @@ -112,7 +112,7 @@ ___ **● PTZ**: *[ONVIFPTZ](_api_ptz_.onvifptz.md)* = new ONVIFPTZ(this.config) -*Defined in [api/index.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L22)* +*Defined in [api/index.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L22)* ___ @@ -121,7 +121,7 @@ ___ **● Provisioning**: *[ONVIFProvisioning](_api_provisioning_.onvifprovisioning.md)* = new ONVIFProvisioning(this.config) -*Defined in [api/index.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L21)* +*Defined in [api/index.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L21)* ___ @@ -130,7 +130,7 @@ ___ **● Receiver**: *[ONVIFReceiver](_api_receiver_.onvifreceiver.md)* = new ONVIFReceiver(this.config) -*Defined in [api/index.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L23)* +*Defined in [api/index.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L23)* ___ @@ -139,7 +139,7 @@ ___ **● Recording**: *[ONVIFRecording](_api_recording_.onvifrecording.md)* = new ONVIFRecording(this.config) -*Defined in [api/index.ts:24](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L24)* +*Defined in [api/index.ts:24](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L24)* ___ @@ -148,7 +148,7 @@ ___ **● Replay**: *[ONVIFReplay](_api_replay_.onvifreplay.md)* = new ONVIFReplay(this.config) -*Defined in [api/index.ts:25](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L25)* +*Defined in [api/index.ts:25](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L25)* ___ @@ -157,7 +157,7 @@ ___ **● Search**: *[ONVIFSearch](_api_search_.onvifsearch.md)* = new ONVIFSearch(this.config) -*Defined in [api/index.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L26)* +*Defined in [api/index.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L26)* ___ @@ -166,7 +166,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/index.ts:29](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/index.ts#L29)* +*Defined in [api/index.ts:29](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/index.ts#L29)* ___ diff --git a/docs/classes/_api_media_.onvifmedia.md b/docs/classes/_api_media_.onvifmedia.md index 76f7f76..3be5e93 100644 --- a/docs/classes/_api_media_.onvifmedia.md +++ b/docs/classes/_api_media_.onvifmedia.md @@ -187,7 +187,7 @@ ⊕ **new ONVIFMedia**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFMedia](_api_media_.onvifmedia.md) -*Defined in [api/media.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L5)* +*Defined in [api/media.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L5)* **Parameters:** @@ -207,7 +207,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/media.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L6)* +*Defined in [api/media.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L6)* ___ @@ -217,9 +217,9 @@ ___ ### AddAudioDecoderConfiguration -▸ **AddAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1024](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1024)* +*Defined in [api/media.ts:1024](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1024)* 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. @@ -230,16 +230,16 @@ This operation adds an AudioDecoderConfiguration to an existing media profile. I | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddAudioEncoderConfiguration -▸ **AddAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:926](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L926)* +*Defined in [api/media.ts:926](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L926)* This operation adds an AudioEncoderConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall support streaming audio data of such a profile. @@ -250,16 +250,16 @@ This operation adds an AudioEncoderConfiguration to an existing media profile. I | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddAudioOutputConfiguration -▸ **AddAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1010](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1010)* +*Defined in [api/media.ts:1010](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1010)* 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. @@ -270,16 +270,16 @@ This operation adds an AudioOutputConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddAudioSourceConfiguration -▸ **AddAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:943](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L943)* +*Defined in [api/media.ts:943](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L943)* 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. @@ -290,16 +290,16 @@ This operation adds an AudioSourceConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddMetadataConfiguration -▸ **AddMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:996](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L996)* +*Defined in [api/media.ts:996](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L996)* 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. @@ -310,16 +310,16 @@ This operation adds a Metadata configuration to an existing media profile. If a | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddPTZConfiguration -▸ **AddPTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddPTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:963](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L963)* +*Defined in [api/media.ts:963](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L963)* 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. @@ -330,16 +330,16 @@ This operation adds a PTZConfiguration to an existing media profile. If a config | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddVideoAnalyticsConfiguration -▸ **AddVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:981](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L981)* +*Defined in [api/media.ts:981](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L981)* 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. @@ -350,16 +350,16 @@ This operation adds a VideoAnalytics configuration to an existing media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddVideoEncoderConfiguration -▸ **AddVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:890](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L890)* +*Defined in [api/media.ts:890](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L890)* 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. @@ -370,16 +370,16 @@ This operation adds a VideoEncoderConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### AddVideoSourceConfiguration -▸ **AddVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AddVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:906](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L906)* +*Defined in [api/media.ts:906](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L906)* 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. @@ -390,16 +390,16 @@ This operation adds a VideoSourceConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateOSD -▸ **CreateOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1480](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1480)* +*Defined in [api/media.ts:1480](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1480)* Create the OSD. @@ -409,16 +409,16 @@ Create the OSD. | ------ | ------ | | OSD | [OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateProfile -▸ **CreateProfile**(Name: *[Name]()*, Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateProfile**(Name: *[Name]()*, Token: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:862](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L862)* +*Defined in [api/media.ts:862](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L862)* 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. @@ -429,16 +429,16 @@ This operation creates a new empty media profile. The media profile shall be cre | Name | [Name]() | | Token | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteOSD -▸ **DeleteOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1487](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1487)* +*Defined in [api/media.ts:1487](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1487)* Delete the OSD. @@ -448,16 +448,16 @@ Delete the OSD. | ------ | ------ | | OSDToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteProfile -▸ **DeleteProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1038](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1038)* +*Defined in [api/media.ts:1038](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1038)* This operation deletes a profile. This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles @@ -467,16 +467,16 @@ This operation deletes a profile. This change shall always be persistent. Deleti | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioDecoderConfiguration -▸ **GetAudioDecoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioDecoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1151](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1151)* +*Defined in [api/media.ts:1151](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1151)* If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command. @@ -486,16 +486,16 @@ If the audio decoder configuration token is already known, the decoder configura | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioDecoderConfigurationOptions -▸ **GetAudioDecoderConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioDecoderConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1351](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1351)* +*Defined in [api/media.ts:1351](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1351)* This command list the audio decoding capabilities for a given profile and configuration of a device. @@ -506,29 +506,29 @@ This command list the audio decoding capabilities for a given profile and config | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioDecoderConfigurations -▸ **GetAudioDecoderConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioDecoderConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1095](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1095)* +*Defined in [api/media.ts:1095](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1095)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioEncoderConfiguration -▸ **GetAudioEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1123](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1123)* +*Defined in [api/media.ts:1123](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1123)* The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known. @@ -538,16 +538,16 @@ The GetAudioEncoderConfiguration command fetches the encoder configuration if th | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioEncoderConfigurationOptions -▸ **GetAudioEncoderConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioEncoderConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1329](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1329)* +*Defined in [api/media.ts:1329](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1329)* This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured. @@ -558,29 +558,29 @@ This operation returns the available options (supported values and ranges for au | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioEncoderConfigurations -▸ **GetAudioEncoderConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioEncoderConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1066](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1066)* +*Defined in [api/media.ts:1066](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1066)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioOutputConfiguration -▸ **GetAudioOutputConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioOutputConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1144](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1144)* +*Defined in [api/media.ts:1144](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1144)* If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command. @@ -590,16 +590,16 @@ If the audio output configuration token is already known, the output configurati | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioOutputConfigurationOptions -▸ **GetAudioOutputConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioOutputConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1343](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1343)* +*Defined in [api/media.ts:1343](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1343)* This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. @@ -610,42 +610,42 @@ This operation returns the available options (supported values and ranges for au | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioOutputConfigurations -▸ **GetAudioOutputConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioOutputConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1087](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1087)* +*Defined in [api/media.ts:1087](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1087)* This command lists all existing AudioOutputConfigurations of a device. The NVC need not know anything apriori about the audio configurations to use this command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioOutputs -▸ **GetAudioOutputs**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioOutputs**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:853](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L853)* +*Defined in [api/media.ts:853](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L853)* This command lists all available physical audio outputs of the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioSourceConfiguration -▸ **GetAudioSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1116](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1116)* +*Defined in [api/media.ts:1116](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1116)* The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known. An @@ -655,16 +655,16 @@ The GetAudioSourceConfiguration command fetches the audio source configurations | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioSourceConfigurationOptions -▸ **GetAudioSourceConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioSourceConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1321](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1321)* +*Defined in [api/media.ts:1321](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1321)* 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. @@ -675,42 +675,42 @@ This operation returns the available options (supported values and ranges for au | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioSourceConfigurations -▸ **GetAudioSourceConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioSourceConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1059](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1059)* +*Defined in [api/media.ts:1059](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1059)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetAudioSources -▸ **GetAudioSources**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetAudioSources**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:846](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L846)* +*Defined in [api/media.ts:846](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L846)* This command lists all available physical audio inputs of the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleAudioDecoderConfigurations -▸ **GetCompatibleAudioDecoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleAudioDecoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1211](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1211)* +*Defined in [api/media.ts:1211](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1211)* 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. @@ -720,16 +720,16 @@ This operation lists all the audio decoder configurations of the device that are | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleAudioEncoderConfigurations -▸ **GetCompatibleAudioEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleAudioEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1175](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1175)* +*Defined in [api/media.ts:1175](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1175)* 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. @@ -739,16 +739,16 @@ This operation requests all audio encoder configurations of a device that are co | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleAudioOutputConfigurations -▸ **GetCompatibleAudioOutputConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleAudioOutputConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1204](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1204)* +*Defined in [api/media.ts:1204](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1204)* This command lists all audio output configurations of a device that are compatible with a certain media profile. Each returned configuration shall be a valid input for the AddAudioOutputConfiguration command. @@ -758,16 +758,16 @@ This command lists all audio output configurations of a device that are compatib | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleAudioSourceConfigurations -▸ **GetCompatibleAudioSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleAudioSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1182](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1182)* +*Defined in [api/media.ts:1182](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1182)* 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. @@ -777,16 +777,16 @@ This operation requests all audio source configurations of the device that are c | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleMetadataConfigurations -▸ **GetCompatibleMetadataConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleMetadataConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1196](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1196)* +*Defined in [api/media.ts:1196](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1196)* 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. @@ -796,16 +796,16 @@ This operation requests all the metadata configurations of the device that are c | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleVideoAnalyticsConfigurations -▸ **GetCompatibleVideoAnalyticsConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleVideoAnalyticsConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1189](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1189)* +*Defined in [api/media.ts:1189](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1189)* 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. @@ -815,16 +815,16 @@ This operation requests all video analytic configurations of the device that are | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleVideoEncoderConfigurations -▸ **GetCompatibleVideoEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleVideoEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1158](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1158)* +*Defined in [api/media.ts:1158](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1158)* 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. @@ -834,16 +834,16 @@ This operation lists all the video encoder configurations of the device that are | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleVideoSourceConfigurations -▸ **GetCompatibleVideoSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleVideoSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1168](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1168)* +*Defined in [api/media.ts:1168](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1168)* 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. @@ -853,16 +853,16 @@ This operation requests all the video source configurations of the device that a | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetGuaranteedNumberOfVideoEncoderInstances -▸ **GetGuaranteedNumberOfVideoEncoderInstances**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetGuaranteedNumberOfVideoEncoderInstances**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1360](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1360)* +*Defined in [api/media.ts:1360](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1360)* The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration. @@ -872,16 +872,16 @@ The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request th | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetMetadataConfiguration -▸ **GetMetadataConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetMetadataConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1137](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1137)* +*Defined in [api/media.ts:1137](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1137)* The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. @@ -891,16 +891,16 @@ The GetMetadataConfiguration command fetches the metadata configuration if the m | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetMetadataConfigurationOptions -▸ **GetMetadataConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetMetadataConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1336](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1336)* +*Defined in [api/media.ts:1336](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1336)* This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. @@ -911,29 +911,29 @@ This operation returns the available options (supported values and ranges for me | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetMetadataConfigurations -▸ **GetMetadataConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetMetadataConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1080](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1080)* +*Defined in [api/media.ts:1080](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1080)* This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetOSD -▸ **GetOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1459](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1459)* +*Defined in [api/media.ts:1459](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1459)* Get the OSD. @@ -943,16 +943,16 @@ Get the OSD. | ------ | ------ | | OSDToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetOSDOptions -▸ **GetOSDOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetOSDOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1466](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1466)* +*Defined in [api/media.ts:1466](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1466)* Get the OSD Options. @@ -962,16 +962,16 @@ Get the OSD Options. | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetOSDs -▸ **GetOSDs**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetOSDs**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1452](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1452)* +*Defined in [api/media.ts:1452](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1452)* Get the OSDs. @@ -981,16 +981,16 @@ Get the OSDs. | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetProfile -▸ **GetProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:869](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L869)* +*Defined in [api/media.ts:869](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L869)* If the profile token is already known, a profile can be fetched through the GetProfile command. @@ -1000,42 +1000,42 @@ If the profile token is already known, a profile can be fetched through the GetP | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetProfiles -▸ **GetProfiles**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetProfiles**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:879](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L879)* +*Defined in [api/media.ts:879](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L879)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:832](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L832)* +*Defined in [api/media.ts:832](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L832)* Returns the capabilities of the media service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSnapshotUri -▸ **GetSnapshotUri**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSnapshotUri**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1431](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1431)* +*Defined in [api/media.ts:1431](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1431)* 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. @@ -1045,16 +1045,16 @@ A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the devi | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetStreamUri -▸ **GetStreamUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetStreamUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1381](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1381)* +*Defined in [api/media.ts:1381](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1381)* 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: @@ -1069,16 +1069,16 @@ If a multicast stream is requested the VideoEncoderConfiguration, AudioEncoderCo | StreamSetup | [StreamSetup](../interfaces/_api_types_.streamsetup.md) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoAnalyticsConfiguration -▸ **GetVideoAnalyticsConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoAnalyticsConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1130](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1130)* +*Defined in [api/media.ts:1130](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1130)* The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known. @@ -1088,29 +1088,29 @@ The GetVideoAnalyticsConfiguration command fetches the video analytics configura | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoAnalyticsConfigurations -▸ **GetVideoAnalyticsConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoAnalyticsConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1073](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1073)* +*Defined in [api/media.ts:1073](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1073)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoEncoderConfiguration -▸ **GetVideoEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1109](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1109)* +*Defined in [api/media.ts:1109](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1109)* If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. @@ -1120,16 +1120,16 @@ If the video encoder configuration token is already known, the encoder configura | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoEncoderConfigurationOptions -▸ **GetVideoEncoderConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoEncoderConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1311](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1311)* +*Defined in [api/media.ts:1311](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1311)* 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. @@ -1140,29 +1140,29 @@ This operation returns the available options (supported values and ranges for vi | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoEncoderConfigurations -▸ **GetVideoEncoderConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoEncoderConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1052](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1052)* +*Defined in [api/media.ts:1052](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1052)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoSourceConfiguration -▸ **GetVideoSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1102)* +*Defined in [api/media.ts:1102](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1102)* If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command. @@ -1172,16 +1172,16 @@ If the video source configuration token is already known, the video source confi | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoSourceConfigurationOptions -▸ **GetVideoSourceConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoSourceConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1297](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1297)* +*Defined in [api/media.ts:1297](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1297)* 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. @@ -1192,29 +1192,29 @@ This operation returns the available options (supported values and ranges for vi | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoSourceConfigurations -▸ **GetVideoSourceConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoSourceConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1045](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1045)* +*Defined in [api/media.ts:1045](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1045)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoSourceModes -▸ **GetVideoSourceModes**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoSourceModes**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1438](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1438)* +*Defined in [api/media.ts:1438](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1438)* 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. @@ -1224,29 +1224,29 @@ A device returns the information for current video source mode and settable vide | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetVideoSources -▸ **GetVideoSources**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetVideoSources**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:839](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L839)* +*Defined in [api/media.ts:839](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L839)* This command lists all available physical video inputs of the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveAudioDecoderConfiguration -▸ **RemoveAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1031](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1031)* +*Defined in [api/media.ts:1031](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1031)* 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. @@ -1256,16 +1256,16 @@ This operation removes an AudioDecoderConfiguration from an existing media profi | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveAudioEncoderConfiguration -▸ **RemoveAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:935](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L935)* +*Defined in [api/media.ts:935](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L935)* 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. @@ -1275,16 +1275,16 @@ This operation removes an AudioEncoderConfiguration from an existing media profi | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveAudioOutputConfiguration -▸ **RemoveAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1017](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1017)* +*Defined in [api/media.ts:1017](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1017)* 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. @@ -1294,16 +1294,16 @@ This operation removes an AudioOutputConfiguration from an existing media profil | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveAudioSourceConfiguration -▸ **RemoveAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:953](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L953)* +*Defined in [api/media.ts:953](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L953)* 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. @@ -1313,16 +1313,16 @@ This operation removes an AudioSourceConfiguration from an existing media profil | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveMetadataConfiguration -▸ **RemoveMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1003](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1003)* +*Defined in [api/media.ts:1003](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1003)* 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. @@ -1332,16 +1332,16 @@ This operation removes a MetadataConfiguration from an existing media profile. I | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemovePTZConfiguration -▸ **RemovePTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemovePTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:971](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L971)* +*Defined in [api/media.ts:971](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L971)* 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. @@ -1351,16 +1351,16 @@ This operation removes a PTZConfiguration from an existing media profile. If the | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveVideoAnalyticsConfiguration -▸ **RemoveVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:989](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L989)* +*Defined in [api/media.ts:989](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L989)* 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. @@ -1370,16 +1370,16 @@ This operation removes a VideoAnalyticsConfiguration from an existing media prof | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveVideoEncoderConfiguration -▸ **RemoveVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:898](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L898)* +*Defined in [api/media.ts:898](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L898)* 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. @@ -1389,16 +1389,16 @@ This operation removes a VideoEncoderConfiguration from an existing media profil | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemoveVideoSourceConfiguration -▸ **RemoveVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemoveVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:915](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L915)* +*Defined in [api/media.ts:915](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L915)* 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. @@ -1408,16 +1408,16 @@ This operation removes a VideoSourceConfiguration from an existing media profile | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetAudioDecoderConfiguration -▸ **SetAudioDecoderConfiguration**(Configuration: *[AudioDecoderConfiguration](../interfaces/_api_types_.audiodecoderconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetAudioDecoderConfiguration**(Configuration: *[AudioDecoderConfiguration](../interfaces/_api_types_.audiodecoderconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1287](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1287)* +*Defined in [api/media.ts:1287](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1287)* This operation modifies an audio decoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. @@ -1428,16 +1428,16 @@ This operation modifies an audio decoder configuration. The ForcePersistence fla | Configuration | [AudioDecoderConfiguration](../interfaces/_api_types_.audiodecoderconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetAudioEncoderConfiguration -▸ **SetAudioEncoderConfiguration**(Configuration: *[AudioEncoderConfiguration](../interfaces/_api_types_.audioencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetAudioEncoderConfiguration**(Configuration: *[AudioEncoderConfiguration](../interfaces/_api_types_.audioencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1247](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1247)* +*Defined in [api/media.ts:1247](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1247)* 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. @@ -1448,16 +1448,16 @@ This operation modifies an audio encoder configuration. The ForcePersistence fla | Configuration | [AudioEncoderConfiguration](../interfaces/_api_types_.audioencoderconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetAudioOutputConfiguration -▸ **SetAudioOutputConfiguration**(Configuration: *[AudioOutputConfiguration](../interfaces/_api_types_.audiooutputconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetAudioOutputConfiguration**(Configuration: *[AudioOutputConfiguration](../interfaces/_api_types_.audiooutputconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1279](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1279)* +*Defined in [api/media.ts:1279](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1279)* This operation modifies an audio output configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. @@ -1468,16 +1468,16 @@ This operation modifies an audio output configuration. The ForcePersistence flag | Configuration | [AudioOutputConfiguration](../interfaces/_api_types_.audiooutputconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetAudioSourceConfiguration -▸ **SetAudioSourceConfiguration**(Configuration: *[AudioSourceConfiguration](../interfaces/_api_types_.audiosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetAudioSourceConfiguration**(Configuration: *[AudioSourceConfiguration](../interfaces/_api_types_.audiosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1236](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1236)* +*Defined in [api/media.ts:1236](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1236)* 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. @@ -1488,16 +1488,16 @@ This operation modifies an audio source configuration. The ForcePersistence flag | Configuration | [AudioSourceConfiguration](../interfaces/_api_types_.audiosourceconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetMetadataConfiguration -▸ **SetMetadataConfiguration**(Configuration: *[MetadataConfiguration](../interfaces/_api_types_.metadataconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetMetadataConfiguration**(Configuration: *[MetadataConfiguration](../interfaces/_api_types_.metadataconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1271](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1271)* +*Defined in [api/media.ts:1271](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1271)* 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. @@ -1508,16 +1508,16 @@ This operation modifies a metadata configuration. The ForcePersistence flag indi | Configuration | [MetadataConfiguration](../interfaces/_api_types_.metadataconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetOSD -▸ **SetOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1473](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1473)* +*Defined in [api/media.ts:1473](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1473)* Set the OSD @@ -1527,16 +1527,16 @@ Set the OSD | ------ | ------ | | OSD | [OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetSynchronizationPoint -▸ **SetSynchronizationPoint**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetSynchronizationPoint**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1417](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1417)* +*Defined in [api/media.ts:1417](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1417)* 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. @@ -1546,16 +1546,16 @@ Synchronization points allow clients to decode and correctly use all data after | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetVideoAnalyticsConfiguration -▸ **SetVideoAnalyticsConfiguration**(Configuration: *[VideoAnalyticsConfiguration](../interfaces/_api_types_.videoanalyticsconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetVideoAnalyticsConfiguration**(Configuration: *[VideoAnalyticsConfiguration](../interfaces/_api_types_.videoanalyticsconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1259](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1259)* +*Defined in [api/media.ts:1259](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1259)* 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. @@ -1566,16 +1566,16 @@ A video analytics configuration is modified using this command. The ForcePersist | Configuration | [VideoAnalyticsConfiguration](../interfaces/_api_types_.videoanalyticsconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetVideoEncoderConfiguration -▸ **SetVideoEncoderConfiguration**(Configuration: *[VideoEncoderConfiguration](../interfaces/_api_types_.videoencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetVideoEncoderConfiguration**(Configuration: *[VideoEncoderConfiguration](../interfaces/_api_types_.videoencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1225](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1225)* +*Defined in [api/media.ts:1225](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1225)* 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. @@ -1586,16 +1586,16 @@ This operation modifies a video encoder configuration. The ForcePersistence flag | Configuration | [VideoEncoderConfiguration](../interfaces/_api_types_.videoencoderconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetVideoSourceConfiguration -▸ **SetVideoSourceConfiguration**(Configuration: *[VideoSourceConfiguration](../interfaces/_api_types_.videosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetVideoSourceConfiguration**(Configuration: *[VideoSourceConfiguration](../interfaces/_api_types_.videosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1218](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1218)* +*Defined in [api/media.ts:1218](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1218)* 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. @@ -1606,16 +1606,16 @@ This operation modifies a video source configuration. The ForcePersistence flag | Configuration | [VideoSourceConfiguration](../interfaces/_api_types_.videosourceconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetVideoSourceMode -▸ **SetVideoSourceMode**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, VideoSourceModeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetVideoSourceMode**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, VideoSourceModeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1445](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1445)* +*Defined in [api/media.ts:1445](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1445)* 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. @@ -1626,16 +1626,16 @@ SetVideoSourceMode changes the media profile structure relating to video source | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | VideoSourceModeToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### StartMulticastStreaming -▸ **StartMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **StartMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1393](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1393)* +*Defined in [api/media.ts:1393](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1393)* 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. @@ -1645,16 +1645,16 @@ This command starts multicast streaming using a specified media profile of a dev | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### StopMulticastStreaming -▸ **StopMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **StopMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/media.ts:1400](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L1400)* +*Defined in [api/media.ts:1400](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L1400)* This command stop multicast streaming using a specified media profile of a device @@ -1664,16 +1664,16 @@ This command stop multicast streaming using a specified media profile of a devic | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` AddAudioDecoderConfiguration -▸ **AddAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:250](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L250)* +*Defined in [api/media.ts:250](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L250)* 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. @@ -1684,16 +1684,16 @@ This operation adds an AudioDecoderConfiguration to an existing media profile. I | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddAudioEncoderConfiguration -▸ **AddAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:128](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L128)* +*Defined in [api/media.ts:128](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L128)* This operation adds an AudioEncoderConfiguration to an existing media profile. If a configuration exists in the media profile, it will be replaced. The change shall be persistent. A device shall support adding a compatible AudioEncoderConfiguration to a profile containing an AudioSourceConfiguration and shall support streaming audio data of such a profile. @@ -1704,16 +1704,16 @@ This operation adds an AudioEncoderConfiguration to an existing media profile. I | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddAudioOutputConfiguration -▸ **AddAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:232](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L232)* +*Defined in [api/media.ts:232](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L232)* 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. @@ -1724,16 +1724,16 @@ This operation adds an AudioOutputConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddAudioSourceConfiguration -▸ **AddAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:149](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L149)* +*Defined in [api/media.ts:149](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L149)* 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. @@ -1744,16 +1744,16 @@ This operation adds an AudioSourceConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddMetadataConfiguration -▸ **AddMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:214](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L214)* +*Defined in [api/media.ts:214](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L214)* 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. @@ -1764,16 +1764,16 @@ This operation adds a Metadata configuration to an existing media profile. If a | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddPTZConfiguration -▸ **AddPTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddPTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:173](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L173)* +*Defined in [api/media.ts:173](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L173)* 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. @@ -1784,16 +1784,16 @@ This operation adds a PTZConfiguration to an existing media profile. If a config | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddVideoAnalyticsConfiguration -▸ **AddVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:195](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L195)* +*Defined in [api/media.ts:195](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L195)* 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. @@ -1804,16 +1804,16 @@ This operation adds a VideoAnalytics configuration to an existing media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddVideoEncoderConfiguration -▸ **AddVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:84](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L84)* +*Defined in [api/media.ts:84](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L84)* 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. @@ -1824,16 +1824,16 @@ This operation adds a VideoEncoderConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` AddVideoSourceConfiguration -▸ **AddVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AddVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:104](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L104)* +*Defined in [api/media.ts:104](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L104)* 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. @@ -1844,16 +1844,16 @@ This operation adds a VideoSourceConfiguration to an existing media profile. If | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateOSD -▸ **CreateOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:814](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L814)* +*Defined in [api/media.ts:814](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L814)* Create the OSD. @@ -1863,16 +1863,16 @@ Create the OSD. | ------ | ------ | | OSD | [OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateProfile -▸ **CreateProfile**(Name: *[Name]()*, Token?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateProfile**(Name: *[Name]()*, Token?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L50)* +*Defined in [api/media.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L50)* 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. @@ -1883,16 +1883,16 @@ This operation creates a new empty media profile. The media profile shall be cre | Name | [Name]() | | `Optional` Token | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteOSD -▸ **DeleteOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:823](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L823)* +*Defined in [api/media.ts:823](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L823)* Delete the OSD. @@ -1902,16 +1902,16 @@ Delete the OSD. | ------ | ------ | | OSDToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteProfile -▸ **DeleteProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:268](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L268)* +*Defined in [api/media.ts:268](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L268)* This operation deletes a profile. This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles @@ -1921,16 +1921,16 @@ This operation deletes a profile. This change shall always be persistent. Deleti | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioDecoderConfiguration -▸ **GetAudioDecoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioDecoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:413](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L413)* +*Defined in [api/media.ts:413](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L413)* If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command. @@ -1940,16 +1940,16 @@ If the audio decoder configuration token is already known, the decoder configura | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioDecoderConfigurationOptions -▸ **GetAudioDecoderConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioDecoderConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:659](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L659)* +*Defined in [api/media.ts:659](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L659)* This command list the audio decoding capabilities for a given profile and configuration of a device. @@ -1960,29 +1960,29 @@ This command list the audio decoding capabilities for a given profile and config | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioDecoderConfigurations -▸ **GetAudioDecoderConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioDecoderConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:341](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L341)* +*Defined in [api/media.ts:341](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L341)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioEncoderConfiguration -▸ **GetAudioEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:377](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L377)* +*Defined in [api/media.ts:377](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L377)* The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known. @@ -1992,16 +1992,16 @@ The GetAudioEncoderConfiguration command fetches the encoder configuration if th | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioEncoderConfigurationOptions -▸ **GetAudioEncoderConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioEncoderConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:631](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L631)* +*Defined in [api/media.ts:631](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L631)* This operation returns the available options (supported values and ranges for audio encoder configuration parameters) when the audio encoder parameters are reconfigured. @@ -2012,29 +2012,29 @@ This operation returns the available options (supported values and ranges for au | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioEncoderConfigurations -▸ **GetAudioEncoderConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioEncoderConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:304](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L304)* +*Defined in [api/media.ts:304](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L304)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioOutputConfiguration -▸ **GetAudioOutputConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioOutputConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:404](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L404)* +*Defined in [api/media.ts:404](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L404)* If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command. @@ -2044,16 +2044,16 @@ If the audio output configuration token is already known, the output configurati | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioOutputConfigurationOptions -▸ **GetAudioOutputConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioOutputConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:649](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L649)* +*Defined in [api/media.ts:649](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L649)* This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. @@ -2064,42 +2064,42 @@ This operation returns the available options (supported values and ranges for au | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioOutputConfigurations -▸ **GetAudioOutputConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioOutputConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:331](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L331)* +*Defined in [api/media.ts:331](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L331)* This command lists all existing AudioOutputConfigurations of a device. The NVC need not know anything apriori about the audio configurations to use this command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioOutputs -▸ **GetAudioOutputs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioOutputs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L39)* +*Defined in [api/media.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L39)* This command lists all available physical audio outputs of the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioSourceConfiguration -▸ **GetAudioSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:368](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L368)* +*Defined in [api/media.ts:368](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L368)* The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known. An @@ -2109,16 +2109,16 @@ The GetAudioSourceConfiguration command fetches the audio source configurations | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioSourceConfigurationOptions -▸ **GetAudioSourceConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioSourceConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:621](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L621)* +*Defined in [api/media.ts:621](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L621)* 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. @@ -2129,42 +2129,42 @@ This operation returns the available options (supported values and ranges for au | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioSourceConfigurations -▸ **GetAudioSourceConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioSourceConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:295](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L295)* +*Defined in [api/media.ts:295](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L295)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetAudioSources -▸ **GetAudioSources**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetAudioSources**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L30)* +*Defined in [api/media.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L30)* This command lists all available physical audio inputs of the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleAudioDecoderConfigurations -▸ **GetCompatibleAudioDecoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleAudioDecoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:489](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L489)* +*Defined in [api/media.ts:489](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L489)* 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. @@ -2174,16 +2174,16 @@ This operation lists all the audio decoder configurations of the device that are | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleAudioEncoderConfigurations -▸ **GetCompatibleAudioEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleAudioEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:443](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L443)* +*Defined in [api/media.ts:443](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L443)* 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. @@ -2193,16 +2193,16 @@ This operation requests all audio encoder configurations of a device that are co | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleAudioOutputConfigurations -▸ **GetCompatibleAudioOutputConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleAudioOutputConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:480](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L480)* +*Defined in [api/media.ts:480](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L480)* This command lists all audio output configurations of a device that are compatible with a certain media profile. Each returned configuration shall be a valid input for the AddAudioOutputConfiguration command. @@ -2212,16 +2212,16 @@ This command lists all audio output configurations of a device that are compatib | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleAudioSourceConfigurations -▸ **GetCompatibleAudioSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleAudioSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:452](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L452)* +*Defined in [api/media.ts:452](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L452)* 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. @@ -2231,16 +2231,16 @@ This operation requests all audio source configurations of the device that are c | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleMetadataConfigurations -▸ **GetCompatibleMetadataConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleMetadataConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:470](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L470)* +*Defined in [api/media.ts:470](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L470)* 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. @@ -2250,16 +2250,16 @@ This operation requests all the metadata configurations of the device that are c | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleVideoAnalyticsConfigurations -▸ **GetCompatibleVideoAnalyticsConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleVideoAnalyticsConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:461](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L461)* +*Defined in [api/media.ts:461](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L461)* 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. @@ -2269,16 +2269,16 @@ This operation requests all video analytic configurations of the device that are | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleVideoEncoderConfigurations -▸ **GetCompatibleVideoEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleVideoEncoderConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:422](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L422)* +*Defined in [api/media.ts:422](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L422)* 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. @@ -2288,16 +2288,16 @@ This operation lists all the video encoder configurations of the device that are | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleVideoSourceConfigurations -▸ **GetCompatibleVideoSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleVideoSourceConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:434](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L434)* +*Defined in [api/media.ts:434](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L434)* 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. @@ -2307,16 +2307,16 @@ This operation requests all the video source configurations of the device that a | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetGuaranteedNumberOfVideoEncoderInstances -▸ **GetGuaranteedNumberOfVideoEncoderInstances**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetGuaranteedNumberOfVideoEncoderInstances**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:670](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L670)* +*Defined in [api/media.ts:670](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L670)* The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request the minimum number of guaranteed video encoder instances (applications) per Video Source Configuration. @@ -2326,16 +2326,16 @@ The GetGuaranteedNumberOfVideoEncoderInstances command can be used to request th | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetMetadataConfiguration -▸ **GetMetadataConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetMetadataConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:395](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L395)* +*Defined in [api/media.ts:395](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L395)* The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. @@ -2345,16 +2345,16 @@ The GetMetadataConfiguration command fetches the metadata configuration if the m | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetMetadataConfigurationOptions -▸ **GetMetadataConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetMetadataConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:640](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L640)* +*Defined in [api/media.ts:640](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L640)* This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. @@ -2365,29 +2365,29 @@ This operation returns the available options (supported values and ranges for me | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetMetadataConfigurations -▸ **GetMetadataConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetMetadataConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:322](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L322)* +*Defined in [api/media.ts:322](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L322)* This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetOSD -▸ **GetOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetOSD**(OSDToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:787](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L787)* +*Defined in [api/media.ts:787](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L787)* Get the OSD. @@ -2397,16 +2397,16 @@ Get the OSD. | ------ | ------ | | OSDToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetOSDOptions -▸ **GetOSDOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetOSDOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:796](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L796)* +*Defined in [api/media.ts:796](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L796)* Get the OSD Options. @@ -2416,16 +2416,16 @@ Get the OSD Options. | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetOSDs -▸ **GetOSDs**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetOSDs**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:778](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L778)* +*Defined in [api/media.ts:778](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L778)* Get the OSDs. @@ -2435,16 +2435,16 @@ Get the OSDs. | ------ | ------ | | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetProfile -▸ **GetProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetProfile**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L59)* +*Defined in [api/media.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L59)* If the profile token is already known, a profile can be fetched through the GetProfile command. @@ -2454,42 +2454,42 @@ If the profile token is already known, a profile can be fetched through the GetP | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetProfiles -▸ **GetProfiles**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetProfiles**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L71)* +*Defined in [api/media.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L71)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L12)* +*Defined in [api/media.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L12)* Returns the capabilities of the media service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSnapshotUri -▸ **GetSnapshotUri**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSnapshotUri**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:751](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L751)* +*Defined in [api/media.ts:751](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L751)* 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. @@ -2499,16 +2499,16 @@ A client uses the GetSnapshotUri command to obtain a JPEG snapshot from the devi | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetStreamUri -▸ **GetStreamUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetStreamUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:693](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L693)* +*Defined in [api/media.ts:693](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L693)* 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: @@ -2523,16 +2523,16 @@ If a multicast stream is requested the VideoEncoderConfiguration, AudioEncoderCo | StreamSetup | [StreamSetup](../interfaces/_api_types_.streamsetup.md) | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoAnalyticsConfiguration -▸ **GetVideoAnalyticsConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoAnalyticsConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:386](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L386)* +*Defined in [api/media.ts:386](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L386)* The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known. @@ -2542,29 +2542,29 @@ The GetVideoAnalyticsConfiguration command fetches the video analytics configura | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoAnalyticsConfigurations -▸ **GetVideoAnalyticsConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoAnalyticsConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:313](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L313)* +*Defined in [api/media.ts:313](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L313)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoEncoderConfiguration -▸ **GetVideoEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoEncoderConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:359](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L359)* +*Defined in [api/media.ts:359](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L359)* If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. @@ -2574,16 +2574,16 @@ If the video encoder configuration token is already known, the encoder configura | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoEncoderConfigurationOptions -▸ **GetVideoEncoderConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoEncoderConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:609](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L609)* +*Defined in [api/media.ts:609](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L609)* 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. @@ -2594,29 +2594,29 @@ This operation returns the available options (supported values and ranges for vi | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoEncoderConfigurations -▸ **GetVideoEncoderConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoEncoderConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:286](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L286)* +*Defined in [api/media.ts:286](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L286)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoSourceConfiguration -▸ **GetVideoSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoSourceConfiguration**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:350](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L350)* +*Defined in [api/media.ts:350](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L350)* If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command. @@ -2626,16 +2626,16 @@ If the video source configuration token is already known, the video source confi | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoSourceConfigurationOptions -▸ **GetVideoSourceConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoSourceConfigurationOptions**(ConfigurationToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, ProfileToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:593](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L593)* +*Defined in [api/media.ts:593](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L593)* 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. @@ -2646,29 +2646,29 @@ This operation returns the available options (supported values and ranges for vi | `Optional` ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoSourceConfigurations -▸ **GetVideoSourceConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoSourceConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:277](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L277)* +*Defined in [api/media.ts:277](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L277)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoSourceModes -▸ **GetVideoSourceModes**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoSourceModes**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:760](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L760)* +*Defined in [api/media.ts:760](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L760)* 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. @@ -2678,29 +2678,29 @@ A device returns the information for current video source mode and settable vide | ------ | ------ | | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetVideoSources -▸ **GetVideoSources**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetVideoSources**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L21)* +*Defined in [api/media.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L21)* This command lists all available physical video inputs of the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveAudioDecoderConfiguration -▸ **RemoveAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveAudioDecoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:259](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L259)* +*Defined in [api/media.ts:259](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L259)* 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. @@ -2710,16 +2710,16 @@ This operation removes an AudioDecoderConfiguration from an existing media profi | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveAudioEncoderConfiguration -▸ **RemoveAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveAudioEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:139](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L139)* +*Defined in [api/media.ts:139](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L139)* 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. @@ -2729,16 +2729,16 @@ This operation removes an AudioEncoderConfiguration from an existing media profi | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveAudioOutputConfiguration -▸ **RemoveAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveAudioOutputConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:241](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L241)* +*Defined in [api/media.ts:241](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L241)* 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. @@ -2748,16 +2748,16 @@ This operation removes an AudioOutputConfiguration from an existing media profil | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveAudioSourceConfiguration -▸ **RemoveAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveAudioSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:161](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L161)* +*Defined in [api/media.ts:161](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L161)* 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. @@ -2767,16 +2767,16 @@ This operation removes an AudioSourceConfiguration from an existing media profil | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveMetadataConfiguration -▸ **RemoveMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveMetadataConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:223](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L223)* +*Defined in [api/media.ts:223](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L223)* 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. @@ -2786,16 +2786,16 @@ This operation removes a MetadataConfiguration from an existing media profile. I | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemovePTZConfiguration -▸ **RemovePTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemovePTZConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:183](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L183)* +*Defined in [api/media.ts:183](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L183)* 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. @@ -2805,16 +2805,16 @@ This operation removes a PTZConfiguration from an existing media profile. If the | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveVideoAnalyticsConfiguration -▸ **RemoveVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveVideoAnalyticsConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:205](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L205)* +*Defined in [api/media.ts:205](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L205)* 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. @@ -2824,16 +2824,16 @@ This operation removes a VideoAnalyticsConfiguration from an existing media prof | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveVideoEncoderConfiguration -▸ **RemoveVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveVideoEncoderConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:94](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L94)* +*Defined in [api/media.ts:94](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L94)* 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. @@ -2843,16 +2843,16 @@ This operation removes a VideoEncoderConfiguration from an existing media profil | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemoveVideoSourceConfiguration -▸ **RemoveVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemoveVideoSourceConfiguration**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:115](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L115)* +*Defined in [api/media.ts:115](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L115)* 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. @@ -2862,16 +2862,16 @@ This operation removes a VideoSourceConfiguration from an existing media profile | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetAudioDecoderConfiguration -▸ **SetAudioDecoderConfiguration**(Configuration: *[AudioDecoderConfiguration](../interfaces/_api_types_.audiodecoderconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetAudioDecoderConfiguration**(Configuration: *[AudioDecoderConfiguration](../interfaces/_api_types_.audiodecoderconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:581](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L581)* +*Defined in [api/media.ts:581](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L581)* This operation modifies an audio decoder configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. @@ -2882,16 +2882,16 @@ This operation modifies an audio decoder configuration. The ForcePersistence fla | Configuration | [AudioDecoderConfiguration](../interfaces/_api_types_.audiodecoderconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetAudioEncoderConfiguration -▸ **SetAudioEncoderConfiguration**(Configuration: *[AudioEncoderConfiguration](../interfaces/_api_types_.audioencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetAudioEncoderConfiguration**(Configuration: *[AudioEncoderConfiguration](../interfaces/_api_types_.audioencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:533](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L533)* +*Defined in [api/media.ts:533](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L533)* 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. @@ -2902,16 +2902,16 @@ This operation modifies an audio encoder configuration. The ForcePersistence fla | Configuration | [AudioEncoderConfiguration](../interfaces/_api_types_.audioencoderconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetAudioOutputConfiguration -▸ **SetAudioOutputConfiguration**(Configuration: *[AudioOutputConfiguration](../interfaces/_api_types_.audiooutputconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetAudioOutputConfiguration**(Configuration: *[AudioOutputConfiguration](../interfaces/_api_types_.audiooutputconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:571](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L571)* +*Defined in [api/media.ts:571](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L571)* This operation modifies an audio output configuration. The ForcePersistence flag indicates if the changes shall remain after reboot of the device. @@ -2922,16 +2922,16 @@ This operation modifies an audio output configuration. The ForcePersistence flag | Configuration | [AudioOutputConfiguration](../interfaces/_api_types_.audiooutputconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetAudioSourceConfiguration -▸ **SetAudioSourceConfiguration**(Configuration: *[AudioSourceConfiguration](../interfaces/_api_types_.audiosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetAudioSourceConfiguration**(Configuration: *[AudioSourceConfiguration](../interfaces/_api_types_.audiosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:520](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L520)* +*Defined in [api/media.ts:520](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L520)* 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. @@ -2942,16 +2942,16 @@ This operation modifies an audio source configuration. The ForcePersistence flag | Configuration | [AudioSourceConfiguration](../interfaces/_api_types_.audiosourceconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetMetadataConfiguration -▸ **SetMetadataConfiguration**(Configuration: *[MetadataConfiguration](../interfaces/_api_types_.metadataconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetMetadataConfiguration**(Configuration: *[MetadataConfiguration](../interfaces/_api_types_.metadataconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:561](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L561)* +*Defined in [api/media.ts:561](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L561)* 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. @@ -2962,16 +2962,16 @@ This operation modifies a metadata configuration. The ForcePersistence flag indi | Configuration | [MetadataConfiguration](../interfaces/_api_types_.metadataconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetOSD -▸ **SetOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetOSD**(OSD: *[OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:805](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L805)* +*Defined in [api/media.ts:805](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L805)* Set the OSD @@ -2981,16 +2981,16 @@ Set the OSD | ------ | ------ | | OSD | [OSDConfiguration](../interfaces/_api_types_.osdconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetSynchronizationPoint -▸ **SetSynchronizationPoint**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetSynchronizationPoint**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:735](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L735)* +*Defined in [api/media.ts:735](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L735)* 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. @@ -3000,16 +3000,16 @@ Synchronization points allow clients to decode and correctly use all data after | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetVideoAnalyticsConfiguration -▸ **SetVideoAnalyticsConfiguration**(Configuration: *[VideoAnalyticsConfiguration](../interfaces/_api_types_.videoanalyticsconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetVideoAnalyticsConfiguration**(Configuration: *[VideoAnalyticsConfiguration](../interfaces/_api_types_.videoanalyticsconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:547](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L547)* +*Defined in [api/media.ts:547](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L547)* 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. @@ -3020,16 +3020,16 @@ A video analytics configuration is modified using this command. The ForcePersist | Configuration | [VideoAnalyticsConfiguration](../interfaces/_api_types_.videoanalyticsconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetVideoEncoderConfiguration -▸ **SetVideoEncoderConfiguration**(Configuration: *[VideoEncoderConfiguration](../interfaces/_api_types_.videoencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetVideoEncoderConfiguration**(Configuration: *[VideoEncoderConfiguration](../interfaces/_api_types_.videoencoderconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:507](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L507)* +*Defined in [api/media.ts:507](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L507)* 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. @@ -3040,16 +3040,16 @@ This operation modifies a video encoder configuration. The ForcePersistence flag | Configuration | [VideoEncoderConfiguration](../interfaces/_api_types_.videoencoderconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetVideoSourceConfiguration -▸ **SetVideoSourceConfiguration**(Configuration: *[VideoSourceConfiguration](../interfaces/_api_types_.videosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetVideoSourceConfiguration**(Configuration: *[VideoSourceConfiguration](../interfaces/_api_types_.videosourceconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:498](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L498)* +*Defined in [api/media.ts:498](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L498)* 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. @@ -3060,16 +3060,16 @@ This operation modifies a video source configuration. The ForcePersistence flag | Configuration | [VideoSourceConfiguration](../interfaces/_api_types_.videosourceconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetVideoSourceMode -▸ **SetVideoSourceMode**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, VideoSourceModeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetVideoSourceMode**(VideoSourceToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, VideoSourceModeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:769](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L769)* +*Defined in [api/media.ts:769](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L769)* 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. @@ -3080,16 +3080,16 @@ SetVideoSourceMode changes the media profile structure relating to video source | VideoSourceToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | VideoSourceModeToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` StartMulticastStreaming -▸ **StartMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **StartMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:707](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L707)* +*Defined in [api/media.ts:707](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L707)* 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. @@ -3099,16 +3099,16 @@ This command starts multicast streaming using a specified media profile of a dev | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` StopMulticastStreaming -▸ **StopMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **StopMulticastStreaming**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/media.ts:716](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/media.ts#L716)* +*Defined in [api/media.ts:716](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/media.ts#L716)* This command stop multicast streaming using a specified media profile of a device @@ -3118,7 +3118,7 @@ This command stop multicast streaming using a specified media profile of a devic | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_provisioning_.onvifprovisioning.md b/docs/classes/_api_provisioning_.onvifprovisioning.md index e8a8d60..9311df4 100644 --- a/docs/classes/_api_provisioning_.onvifprovisioning.md +++ b/docs/classes/_api_provisioning_.onvifprovisioning.md @@ -45,7 +45,7 @@ ⊕ **new ONVIFProvisioning**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFProvisioning](_api_provisioning_.onvifprovisioning.md) -*Defined in [api/provisioning.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L5)* +*Defined in [api/provisioning.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L5)* **Parameters:** @@ -65,7 +65,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/provisioning.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L6)* +*Defined in [api/provisioning.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L6)* ___ @@ -75,208 +75,208 @@ ___ ### FocusMove -▸ **FocusMove**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **FocusMove**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:119](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L119)* +*Defined in [api/provisioning.ts:119](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L119)* Moves device on the focus axis. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:84](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L84)* +*Defined in [api/provisioning.ts:84](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L84)* Returns the capabilities of the provisioning service. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetUsage -▸ **GetUsage**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetUsage**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:133](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L133)* +*Defined in [api/provisioning.ts:133](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L133)* Returns the lifetime move counts. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### PanMove -▸ **PanMove**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **PanMove**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:91](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L91)* +*Defined in [api/provisioning.ts:91](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L91)* Moves device on the pan axis. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RollMove -▸ **RollMove**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RollMove**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:112](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L112)* +*Defined in [api/provisioning.ts:112](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L112)* Moves device on the roll axis. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### Stop -▸ **Stop**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **Stop**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:126](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L126)* +*Defined in [api/provisioning.ts:126](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L126)* Stops device motion on all axes. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### TiltMove -▸ **TiltMove**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **TiltMove**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L98)* +*Defined in [api/provisioning.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L98)* Moves device on the tilt axis. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ZoomMove -▸ **ZoomMove**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ZoomMove**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/provisioning.ts:105](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L105)* +*Defined in [api/provisioning.ts:105](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L105)* Moves device on the zoom axis. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` FocusMove -▸ **FocusMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **FocusMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:57](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L57)* +*Defined in [api/provisioning.ts:57](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L57)* Moves device on the focus axis. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L12)* +*Defined in [api/provisioning.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L12)* Returns the capabilities of the provisioning service. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetUsage -▸ **GetUsage**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetUsage**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:75](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L75)* +*Defined in [api/provisioning.ts:75](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L75)* Returns the lifetime move counts. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` PanMove -▸ **PanMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **PanMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L21)* +*Defined in [api/provisioning.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L21)* Moves device on the pan axis. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RollMove -▸ **RollMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RollMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:48](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L48)* +*Defined in [api/provisioning.ts:48](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L48)* Moves device on the roll axis. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` Stop -▸ **Stop**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **Stop**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:66](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L66)* +*Defined in [api/provisioning.ts:66](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L66)* Stops device motion on all axes. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` TiltMove -▸ **TiltMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **TiltMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L30)* +*Defined in [api/provisioning.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L30)* Moves device on the tilt axis. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ZoomMove -▸ **ZoomMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ZoomMove**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/provisioning.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/provisioning.ts#L39)* +*Defined in [api/provisioning.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/provisioning.ts#L39)* Moves device on the zoom axis. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_ptz_.onvifptz.md b/docs/classes/_api_ptz_.onvifptz.md index 1a94208..1ad7b1e 100644 --- a/docs/classes/_api_ptz_.onvifptz.md +++ b/docs/classes/_api_ptz_.onvifptz.md @@ -85,7 +85,7 @@ ⊕ **new ONVIFPTZ**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFPTZ](_api_ptz_.onvifptz.md) -*Defined in [api/ptz.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L5)* +*Defined in [api/ptz.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L5)* **Parameters:** @@ -105,7 +105,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/ptz.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L6)* +*Defined in [api/ptz.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L6)* ___ @@ -115,9 +115,9 @@ ___ ### AbsoluteMove -▸ **AbsoluteMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Position: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **AbsoluteMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Position: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:578](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L578)* +*Defined in [api/ptz.ts:578](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L578)* 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. @@ -129,16 +129,16 @@ Operation to move pan,tilt or zoom to a absolute destination. The speed argument | Position | [PTZVector](../interfaces/_api_types_.ptzvector.md) | | Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ContinuousMove -▸ **ContinuousMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Velocity: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, Timeout: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ContinuousMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Velocity: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, Timeout: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:547](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L547)* +*Defined in [api/ptz.ts:547](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L547)* 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. @@ -150,16 +150,16 @@ Operation for continuous Pan/Tilt and Zoom movements. The operation is supported | Velocity | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | | Timeout | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreatePresetTour -▸ **CreatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:627](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L627)* +*Defined in [api/ptz.ts:627](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L627)* Operation to create a preset tour for the selected media profile. @@ -169,16 +169,16 @@ Operation to create a preset tour for the selected media profile. | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GeoMove -▸ **GeoMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Target: *[GeoLocation](../interfaces/_api_types_.geolocation.md)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, AreaHeight: *`number`*, AreaWidth: *`number`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GeoMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Target: *[GeoLocation](../interfaces/_api_types_.geolocation.md)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, AreaHeight: *`number`*, AreaWidth: *`number`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:591](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L591)* +*Defined in [api/ptz.ts:591](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L591)* Operation to move pan,tilt or zoom to point to a destination based on the geolocation of the target. The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used. The area height and area dwidth parameters are optional, they can be used independently and may be used by the device to automatically determine the best zoom level to show the target. @@ -192,16 +192,16 @@ Operation to move pan,tilt or zoom to point to a destination based on the geoloc | AreaHeight | `number` | | AreaWidth | `number` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetCompatibleConfigurations -▸ **GetCompatibleConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetCompatibleConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:659](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L659)* +*Defined in [api/ptz.ts:659](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L659)* Operation to get all available PTZConfigurations that can be added to the referenced media profile. A device providing more than one PTZConfiguration or more than one VideoSourceConfiguration or which has any other resource interdependency between PTZConfiguration entities and other resources listable in a media profile should implement this operation. PTZConfiguration entities returned by this operation shall not fail on adding them to the referenced media profile. @@ -211,16 +211,16 @@ Operation to get all available PTZConfigurations that can be added to the refere | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetConfiguration -▸ **GetConfiguration**(PTZConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetConfiguration**(PTZConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:413](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L413)* +*Defined in [api/ptz.ts:413](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L413)* Get a specific PTZconfiguration from the device, identified by its reference token or name. @@ -232,16 +232,16 @@ The default Position/Translation/Velocity Spaces are introduced to allow NVCs se | ------ | ------ | | PTZConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetConfigurationOptions -▸ **GetConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:460](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L460)* +*Defined in [api/ptz.ts:460](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L460)* 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. @@ -251,16 +251,16 @@ List supported coordinate systems including their range limitations. Therefore, | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetConfigurations -▸ **GetConfigurations**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetConfigurations**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:437](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L437)* +*Defined in [api/ptz.ts:437](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L437)* ``` Get all the existing PTZConfigurations from the device. @@ -268,16 +268,16 @@ ___ 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNode -▸ **GetNode**(NodeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNode**(NodeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:390](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L390)* +*Defined in [api/ptz.ts:390](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L390)* Get a specific PTZ Node identified by a reference token or a name. @@ -287,31 +287,31 @@ Get a specific PTZ Node identified by a reference token or a name. | ------ | ------ | | NodeToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetNodes -▸ **GetNodes**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetNodes**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:381](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L381)* +*Defined in [api/ptz.ts:381](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L381)* 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. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPresetTour -▸ **GetPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:613](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L613)* +*Defined in [api/ptz.ts:613](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L613)* Operation to request a specific PTZ preset tour in the selected media profile. @@ -322,16 +322,16 @@ Operation to request a specific PTZ preset tour in the selected media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPresetTourOptions -▸ **GetPresetTourOptions**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPresetTourOptions**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:620](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L620)* +*Defined in [api/ptz.ts:620](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L620)* Operation to request available options to configure PTZ preset tour. @@ -342,16 +342,16 @@ Operation to request available options to configure PTZ preset tour. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPresetTours -▸ **GetPresetTours**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPresetTours**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:606](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L606)* +*Defined in [api/ptz.ts:606](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L606)* Operation to request PTZ preset tours in the selected media profiles. @@ -361,16 +361,16 @@ Operation to request PTZ preset tours in the selected media profiles. | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPresets -▸ **GetPresets**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPresets**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:482](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L482)* +*Defined in [api/ptz.ts:482](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L482)* ``` Operation to request all PTZ presets for the PTZNode @@ -384,29 +384,29 @@ ___ | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:367](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L367)* +*Defined in [api/ptz.ts:367](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L367)* Returns the capabilities of the PTZ service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetStatus -▸ **GetStatus**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetStatus**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:567](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L567)* +*Defined in [api/ptz.ts:567](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L567)* Operation to request PTZ status for the Node in the selected profile. @@ -416,16 +416,16 @@ Operation to request PTZ status for the Node in the selected profile. | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GotoHomePosition -▸ **GotoHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GotoHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:530](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L530)* +*Defined in [api/ptz.ts:530](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L530)* ``` Operation to move the PTZ device to it's "home" position. The operation is supported if the HomeSupported element in the PTZNode is true. @@ -438,16 +438,16 @@ ___ | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GotoPreset -▸ **GotoPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GotoPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:522](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L522)* +*Defined in [api/ptz.ts:522](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L522)* ``` Operation to go to a saved preset position for the @@ -463,16 +463,16 @@ ___ | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ModifyPresetTour -▸ **ModifyPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTour: *[PresetTour](../interfaces/_api_types_.presettour.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ModifyPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTour: *[PresetTour](../interfaces/_api_types_.presettour.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:634](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L634)* +*Defined in [api/ptz.ts:634](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L634)* Operation to modify a preset tour for the selected media profile. @@ -483,16 +483,16 @@ Operation to modify a preset tour for the selected media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTour | [PresetTour](../interfaces/_api_types_.presettour.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### OperatePresetTour -▸ **OperatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Operation: *[PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **OperatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Operation: *[PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:641](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L641)* +*Defined in [api/ptz.ts:641](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L641)* Operation to perform specific operation on the preset tour in selected media profile. @@ -504,16 +504,16 @@ Operation to perform specific operation on the preset tour in selected media pro | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Operation | [PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RelativeMove -▸ **RelativeMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Translation: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RelativeMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Translation: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:558](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L558)* +*Defined in [api/ptz.ts:558](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L558)* 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. @@ -525,16 +525,16 @@ Operation for Relative Pan/Tilt and Zoom Move. The operation is supported if the | Translation | [PTZVector](../interfaces/_api_types_.ptzvector.md) | | Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemovePreset -▸ **RemovePreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemovePreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:512](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L512)* +*Defined in [api/ptz.ts:512](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L512)* ``` Operation to remove a PTZ preset for the Node in @@ -552,16 +552,16 @@ ___ | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### RemovePresetTour -▸ **RemovePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **RemovePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:648](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L648)* +*Defined in [api/ptz.ts:648](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L648)* Operation to delete a specific preset tour from the media profile. @@ -572,16 +572,16 @@ Operation to delete a specific preset tour from the media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SendAuxiliaryCommand -▸ **SendAuxiliaryCommand**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AuxiliaryData: *[AuxiliaryData]()*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SendAuxiliaryCommand**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AuxiliaryData: *[AuxiliaryData]()*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:472](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L472)* +*Defined in [api/ptz.ts:472](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L472)* ``` Operation to send auxiliary commands to the PTZ device @@ -597,16 +597,16 @@ ___ | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AuxiliaryData | [AuxiliaryData]() | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetConfiguration -▸ **SetConfiguration**(PTZConfiguration: *[PTZConfiguration](../interfaces/_api_types_.ptzconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetConfiguration**(PTZConfiguration: *[PTZConfiguration](../interfaces/_api_types_.ptzconfiguration.md)*, ForcePersistence: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:446](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L446)* +*Defined in [api/ptz.ts:446](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L446)* ``` Set/update a existing PTZConfiguration on the device. @@ -619,16 +619,16 @@ ___ | PTZConfiguration | [PTZConfiguration](../interfaces/_api_types_.ptzconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetHomePosition -▸ **SetHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:540](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L540)* +*Defined in [api/ptz.ts:540](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L540)* 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. @@ -638,16 +638,16 @@ Operation to save current position as the home position. The SetHomePosition com | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetPreset -▸ **SetPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetName: *`string`*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetName: *`string`*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:498](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L498)* +*Defined in [api/ptz.ts:498](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L498)* 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. @@ -659,16 +659,16 @@ The SetPreset command saves the current device position parameters so that the d | PresetName | `string` | | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### Stop -▸ **Stop**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PanTilt: *`boolean`*, Zoom: *`boolean`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **Stop**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PanTilt: *`boolean`*, Zoom: *`boolean`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/ptz.ts:599](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L599)* +*Defined in [api/ptz.ts:599](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L599)* 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. @@ -680,16 +680,16 @@ Operation to stop ongoing pan, tilt and zoom movements of absolute relative and | PanTilt | `boolean` | | Zoom | `boolean` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` AbsoluteMove -▸ **AbsoluteMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Position: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **AbsoluteMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Position: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:257](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L257)* +*Defined in [api/ptz.ts:257](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L257)* 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. @@ -701,16 +701,16 @@ Operation to move pan,tilt or zoom to a absolute destination. The speed argument | Position | [PTZVector](../interfaces/_api_types_.ptzvector.md) | | `Optional` Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ContinuousMove -▸ **ContinuousMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Velocity: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, Timeout?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ContinuousMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Velocity: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, Timeout?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:220](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L220)* +*Defined in [api/ptz.ts:220](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L220)* 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. @@ -722,16 +722,16 @@ Operation for continuous Pan/Tilt and Zoom movements. The operation is supported | Velocity | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | | `Optional` Timeout | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreatePresetTour -▸ **CreatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:318](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L318)* +*Defined in [api/ptz.ts:318](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L318)* Operation to create a preset tour for the selected media profile. @@ -741,16 +741,16 @@ Operation to create a preset tour for the selected media profile. | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GeoMove -▸ **GeoMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Target: *[GeoLocation](../interfaces/_api_types_.geolocation.md)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, AreaHeight?: *`undefined` \| `number`*, AreaWidth?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GeoMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Target: *[GeoLocation](../interfaces/_api_types_.geolocation.md)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*, AreaHeight?: *`undefined` \| `number`*, AreaWidth?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:272](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L272)* +*Defined in [api/ptz.ts:272](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L272)* Operation to move pan,tilt or zoom to point to a destination based on the geolocation of the target. The speed argument is optional. If an x/y speed value is given it is up to the device to either use the x value as absolute resoluting speed vector or to map x and y to the component speed. If the speed argument is omitted, the default speed set by the PTZConfiguration will be used. The area height and area dwidth parameters are optional, they can be used independently and may be used by the device to automatically determine the best zoom level to show the target. @@ -764,16 +764,16 @@ Operation to move pan,tilt or zoom to point to a destination based on the geoloc | `Optional` AreaHeight | `undefined` \| `number` | | `Optional` AreaWidth | `undefined` \| `number` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetCompatibleConfigurations -▸ **GetCompatibleConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetCompatibleConfigurations**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:358](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L358)* +*Defined in [api/ptz.ts:358](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L358)* Operation to get all available PTZConfigurations that can be added to the referenced media profile. A device providing more than one PTZConfiguration or more than one VideoSourceConfiguration or which has any other resource interdependency between PTZConfiguration entities and other resources listable in a media profile should implement this operation. PTZConfiguration entities returned by this operation shall not fail on adding them to the referenced media profile. @@ -783,16 +783,16 @@ Operation to get all available PTZConfigurations that can be added to the refere | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetConfiguration -▸ **GetConfiguration**(PTZConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetConfiguration**(PTZConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:64](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L64)* +*Defined in [api/ptz.ts:64](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L64)* Get a specific PTZconfiguration from the device, identified by its reference token or name. @@ -804,16 +804,16 @@ The default Position/Translation/Velocity Spaces are introduced to allow NVCs se | ------ | ------ | | PTZConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetConfigurationOptions -▸ **GetConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetConfigurationOptions**(ConfigurationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:117](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L117)* +*Defined in [api/ptz.ts:117](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L117)* 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. @@ -823,16 +823,16 @@ List supported coordinate systems including their range limitations. Therefore, | ------ | ------ | | ConfigurationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetConfigurations -▸ **GetConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetConfigurations**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:90](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L90)* +*Defined in [api/ptz.ts:90](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L90)* ``` Get all the existing PTZConfigurations from the device. @@ -840,16 +840,16 @@ ___ 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNode -▸ **GetNode**(NodeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNode**(NodeToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L39)* +*Defined in [api/ptz.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L39)* Get a specific PTZ Node identified by a reference token or a name. @@ -859,31 +859,31 @@ Get a specific PTZ Node identified by a reference token or a name. | ------ | ------ | | NodeToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetNodes -▸ **GetNodes**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetNodes**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:28](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L28)* +*Defined in [api/ptz.ts:28](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L28)* 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. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPresetTour -▸ **GetPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:300](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L300)* +*Defined in [api/ptz.ts:300](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L300)* Operation to request a specific PTZ preset tour in the selected media profile. @@ -894,16 +894,16 @@ Operation to request a specific PTZ preset tour in the selected media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPresetTourOptions -▸ **GetPresetTourOptions**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPresetTourOptions**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:309](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L309)* +*Defined in [api/ptz.ts:309](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L309)* Operation to request available options to configure PTZ preset tour. @@ -914,16 +914,16 @@ Operation to request available options to configure PTZ preset tour. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPresetTours -▸ **GetPresetTours**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPresetTours**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:291](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L291)* +*Defined in [api/ptz.ts:291](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L291)* Operation to request PTZ preset tours in the selected media profiles. @@ -933,16 +933,16 @@ Operation to request PTZ preset tours in the selected media profiles. | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPresets -▸ **GetPresets**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPresets**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:143](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L143)* +*Defined in [api/ptz.ts:143](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L143)* ``` Operation to request all PTZ presets for the PTZNode @@ -956,29 +956,29 @@ ___ | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L12)* +*Defined in [api/ptz.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L12)* Returns the capabilities of the PTZ service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetStatus -▸ **GetStatus**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetStatus**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:244](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L244)* +*Defined in [api/ptz.ts:244](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L244)* Operation to request PTZ status for the Node in the selected profile. @@ -988,16 +988,16 @@ Operation to request PTZ status for the Node in the selected profile. | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GotoHomePosition -▸ **GotoHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GotoHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:199](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L199)* +*Defined in [api/ptz.ts:199](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L199)* ``` Operation to move the PTZ device to it's "home" position. The operation is supported if the HomeSupported element in the PTZNode is true. @@ -1010,16 +1010,16 @@ ___ | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GotoPreset -▸ **GotoPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GotoPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:189](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L189)* +*Defined in [api/ptz.ts:189](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L189)* ``` Operation to go to a saved preset position for the @@ -1035,16 +1035,16 @@ ___ | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | `Optional` Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ModifyPresetTour -▸ **ModifyPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTour: *[PresetTour](../interfaces/_api_types_.presettour.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ModifyPresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTour: *[PresetTour](../interfaces/_api_types_.presettour.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:327](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L327)* +*Defined in [api/ptz.ts:327](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L327)* Operation to modify a preset tour for the selected media profile. @@ -1055,16 +1055,16 @@ Operation to modify a preset tour for the selected media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTour | [PresetTour](../interfaces/_api_types_.presettour.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` OperatePresetTour -▸ **OperatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Operation: *[PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **OperatePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Operation: *[PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:336](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L336)* +*Defined in [api/ptz.ts:336](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L336)* Operation to perform specific operation on the preset tour in selected media profile. @@ -1076,16 +1076,16 @@ Operation to perform specific operation on the preset tour in selected media pro | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Operation | [PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RelativeMove -▸ **RelativeMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Translation: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RelativeMove**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Translation: *[PTZVector](../interfaces/_api_types_.ptzvector.md)*, Speed?: *[PTZSpeed](../interfaces/_api_types_.ptzspeed.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:233](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L233)* +*Defined in [api/ptz.ts:233](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L233)* 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. @@ -1097,16 +1097,16 @@ Operation for Relative Pan/Tilt and Zoom Move. The operation is supported if the | Translation | [PTZVector](../interfaces/_api_types_.ptzvector.md) | | `Optional` Speed | [PTZSpeed](../interfaces/_api_types_.ptzspeed.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemovePreset -▸ **RemovePreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemovePreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:177](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L177)* +*Defined in [api/ptz.ts:177](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L177)* ``` Operation to remove a PTZ preset for the Node in @@ -1124,16 +1124,16 @@ ___ | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` RemovePresetTour -▸ **RemovePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **RemovePresetTour**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetTourToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:345](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L345)* +*Defined in [api/ptz.ts:345](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L345)* Operation to delete a specific preset tour from the media profile. @@ -1144,16 +1144,16 @@ Operation to delete a specific preset tour from the media profile. | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | PresetTourToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SendAuxiliaryCommand -▸ **SendAuxiliaryCommand**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AuxiliaryData: *[AuxiliaryData]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SendAuxiliaryCommand**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, AuxiliaryData: *[AuxiliaryData]()*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:131](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L131)* +*Defined in [api/ptz.ts:131](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L131)* ``` Operation to send auxiliary commands to the PTZ device @@ -1169,16 +1169,16 @@ ___ | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | AuxiliaryData | [AuxiliaryData]() | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetConfiguration -▸ **SetConfiguration**(PTZConfiguration: *[PTZConfiguration](../interfaces/_api_types_.ptzconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetConfiguration**(PTZConfiguration: *[PTZConfiguration](../interfaces/_api_types_.ptzconfiguration.md)*, ForcePersistence: *`boolean`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:101](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L101)* +*Defined in [api/ptz.ts:101](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L101)* ``` Set/update a existing PTZConfiguration on the device. @@ -1191,16 +1191,16 @@ ___ | PTZConfiguration | [PTZConfiguration](../interfaces/_api_types_.ptzconfiguration.md) | | ForcePersistence | `boolean` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetHomePosition -▸ **SetHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetHomePosition**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:211](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L211)* +*Defined in [api/ptz.ts:211](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L211)* 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. @@ -1210,16 +1210,16 @@ Operation to save current position as the home position. The SetHomePosition com | ------ | ------ | | ProfileToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetPreset -▸ **SetPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetName?: *`undefined` \| `string`*, PresetToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetPreset**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PresetName?: *`undefined` \| `string`*, PresetToken?: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:161](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L161)* +*Defined in [api/ptz.ts:161](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L161)* 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. @@ -1231,16 +1231,16 @@ The SetPreset command saves the current device position parameters so that the d | `Optional` PresetName | `undefined` \| `string` | | `Optional` PresetToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` Stop -▸ **Stop**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PanTilt?: *`undefined` \| `false` \| `true`*, Zoom?: *`undefined` \| `false` \| `true`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **Stop**(ProfileToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, PanTilt?: *`undefined` \| `false` \| `true`*, Zoom?: *`undefined` \| `false` \| `true`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/ptz.ts:282](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/ptz.ts#L282)* +*Defined in [api/ptz.ts:282](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/ptz.ts#L282)* 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. @@ -1252,7 +1252,7 @@ Operation to stop ongoing pan, tilt and zoom movements of absolute relative and | `Optional` PanTilt | `undefined` \| `false` \| `true` | | `Optional` Zoom | `undefined` \| `false` \| `true` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_receiver_.onvifreceiver.md b/docs/classes/_api_receiver_.onvifreceiver.md index 6f09c7a..43aeff3 100644 --- a/docs/classes/_api_receiver_.onvifreceiver.md +++ b/docs/classes/_api_receiver_.onvifreceiver.md @@ -45,7 +45,7 @@ ⊕ **new ONVIFReceiver**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFReceiver](_api_receiver_.onvifreceiver.md) -*Defined in [api/receiver.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L5)* +*Defined in [api/receiver.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L5)* **Parameters:** @@ -65,7 +65,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/receiver.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L6)* +*Defined in [api/receiver.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L6)* ___ @@ -75,9 +75,9 @@ ___ ### ConfigureReceiver -▸ **ConfigureReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ConfigureReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:152](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L152)* +*Defined in [api/receiver.ts:152](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L152)* Configures an existing receiver. This operation is mandatory. @@ -88,16 +88,16 @@ Configures an existing receiver. This operation is mandatory. | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Configuration | [ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateReceiver -▸ **CreateReceiver**(Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateReceiver**(Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:132](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L132)* +*Defined in [api/receiver.ts:132](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L132)* Creates a new receiver. This operation is mandatory, although the service may raise a fault if the receiver cannot be created. @@ -107,16 +107,16 @@ Creates a new receiver. This operation is mandatory, although the service may ra | ------ | ------ | | Configuration | [ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteReceiver -▸ **DeleteReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:143](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L143)* +*Defined in [api/receiver.ts:143](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L143)* Deletes an existing receiver. A receiver may be deleted only if it is not currently in use; otherwise a fault shall be raised. This operation is mandatory. @@ -126,16 +126,16 @@ Deletes an existing receiver. A receiver may be deleted only if it is not curren | ------ | ------ | | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetReceiver -▸ **GetReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:122](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L122)* +*Defined in [api/receiver.ts:122](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L122)* Retrieves the details of a specific receiver. This operation is mandatory. @@ -145,16 +145,16 @@ Retrieves the details of a specific receiver. This operation is mandatory. | ------ | ------ | | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetReceiverState -▸ **GetReceiverState**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetReceiverState**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:173](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L173)* +*Defined in [api/receiver.ts:173](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L173)* Determines whether the receiver is currently disconnected, connected or attempting to connect. This operation is mandatory. @@ -164,42 +164,42 @@ Determines whether the receiver is currently disconnected, connected or attempti | ------ | ------ | | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetReceivers -▸ **GetReceivers**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetReceivers**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:113](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L113)* +*Defined in [api/receiver.ts:113](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L113)* Lists all receivers currently present on a device. This operation is mandatory. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:104](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L104)* +*Defined in [api/receiver.ts:104](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L104)* Returns the capabilities of the receiver service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetReceiverMode -▸ **SetReceiverMode**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Mode: *[ReceiverMode](../enums/_api_types_.receivermode.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetReceiverMode**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Mode: *[ReceiverMode](../enums/_api_types_.receivermode.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/receiver.ts:162](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L162)* +*Defined in [api/receiver.ts:162](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L162)* Sets the mode of the receiver without affecting the rest of its configuration. This operation is mandatory. @@ -210,16 +210,16 @@ Sets the mode of the receiver without affecting the rest of its configuration. T | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Mode | [ReceiverMode](../enums/_api_types_.receivermode.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` ConfigureReceiver -▸ **ConfigureReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ConfigureReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L70)* +*Defined in [api/receiver.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L70)* Configures an existing receiver. This operation is mandatory. @@ -230,16 +230,16 @@ Configures an existing receiver. This operation is mandatory. | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Configuration | [ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateReceiver -▸ **CreateReceiver**(Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateReceiver**(Configuration: *[ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L46)* +*Defined in [api/receiver.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L46)* Creates a new receiver. This operation is mandatory, although the service may raise a fault if the receiver cannot be created. @@ -249,16 +249,16 @@ Creates a new receiver. This operation is mandatory, although the service may ra | ------ | ------ | | Configuration | [ReceiverConfiguration](../interfaces/_api_types_.receiverconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteReceiver -▸ **DeleteReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L59)* +*Defined in [api/receiver.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L59)* Deletes an existing receiver. A receiver may be deleted only if it is not currently in use; otherwise a fault shall be raised. This operation is mandatory. @@ -268,16 +268,16 @@ Deletes an existing receiver. A receiver may be deleted only if it is not curren | ------ | ------ | | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetReceiver -▸ **GetReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetReceiver**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L34)* +*Defined in [api/receiver.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L34)* Retrieves the details of a specific receiver. This operation is mandatory. @@ -287,16 +287,16 @@ Retrieves the details of a specific receiver. This operation is mandatory. | ------ | ------ | | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetReceiverState -▸ **GetReceiverState**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetReceiverState**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:95](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L95)* +*Defined in [api/receiver.ts:95](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L95)* Determines whether the receiver is currently disconnected, connected or attempting to connect. This operation is mandatory. @@ -306,42 +306,42 @@ Determines whether the receiver is currently disconnected, connected or attempti | ------ | ------ | | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetReceivers -▸ **GetReceivers**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetReceivers**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L23)* +*Defined in [api/receiver.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L23)* Lists all receivers currently present on a device. This operation is mandatory. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L12)* +*Defined in [api/receiver.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L12)* Returns the capabilities of the receiver service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetReceiverMode -▸ **SetReceiverMode**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Mode: *[ReceiverMode](../enums/_api_types_.receivermode.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetReceiverMode**(ReceiverToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*, Mode: *[ReceiverMode](../enums/_api_types_.receivermode.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/receiver.ts:82](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/receiver.ts#L82)* +*Defined in [api/receiver.ts:82](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/receiver.ts#L82)* Sets the mode of the receiver without affecting the rest of its configuration. This operation is mandatory. @@ -352,7 +352,7 @@ Sets the mode of the receiver without affecting the rest of its configuration. T | ReceiverToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | | Mode | [ReceiverMode](../enums/_api_types_.receivermode.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_recording_.onvifrecording.md b/docs/classes/_api_recording_.onvifrecording.md index ec20f7f..a4ff267 100644 --- a/docs/classes/_api_recording_.onvifrecording.md +++ b/docs/classes/_api_recording_.onvifrecording.md @@ -71,7 +71,7 @@ ⊕ **new ONVIFRecording**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFRecording](_api_recording_.onvifrecording.md) -*Defined in [api/recording.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L5)* +*Defined in [api/recording.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L5)* **Parameters:** @@ -91,7 +91,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/recording.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L6)* +*Defined in [api/recording.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L6)* ___ @@ -101,9 +101,9 @@ ___ ### CreateRecording -▸ **CreateRecording**(RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateRecording**(RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:272](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L272)* +*Defined in [api/recording.ts:272](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L272)* CreateRecording shall create a new recording. The new recording shall be created with a track for each supported TrackType see Recording Control Spec. This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE. When successfully completed, CreateRecording shall have created three tracks with the following configurations: @@ -123,16 +123,16 @@ All TrackConfigurations shall have the MaximumRetentionTime set to 0 (unlimited) | ------ | ------ | | RecordingConfiguration | [RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateRecordingJob -▸ **CreateRecordingJob**(JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateRecordingJob**(JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:361](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L361)* +*Defined in [api/recording.ts:361](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L361)* CreateRecordingJob shall create a new recording job. The JobConfiguration returned from CreateRecordingJob shall be identical to the JobConfiguration passed into CreateRecordingJob, except for the ReceiverToken and the AutoCreateReceiver. In the returned structure, the ReceiverToken shall be present and valid and the AutoCreateReceiver field shall be omitted. @@ -142,16 +142,16 @@ CreateRecordingJob shall create a new recording job. The JobConfiguration return | ------ | ------ | | JobConfiguration | [RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### CreateTrack -▸ **CreateTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **CreateTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:326](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L326)* +*Defined in [api/recording.ts:326](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L326)* This method shall create a new track within a recording. This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE. A TrackToken in itself does not uniquely identify a specific track. Tracks within different recordings may have the same TrackToken. @@ -162,16 +162,16 @@ This method shall create a new track within a recording. This method is optional | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | TrackConfiguration | [TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteRecording -▸ **DeleteRecording**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteRecording**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:286](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L286)* +*Defined in [api/recording.ts:286](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L286)* DeleteRecording shall delete a recording object. Whenever a recording is deleted, the device shall delete all the tracks that are part of the recording, and it shall delete all the Recording Jobs that record into the recording. For each deleted recording job, the device shall also delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job. This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE. @@ -181,16 +181,16 @@ DeleteRecording shall delete a recording object. Whenever a recording is deleted | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteRecordingJob -▸ **DeleteRecordingJob**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteRecordingJob**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:371](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L371)* +*Defined in [api/recording.ts:371](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L371)* DeleteRecordingJob removes a recording job. It shall also implicitly delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job. @@ -200,16 +200,16 @@ DeleteRecordingJob removes a recording job. It shall also implicitly delete all | ------ | ------ | | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### DeleteTrack -▸ **DeleteTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **DeleteTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:335](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L335)* +*Defined in [api/recording.ts:335](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L335)* DeleteTrack shall remove a track from a recording. All the data in the track shall be deleted. This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE. @@ -220,16 +220,16 @@ DeleteTrack shall remove a track from a recording. All the data in the track sha | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | TrackToken | [TrackReference](../modules/_api_types_.md#trackreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### ExportRecordedData -▸ **ExportRecordedData**(SearchScope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, FileFormat: *`string`*, StorageDestination: *[StorageReferencePath](../interfaces/_api_types_.storagereferencepath.md)*, StartPoint: *`string`*, EndPoint: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **ExportRecordedData**(SearchScope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, FileFormat: *`string`*, StorageDestination: *[StorageReferencePath](../interfaces/_api_types_.storagereferencepath.md)*, StartPoint: *`string`*, EndPoint: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:421](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L421)* +*Defined in [api/recording.ts:421](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L421)* Exports the selected recordings (from existing recorded data) to the given storage target based on the requested file format. @@ -243,16 +243,16 @@ Exports the selected recordings (from existing recorded data) to the given stora | StartPoint | `string` | | EndPoint | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetExportRecordedDataState -▸ **GetExportRecordedDataState**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetExportRecordedDataState**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:439](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L439)* +*Defined in [api/recording.ts:439](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L439)* Retrieves the status of selected ExportRecordedData operation. @@ -262,16 +262,16 @@ Retrieves the status of selected ExportRecordedData operation. | ------ | ------ | | OperationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingConfiguration -▸ **GetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:308](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L308)* +*Defined in [api/recording.ts:308](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L308)* GetRecordingConfiguration shall retrieve the recording configuration for a recording. @@ -281,16 +281,16 @@ GetRecordingConfiguration shall retrieve the recording configuration for a recor | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingJobConfiguration -▸ **GetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:395](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L395)* +*Defined in [api/recording.ts:395](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L395)* GetRecordingJobConfiguration shall return the current configuration for a recording job. @@ -300,16 +300,16 @@ GetRecordingJobConfiguration shall return the current configuration for a record | ------ | ------ | | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingJobState -▸ **GetRecordingJobState**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingJobState**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:412](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L412)* +*Defined in [api/recording.ts:412](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L412)* GetRecordingJobState returns the state of a recording job. It includes an aggregated state, and state for each track of the recording job. @@ -319,29 +319,29 @@ GetRecordingJobState returns the state of a recording job. It includes an aggreg | ------ | ------ | | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingJobs -▸ **GetRecordingJobs**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingJobs**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:378](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L378)* +*Defined in [api/recording.ts:378](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L378)* GetRecordingJobs shall return a list of all the recording jobs in the device. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingOptions -▸ **GetRecordingOptions**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingOptions**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:315](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L315)* +*Defined in [api/recording.ts:315](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L315)* GetRecordingOptions returns information for a recording identified by the RecordingToken. The information includes the number of additonal tracks as well as recording jobs that can be configured. @@ -351,42 +351,42 @@ GetRecordingOptions returns information for a recording identified by the Record | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordings -▸ **GetRecordings**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordings**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:294](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L294)* +*Defined in [api/recording.ts:294](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L294)* GetRecordings shall return a description of all the recordings in the device. This description shall include a list of all the tracks for each recording. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:250](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L250)* +*Defined in [api/recording.ts:250](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L250)* Returns the capabilities of the recording service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetTrackConfiguration -▸ **GetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:342](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L342)* +*Defined in [api/recording.ts:342](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L342)* GetTrackConfiguration shall retrieve the configuration for a specific track. @@ -397,16 +397,16 @@ GetTrackConfiguration shall retrieve the configuration for a specific track. | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | TrackToken | [TrackReference](../modules/_api_types_.md#trackreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRecordingConfiguration -▸ **SetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:301](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L301)* +*Defined in [api/recording.ts:301](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L301)* SetRecordingConfiguration shall change the configuration of a recording. @@ -417,16 +417,16 @@ SetRecordingConfiguration shall change the configuration of a recording. | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | RecordingConfiguration | [RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRecordingJobConfiguration -▸ **SetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:388](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L388)* +*Defined in [api/recording.ts:388](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L388)* SetRecordingJobConfiguration shall change the configuration for a recording job. SetRecordingJobConfiguration shall implicitly delete any receiver objects that were created automatically if they are no longer used as a result of changing the recording job configuration. @@ -437,16 +437,16 @@ SetRecordingJobConfiguration shall change the configuration for a recording job. | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | | JobConfiguration | [RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetRecordingJobMode -▸ **SetRecordingJobMode**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, Mode: *[RecordingJobMode](../modules/_api_types_.md#recordingjobmode)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetRecordingJobMode**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, Mode: *[RecordingJobMode](../modules/_api_types_.md#recordingjobmode)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:404](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L404)* +*Defined in [api/recording.ts:404](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L404)* SetRecordingJobMode shall change the mode of the recording job. Using this method shall be equivalent to retrieving the recording job configuration, and writing it back with a different mode. @@ -457,16 +457,16 @@ SetRecordingJobMode shall change the mode of the recording job. Using this metho | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | | Mode | [RecordingJobMode](../modules/_api_types_.md#recordingjobmode) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetTrackConfiguration -▸ **SetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:349](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L349)* +*Defined in [api/recording.ts:349](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L349)* SetTrackConfiguration shall change the configuration of a track. @@ -478,16 +478,16 @@ SetTrackConfiguration shall change the configuration of a track. | TrackToken | [TrackReference](../modules/_api_types_.md#trackreference) | | TrackConfiguration | [TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### StopExportRecordedData -▸ **StopExportRecordedData**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **StopExportRecordedData**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/recording.ts:430](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L430)* +*Defined in [api/recording.ts:430](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L430)* Stops the selected ExportRecordedData operation. @@ -497,16 +497,16 @@ Stops the selected ExportRecordedData operation. | ------ | ------ | | OperationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` CreateRecording -▸ **CreateRecording**(RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateRecording**(RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:36](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L36)* +*Defined in [api/recording.ts:36](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L36)* CreateRecording shall create a new recording. The new recording shall be created with a track for each supported TrackType see Recording Control Spec. This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE. When successfully completed, CreateRecording shall have created three tracks with the following configurations: @@ -526,16 +526,16 @@ All TrackConfigurations shall have the MaximumRetentionTime set to 0 (unlimited) | ------ | ------ | | RecordingConfiguration | [RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateRecordingJob -▸ **CreateRecordingJob**(JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateRecordingJob**(JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:145](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L145)* +*Defined in [api/recording.ts:145](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L145)* CreateRecordingJob shall create a new recording job. The JobConfiguration returned from CreateRecordingJob shall be identical to the JobConfiguration passed into CreateRecordingJob, except for the ReceiverToken and the AutoCreateReceiver. In the returned structure, the ReceiverToken shall be present and valid and the AutoCreateReceiver field shall be omitted. @@ -545,16 +545,16 @@ CreateRecordingJob shall create a new recording job. The JobConfiguration return | ------ | ------ | | JobConfiguration | [RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` CreateTrack -▸ **CreateTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **CreateTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L102)* +*Defined in [api/recording.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L102)* This method shall create a new track within a recording. This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE. A TrackToken in itself does not uniquely identify a specific track. Tracks within different recordings may have the same TrackToken. @@ -565,16 +565,16 @@ This method shall create a new track within a recording. This method is optional | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | TrackConfiguration | [TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteRecording -▸ **DeleteRecording**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteRecording**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:52](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L52)* +*Defined in [api/recording.ts:52](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L52)* DeleteRecording shall delete a recording object. Whenever a recording is deleted, the device shall delete all the tracks that are part of the recording, and it shall delete all the Recording Jobs that record into the recording. For each deleted recording job, the device shall also delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job. This method is optional. It shall be available if the Recording/DynamicRecordings capability is TRUE. @@ -584,16 +584,16 @@ DeleteRecording shall delete a recording object. Whenever a recording is deleted | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteRecordingJob -▸ **DeleteRecordingJob**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteRecordingJob**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:157](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L157)* +*Defined in [api/recording.ts:157](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L157)* DeleteRecordingJob removes a recording job. It shall also implicitly delete all the receiver objects associated with the recording job that are automatically created using the AutoCreateReceiver field of the recording job configuration structure and are not used in any other recording job. @@ -603,16 +603,16 @@ DeleteRecordingJob removes a recording job. It shall also implicitly delete all | ------ | ------ | | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` DeleteTrack -▸ **DeleteTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **DeleteTrack**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:113](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L113)* +*Defined in [api/recording.ts:113](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L113)* DeleteTrack shall remove a track from a recording. All the data in the track shall be deleted. This method is optional. It shall be available if the Recording/DynamicTracks capability is TRUE. @@ -623,16 +623,16 @@ DeleteTrack shall remove a track from a recording. All the data in the track sha | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | TrackToken | [TrackReference](../modules/_api_types_.md#trackreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` ExportRecordedData -▸ **ExportRecordedData**(SearchScope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, FileFormat: *`string`*, StorageDestination: *[StorageReferencePath](../interfaces/_api_types_.storagereferencepath.md)*, StartPoint?: *`undefined` \| `string`*, EndPoint?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **ExportRecordedData**(SearchScope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, FileFormat: *`string`*, StorageDestination: *[StorageReferencePath](../interfaces/_api_types_.storagereferencepath.md)*, StartPoint?: *`undefined` \| `string`*, EndPoint?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:219](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L219)* +*Defined in [api/recording.ts:219](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L219)* Exports the selected recordings (from existing recorded data) to the given storage target based on the requested file format. @@ -646,16 +646,16 @@ Exports the selected recordings (from existing recorded data) to the given stora | `Optional` StartPoint | `undefined` \| `string` | | `Optional` EndPoint | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetExportRecordedDataState -▸ **GetExportRecordedDataState**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetExportRecordedDataState**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:241](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L241)* +*Defined in [api/recording.ts:241](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L241)* Retrieves the status of selected ExportRecordedData operation. @@ -665,16 +665,16 @@ Retrieves the status of selected ExportRecordedData operation. | ------ | ------ | | OperationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingConfiguration -▸ **GetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:80](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L80)* +*Defined in [api/recording.ts:80](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L80)* GetRecordingConfiguration shall retrieve the recording configuration for a recording. @@ -684,16 +684,16 @@ GetRecordingConfiguration shall retrieve the recording configuration for a recor | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingJobConfiguration -▸ **GetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:187](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L187)* +*Defined in [api/recording.ts:187](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L187)* GetRecordingJobConfiguration shall return the current configuration for a recording job. @@ -703,16 +703,16 @@ GetRecordingJobConfiguration shall return the current configuration for a record | ------ | ------ | | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingJobState -▸ **GetRecordingJobState**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingJobState**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:208](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L208)* +*Defined in [api/recording.ts:208](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L208)* GetRecordingJobState returns the state of a recording job. It includes an aggregated state, and state for each track of the recording job. @@ -722,29 +722,29 @@ GetRecordingJobState returns the state of a recording job. It includes an aggreg | ------ | ------ | | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingJobs -▸ **GetRecordingJobs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingJobs**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:166](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L166)* +*Defined in [api/recording.ts:166](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L166)* GetRecordingJobs shall return a list of all the recording jobs in the device. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingOptions -▸ **GetRecordingOptions**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingOptions**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:89](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L89)* +*Defined in [api/recording.ts:89](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L89)* GetRecordingOptions returns information for a recording identified by the RecordingToken. The information includes the number of additonal tracks as well as recording jobs that can be configured. @@ -754,42 +754,42 @@ GetRecordingOptions returns information for a recording identified by the Record | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordings -▸ **GetRecordings**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordings**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:62](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L62)* +*Defined in [api/recording.ts:62](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L62)* GetRecordings shall return a description of all the recordings in the device. This description shall include a list of all the tracks for each recording. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L12)* +*Defined in [api/recording.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L12)* Returns the capabilities of the recording service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetTrackConfiguration -▸ **GetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:122](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L122)* +*Defined in [api/recording.ts:122](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L122)* GetTrackConfiguration shall retrieve the configuration for a specific track. @@ -800,16 +800,16 @@ GetTrackConfiguration shall retrieve the configuration for a specific track. | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | TrackToken | [TrackReference](../modules/_api_types_.md#trackreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRecordingConfiguration -▸ **SetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRecordingConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, RecordingConfiguration: *[RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L71)* +*Defined in [api/recording.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L71)* SetRecordingConfiguration shall change the configuration of a recording. @@ -820,16 +820,16 @@ SetRecordingConfiguration shall change the configuration of a recording. | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | | RecordingConfiguration | [RecordingConfiguration](../interfaces/_api_types_.recordingconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRecordingJobConfiguration -▸ **SetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRecordingJobConfiguration**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, JobConfiguration: *[RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:178](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L178)* +*Defined in [api/recording.ts:178](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L178)* SetRecordingJobConfiguration shall change the configuration for a recording job. SetRecordingJobConfiguration shall implicitly delete any receiver objects that were created automatically if they are no longer used as a result of changing the recording job configuration. @@ -840,16 +840,16 @@ SetRecordingJobConfiguration shall change the configuration for a recording job. | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | | JobConfiguration | [RecordingJobConfiguration](../interfaces/_api_types_.recordingjobconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetRecordingJobMode -▸ **SetRecordingJobMode**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, Mode: *[RecordingJobMode](../modules/_api_types_.md#recordingjobmode)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetRecordingJobMode**(JobToken: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)*, Mode: *[RecordingJobMode](../modules/_api_types_.md#recordingjobmode)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:198](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L198)* +*Defined in [api/recording.ts:198](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L198)* SetRecordingJobMode shall change the mode of the recording job. Using this method shall be equivalent to retrieving the recording job configuration, and writing it back with a different mode. @@ -860,16 +860,16 @@ SetRecordingJobMode shall change the mode of the recording job. Using this metho | JobToken | [RecordingJobReference](../modules/_api_types_.md#recordingjobreference) | | Mode | [RecordingJobMode](../modules/_api_types_.md#recordingjobmode) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetTrackConfiguration -▸ **SetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetTrackConfiguration**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*, TrackToken: *[TrackReference](../modules/_api_types_.md#trackreference)*, TrackConfiguration: *[TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:131](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L131)* +*Defined in [api/recording.ts:131](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L131)* SetTrackConfiguration shall change the configuration of a track. @@ -881,16 +881,16 @@ SetTrackConfiguration shall change the configuration of a track. | TrackToken | [TrackReference](../modules/_api_types_.md#trackreference) | | TrackConfiguration | [TrackConfiguration](../interfaces/_api_types_.trackconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` StopExportRecordedData -▸ **StopExportRecordedData**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **StopExportRecordedData**(OperationToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/recording.ts:230](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/recording.ts#L230)* +*Defined in [api/recording.ts:230](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/recording.ts#L230)* Stops the selected ExportRecordedData operation. @@ -900,7 +900,7 @@ Stops the selected ExportRecordedData operation. | ------ | ------ | | OperationToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_replay_.onvifreplay.md b/docs/classes/_api_replay_.onvifreplay.md index 1822baf..be5161f 100644 --- a/docs/classes/_api_replay_.onvifreplay.md +++ b/docs/classes/_api_replay_.onvifreplay.md @@ -37,7 +37,7 @@ ⊕ **new ONVIFReplay**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFReplay](_api_replay_.onvifreplay.md) -*Defined in [api/replay.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L5)* +*Defined in [api/replay.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L5)* **Parameters:** @@ -57,7 +57,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/replay.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L6)* +*Defined in [api/replay.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L6)* ___ @@ -67,22 +67,22 @@ ___ ### GetReplayConfiguration -▸ **GetReplayConfiguration**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetReplayConfiguration**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/replay.ts:81](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L81)* +*Defined in [api/replay.ts:81](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L81)* Returns the current configuration of the replay service. This operation is mandatory. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetReplayUri -▸ **GetReplayUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, RecordingToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetReplayUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, RecordingToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/replay.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L71)* +*Defined in [api/replay.ts:71](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L71)* Requests a URI that can be used to initiate playback of a recorded stream using RTSP as the control protocol. The URI is valid only as it is specified in the response. This operation is mandatory. @@ -93,29 +93,29 @@ Requests a URI that can be used to initiate playback of a recorded stream using | StreamSetup | [StreamSetup](../interfaces/_api_types_.streamsetup.md) | | RecordingToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/replay.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L59)* +*Defined in [api/replay.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L59)* Returns the capabilities of the replay service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### SetReplayConfiguration -▸ **SetReplayConfiguration**(Configuration: *[ReplayConfiguration](../interfaces/_api_types_.replayconfiguration.md)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **SetReplayConfiguration**(Configuration: *[ReplayConfiguration](../interfaces/_api_types_.replayconfiguration.md)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/replay.ts:91](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L91)* +*Defined in [api/replay.ts:91](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L91)* Changes the current configuration of the replay service. This operation is mandatory. @@ -125,29 +125,29 @@ Changes the current configuration of the replay service. This operation is manda | ------ | ------ | | Configuration | [ReplayConfiguration](../interfaces/_api_types_.replayconfiguration.md) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` GetReplayConfiguration -▸ **GetReplayConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetReplayConfiguration**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/replay.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L38)* +*Defined in [api/replay.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L38)* Returns the current configuration of the replay service. This operation is mandatory. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetReplayUri -▸ **GetReplayUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, RecordingToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetReplayUri**(StreamSetup: *[StreamSetup](../interfaces/_api_types_.streamsetup.md)*, RecordingToken: *[ReferenceToken](../modules/_api_types_.md#referencetoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/replay.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L26)* +*Defined in [api/replay.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L26)* Requests a URI that can be used to initiate playback of a recorded stream using RTSP as the control protocol. The URI is valid only as it is specified in the response. This operation is mandatory. @@ -158,29 +158,29 @@ Requests a URI that can be used to initiate playback of a recorded stream using | StreamSetup | [StreamSetup](../interfaces/_api_types_.streamsetup.md) | | RecordingToken | [ReferenceToken](../modules/_api_types_.md#referencetoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/replay.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L12)* +*Defined in [api/replay.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L12)* Returns the capabilities of the replay service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` SetReplayConfiguration -▸ **SetReplayConfiguration**(Configuration: *[ReplayConfiguration](../interfaces/_api_types_.replayconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **SetReplayConfiguration**(Configuration: *[ReplayConfiguration](../interfaces/_api_types_.replayconfiguration.md)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/replay.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/replay.ts#L50)* +*Defined in [api/replay.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/replay.ts#L50)* Changes the current configuration of the replay service. This operation is mandatory. @@ -190,7 +190,7 @@ Changes the current configuration of the replay service. This operation is manda | ------ | ------ | | Configuration | [ReplayConfiguration](../interfaces/_api_types_.replayconfiguration.md) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/classes/_api_search_.onvifsearch.md b/docs/classes/_api_search_.onvifsearch.md index ad6a719..344df4f 100644 --- a/docs/classes/_api_search_.onvifsearch.md +++ b/docs/classes/_api_search_.onvifsearch.md @@ -57,7 +57,7 @@ ⊕ **new ONVIFSearch**(config: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)*): [ONVIFSearch](_api_search_.onvifsearch.md) -*Defined in [api/search.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L5)* +*Defined in [api/search.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L5)* **Parameters:** @@ -77,7 +77,7 @@ ___ **● config**: *[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md)* -*Defined in [api/search.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L6)* +*Defined in [api/search.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L6)* ___ @@ -87,9 +87,9 @@ ___ ### EndSearch -▸ **EndSearch**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **EndSearch**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:418](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L418)* +*Defined in [api/search.ts:418](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L418)* EndSearch stops and ongoing search session, causing any blocking result request to return and the SearchToken to become invalid. If the search was interrupted before completion, the point in time that the search had reached shall be returned. If the search had not yet begun, the StartPoint shall be returned. If the search was completed the original EndPoint supplied by the Find operation shall be returned. When issuing EndSearch on a FindRecordings request the EndPoint is undefined and shall not be used since the FindRecordings request doesn't have StartPoint/EndPoint. This operation is mandatory to support for a device implementing the recording search service. @@ -99,16 +99,16 @@ EndSearch stops and ongoing search session, causing any blocking result request | ------ | ------ | | SearchToken | [JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### FindEvents -▸ **FindEvents**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[EventFilter](../interfaces/_api_types_.eventfilter.md)*, IncludeStartState: *`boolean`*, KeepAliveTime: *`string`*, EndPoint: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **FindEvents**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[EventFilter](../interfaces/_api_types_.eventfilter.md)*, IncludeStartState: *`boolean`*, KeepAliveTime: *`string`*, EndPoint: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:339](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L339)* +*Defined in [api/search.ts:339](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L339)* FindEvents starts a search session, looking for recording events (in the scope that matches the search filter defined in the request. Results from the search are acquired using the GetEventSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: @@ -128,16 +128,16 @@ Results shall be ordered by time, ascending in case of forward search, or descen | EndPoint | `string` | | MaxMatches | `number` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### FindMetadata -▸ **FindMetadata**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, MetadataFilter: *[MetadataFilter](../interfaces/_api_types_.metadatafilter.md)*, KeepAliveTime: *`string`*, EndPoint: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **FindMetadata**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, MetadataFilter: *[MetadataFilter](../interfaces/_api_types_.metadatafilter.md)*, KeepAliveTime: *`string`*, EndPoint: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:438](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L438)* +*Defined in [api/search.ts:438](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L438)* FindMetadata starts a search session, looking for metadata in the scope (See 20.2.4) that matches the search filter defined in the request. Results from the search are acquired using the GetMetadataSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: @@ -156,16 +156,16 @@ This operation is mandatory to support if the MetaDataSearch capability is set t | EndPoint | `string` | | MaxMatches | `number` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### FindPTZPosition -▸ **FindPTZPosition**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[PTZPositionFilter](../interfaces/_api_types_.ptzpositionfilter.md)*, KeepAliveTime: *`string`*, EndPoint: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **FindPTZPosition**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[PTZPositionFilter](../interfaces/_api_types_.ptzpositionfilter.md)*, KeepAliveTime: *`string`*, EndPoint: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:377](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L377)* +*Defined in [api/search.ts:377](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L377)* FindPTZPosition starts a search session, looking for ptz positions in the scope (See 20.2.4) that matches the search filter defined in the request. Results from the search are acquired using the GetPTZPositionSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: @@ -184,16 +184,16 @@ This operation is mandatory to support whenever CanContainPTZ is true for any me | EndPoint | `string` | | MaxMatches | `number` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### FindRecordings -▸ **FindRecordings**(Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, KeepAliveTime: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **FindRecordings**(Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, KeepAliveTime: *`string`*, MaxMatches: *`number`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:299](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L299)* +*Defined in [api/search.ts:299](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L299)* FindRecordings starts a search session, looking for recordings that matches the scope (See 20.2.4) defined in the request. Results from the search are acquired using the GetRecordingSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: The entire time range from StartPoint to EndPoint has been searched through. The total number of matches has been found, defined by the MaxMatches parameter. The session has been ended by a client EndSession request. The session has been ended because KeepAliveTime since the last request related to this session has expired. @@ -207,16 +207,16 @@ The order of the results is undefined, to allow the device to return results in | KeepAliveTime | `string` | | MaxMatches | `number` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetEventSearchResults -▸ **GetEventSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetEventSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:357](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L357)* +*Defined in [api/search.ts:357](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L357)* GetEventSearchResults acquires the results from a recording event search session previously initiated by a FindEvents operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetEventSearchResults shall block until: @@ -233,16 +233,16 @@ This operation is mandatory to support for a device implementing the recording s | MaxResults | `number` | | WaitTime | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetMediaAttributes -▸ **GetMediaAttributes**(Time: *`string`*, RecordingTokens: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetMediaAttributes**(Time: *`string`*, RecordingTokens: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:280](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L280)* +*Defined in [api/search.ts:280](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L280)* Returns a set of media attributes for all tracks of the specified recordings at a specified point in time. Clients using this operation shall be able to use it as a non blocking operation. A device shall set the starttime and endtime of the MediaAttributes structure to equal values if calculating this range would causes this operation to block. See MediaAttributes structure for more information. This operation is mandatory to support for a device implementing the recording search service. @@ -253,16 +253,16 @@ Returns a set of media attributes for all tracks of the specified recordings at | Time | `string` | | RecordingTokens | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetMetadataSearchResults -▸ **GetMetadataSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetMetadataSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:457](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L457)* +*Defined in [api/search.ts:457](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L457)* GetMetadataSearchResults acquires the results from a recording search session previously initiated by a FindMetadata operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetMetadataSearchResults shall block until: @@ -279,16 +279,16 @@ This operation is mandatory to support if the MetaDataSearch capability is set t | MaxResults | `number` | | WaitTime | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetPTZPositionSearchResults -▸ **GetPTZPositionSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetPTZPositionSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:396](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L396)* +*Defined in [api/search.ts:396](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L396)* GetPTZPositionSearchResults acquires the results from a ptz position search session previously initiated by a FindPTZPosition operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetPTZPositionSearchResults shall block until: @@ -305,16 +305,16 @@ This operation is mandatory to support whenever CanContainPTZ is true for any me | MaxResults | `number` | | WaitTime | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingInformation -▸ **GetRecordingInformation**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingInformation**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:268](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L268)* +*Defined in [api/search.ts:268](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L268)* Returns information about a single Recording specified by a RecordingToken. This operation is mandatory to support for a device implementing the recording search service. @@ -324,16 +324,16 @@ Returns information about a single Recording specified by a RecordingToken. This | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingSearchResults -▸ **GetRecordingSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults: *`number`*, MaxResults: *`number`*, WaitTime: *`string`*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:318](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L318)* +*Defined in [api/search.ts:318](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L318)* GetRecordingSearchResults acquires the results from a recording search session previously initiated by a FindRecordings operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. The number of results relates to the number of recordings. For viewing individual recorded data for a signal track use the FindEvents method. GetRecordingSearchResults shall block until: @@ -350,29 +350,29 @@ This operation is mandatory to support for a device implementing the recording s | MaxResults | `number` | | WaitTime | `string` | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetRecordingSummary -▸ **GetRecordingSummary**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetRecordingSummary**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:260](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L260)* +*Defined in [api/search.ts:260](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L260)* GetRecordingSummary is used to get a summary description of all recorded data. This operation is mandatory to support for a device implementing the recording search service. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetSearchState -▸ **GetSearchState**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetSearchState**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:403](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L403)* +*Defined in [api/search.ts:403](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L403)* GetSearchState returns the current state of the specified search session. This command is deprecated . @@ -382,29 +382,29 @@ GetSearchState returns the current state of the specified search session. This c | ------ | ------ | | SearchToken | [JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken) | -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### GetServiceCapabilities -▸ **GetServiceCapabilities**(): `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +▸ **GetServiceCapabilities**(): `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> -*Defined in [api/search.ts:252](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L252)* +*Defined in [api/search.ts:252](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L252)* Returns the capabilities of the search service. The result is returned in a typed answer. -**Returns:** `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>> +**Returns:** `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>> ___ ### `` EndSearch -▸ **EndSearch**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **EndSearch**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:200](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L200)* +*Defined in [api/search.ts:200](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L200)* EndSearch stops and ongoing search session, causing any blocking result request to return and the SearchToken to become invalid. If the search was interrupted before completion, the point in time that the search had reached shall be returned. If the search had not yet begun, the StartPoint shall be returned. If the search was completed the original EndPoint supplied by the Find operation shall be returned. When issuing EndSearch on a FindRecordings request the EndPoint is undefined and shall not be used since the FindRecordings request doesn't have StartPoint/EndPoint. This operation is mandatory to support for a device implementing the recording search service. @@ -414,16 +414,16 @@ EndSearch stops and ongoing search session, causing any blocking result request | ------ | ------ | | SearchToken | [JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` FindEvents -▸ **FindEvents**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[EventFilter](../interfaces/_api_types_.eventfilter.md)*, IncludeStartState: *`boolean`*, KeepAliveTime: *`string`*, EndPoint?: *`undefined` \| `string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **FindEvents**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[EventFilter](../interfaces/_api_types_.eventfilter.md)*, IncludeStartState: *`boolean`*, KeepAliveTime: *`string`*, EndPoint?: *`undefined` \| `string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:111](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L111)* +*Defined in [api/search.ts:111](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L111)* FindEvents starts a search session, looking for recording events (in the scope that matches the search filter defined in the request. Results from the search are acquired using the GetEventSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: @@ -443,16 +443,16 @@ Results shall be ordered by time, ascending in case of forward search, or descen | `Optional` EndPoint | `undefined` \| `string` | | `Optional` MaxMatches | `undefined` \| `number` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` FindMetadata -▸ **FindMetadata**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, MetadataFilter: *[MetadataFilter](../interfaces/_api_types_.metadatafilter.md)*, KeepAliveTime: *`string`*, EndPoint?: *`undefined` \| `string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **FindMetadata**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, MetadataFilter: *[MetadataFilter](../interfaces/_api_types_.metadatafilter.md)*, KeepAliveTime: *`string`*, EndPoint?: *`undefined` \| `string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:222](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L222)* +*Defined in [api/search.ts:222](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L222)* FindMetadata starts a search session, looking for metadata in the scope (See 20.2.4) that matches the search filter defined in the request. Results from the search are acquired using the GetMetadataSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: @@ -471,16 +471,16 @@ This operation is mandatory to support if the MetaDataSearch capability is set t | `Optional` EndPoint | `undefined` \| `string` | | `Optional` MaxMatches | `undefined` \| `number` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` FindPTZPosition -▸ **FindPTZPosition**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[PTZPositionFilter](../interfaces/_api_types_.ptzpositionfilter.md)*, KeepAliveTime: *`string`*, EndPoint?: *`undefined` \| `string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **FindPTZPosition**(StartPoint: *`string`*, Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, SearchFilter: *[PTZPositionFilter](../interfaces/_api_types_.ptzpositionfilter.md)*, KeepAliveTime: *`string`*, EndPoint?: *`undefined` \| `string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:153](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L153)* +*Defined in [api/search.ts:153](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L153)* FindPTZPosition starts a search session, looking for ptz positions in the scope (See 20.2.4) that matches the search filter defined in the request. Results from the search are acquired using the GetPTZPositionSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: @@ -499,16 +499,16 @@ This operation is mandatory to support whenever CanContainPTZ is true for any me | `Optional` EndPoint | `undefined` \| `string` | | `Optional` MaxMatches | `undefined` \| `number` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` FindRecordings -▸ **FindRecordings**(Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, KeepAliveTime: *`string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **FindRecordings**(Scope: *[SearchScope](../interfaces/_api_types_.searchscope.md)*, KeepAliveTime: *`string`*, MaxMatches?: *`undefined` \| `number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:67](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L67)* +*Defined in [api/search.ts:67](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L67)* FindRecordings starts a search session, looking for recordings that matches the scope (See 20.2.4) defined in the request. Results from the search are acquired using the GetRecordingSearchResults request, specifying the search token returned from this request. The device shall continue searching until one of the following occurs: The entire time range from StartPoint to EndPoint has been searched through. The total number of matches has been found, defined by the MaxMatches parameter. The session has been ended by a client EndSession request. The session has been ended because KeepAliveTime since the last request related to this session has expired. @@ -522,16 +522,16 @@ The order of the results is undefined, to allow the device to return results in | KeepAliveTime | `string` | | `Optional` MaxMatches | `undefined` \| `number` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetEventSearchResults -▸ **GetEventSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetEventSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:131](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L131)* +*Defined in [api/search.ts:131](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L131)* GetEventSearchResults acquires the results from a recording event search session previously initiated by a FindEvents operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetEventSearchResults shall block until: @@ -548,16 +548,16 @@ This operation is mandatory to support for a device implementing the recording s | `Optional` MaxResults | `undefined` \| `number` | | `Optional` WaitTime | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetMediaAttributes -▸ **GetMediaAttributes**(Time: *`string`*, RecordingTokens?: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetMediaAttributes**(Time: *`string`*, RecordingTokens?: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L46)* +*Defined in [api/search.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L46)* Returns a set of media attributes for all tracks of the specified recordings at a specified point in time. Clients using this operation shall be able to use it as a non blocking operation. A device shall set the starttime and endtime of the MediaAttributes structure to equal values if calculating this range would causes this operation to block. See MediaAttributes structure for more information. This operation is mandatory to support for a device implementing the recording search service. @@ -568,16 +568,16 @@ Returns a set of media attributes for all tracks of the specified recordings at | Time | `string` | | `Optional` RecordingTokens | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetMetadataSearchResults -▸ **GetMetadataSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetMetadataSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:243](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L243)* +*Defined in [api/search.ts:243](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L243)* GetMetadataSearchResults acquires the results from a recording search session previously initiated by a FindMetadata operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetMetadataSearchResults shall block until: @@ -594,16 +594,16 @@ This operation is mandatory to support if the MetaDataSearch capability is set t | `Optional` MaxResults | `undefined` \| `number` | | `Optional` WaitTime | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetPTZPositionSearchResults -▸ **GetPTZPositionSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetPTZPositionSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:174](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L174)* +*Defined in [api/search.ts:174](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L174)* GetPTZPositionSearchResults acquires the results from a ptz position search session previously initiated by a FindPTZPosition operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. GetPTZPositionSearchResults shall block until: @@ -620,16 +620,16 @@ This operation is mandatory to support whenever CanContainPTZ is true for any me | `Optional` MaxResults | `undefined` \| `number` | | `Optional` WaitTime | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingInformation -▸ **GetRecordingInformation**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingInformation**(RecordingToken: *[RecordingReference](../modules/_api_types_.md#recordingreference)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:32](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L32)* +*Defined in [api/search.ts:32](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L32)* Returns information about a single Recording specified by a RecordingToken. This operation is mandatory to support for a device implementing the recording search service. @@ -639,16 +639,16 @@ Returns information about a single Recording specified by a RecordingToken. This | ------ | ------ | | RecordingToken | [RecordingReference](../modules/_api_types_.md#recordingreference) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingSearchResults -▸ **GetRecordingSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingSearchResults**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*, MinResults?: *`undefined` \| `number`*, MaxResults?: *`undefined` \| `number`*, WaitTime?: *`undefined` \| `string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:88](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L88)* +*Defined in [api/search.ts:88](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L88)* GetRecordingSearchResults acquires the results from a recording search session previously initiated by a FindRecordings operation. The response shall not include results already returned in previous requests for the same session. If MaxResults is specified, the response shall not contain more than MaxResults results. The number of results relates to the number of recordings. For viewing individual recorded data for a signal track use the FindEvents method. GetRecordingSearchResults shall block until: @@ -665,29 +665,29 @@ This operation is mandatory to support for a device implementing the recording s | `Optional` MaxResults | `undefined` \| `number` | | `Optional` WaitTime | `undefined` \| `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetRecordingSummary -▸ **GetRecordingSummary**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetRecordingSummary**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L22)* +*Defined in [api/search.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L22)* GetRecordingSummary is used to get a summary description of all recorded data. This operation is mandatory to support for a device implementing the recording search service. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetSearchState -▸ **GetSearchState**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetSearchState**(SearchToken: *[JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken)*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:183](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L183)* +*Defined in [api/search.ts:183](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L183)* GetSearchState returns the current state of the specified search session. This command is deprecated . @@ -697,20 +697,20 @@ GetSearchState returns the current state of the specified search session. This c | ------ | ------ | | SearchToken | [JobToken](../interfaces/_api_types_.getrecordingjobsresponseitem.md#jobtoken) | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` GetServiceCapabilities -▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **GetServiceCapabilities**(): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [api/search.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/search.ts#L12)* +*Defined in [api/search.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/search.ts#L12)* Returns the capabilities of the search service. The result is returned in a typed answer. -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`any`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IResultStructure](../interfaces/_soap_request_.iresultstructure.md)<`any`>, [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ diff --git a/docs/enums/_api_types_.audioencoding.md b/docs/enums/_api_types_.audioencoding.md index fb08695..3775301 100644 --- a/docs/enums/_api_types_.audioencoding.md +++ b/docs/enums/_api_types_.audioencoding.md @@ -20,7 +20,7 @@ **AAC**: = "AAC" -*Defined in [api/types.ts:4469](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4469)* +*Defined in [api/types.ts:4469](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4469)* ___ @@ -29,7 +29,7 @@ ___ **G711**: = "G711" -*Defined in [api/types.ts:4461](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4461)* +*Defined in [api/types.ts:4461](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4461)* ___ @@ -38,7 +38,7 @@ ___ **G726**: = "G726" -*Defined in [api/types.ts:4465](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4465)* +*Defined in [api/types.ts:4465](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4465)* ___ diff --git a/docs/enums/_api_types_.audioencodingmimenames.md b/docs/enums/_api_types_.audioencodingmimenames.md index be1d1d5..93f6581 100644 --- a/docs/enums/_api_types_.audioencodingmimenames.md +++ b/docs/enums/_api_types_.audioencodingmimenames.md @@ -22,7 +22,7 @@ Audio Media Subtypes as referenced by IANA (without the leading "audio/" Audio M **G726**: = "G726" -*Defined in [api/types.ts:4483](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4483)* +*Defined in [api/types.ts:4483](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4483)* ___ @@ -31,7 +31,7 @@ ___ **MP4A-LATM**: = "MP4A-LATM" -*Defined in [api/types.ts:4487](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4487)* +*Defined in [api/types.ts:4487](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4487)* ___ @@ -40,7 +40,7 @@ ___ **PCMU**: = "PCMU" -*Defined in [api/types.ts:4479](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4479)* +*Defined in [api/types.ts:4479](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4479)* ___ diff --git a/docs/enums/_api_types_.autofocusmode.md b/docs/enums/_api_types_.autofocusmode.md index d33aea2..612ee50 100644 --- a/docs/enums/_api_types_.autofocusmode.md +++ b/docs/enums/_api_types_.autofocusmode.md @@ -19,7 +19,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5075](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5075)* +*Defined in [api/types.ts:5075](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5075)* ___ @@ -28,7 +28,7 @@ ___ **MANUAL**: = "MANUAL" -*Defined in [api/types.ts:5079](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5079)* +*Defined in [api/types.ts:5079](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5079)* ___ diff --git a/docs/enums/_api_types_.backlightcompensationmode.md b/docs/enums/_api_types_.backlightcompensationmode.md index 09bebc0..84feb14 100644 --- a/docs/enums/_api_types_.backlightcompensationmode.md +++ b/docs/enums/_api_types_.backlightcompensationmode.md @@ -21,7 +21,7 @@ Enumeration describing the available backlight compenstation modes. **OFF**: = "OFF" -*Defined in [api/types.ts:5103](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5103)* +*Defined in [api/types.ts:5103](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5103)* Backlight compensation is disabled. @@ -32,7 +32,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:5107](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5107)* +*Defined in [api/types.ts:5107](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5107)* Backlight compensation is enabled. diff --git a/docs/enums/_api_types_.capabilitycategory.md b/docs/enums/_api_types_.capabilitycategory.md index 358b2f5..f67cdec 100644 --- a/docs/enums/_api_types_.capabilitycategory.md +++ b/docs/enums/_api_types_.capabilitycategory.md @@ -24,7 +24,7 @@ **All**: = "All" -*Defined in [api/types.ts:4815](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4815)* +*Defined in [api/types.ts:4815](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4815)* ___ @@ -33,7 +33,7 @@ ___ **Analytics**: = "Analytics" -*Defined in [api/types.ts:4819](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4819)* +*Defined in [api/types.ts:4819](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4819)* ___ @@ -42,7 +42,7 @@ ___ **Device**: = "Device" -*Defined in [api/types.ts:4823](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4823)* +*Defined in [api/types.ts:4823](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4823)* ___ @@ -51,7 +51,7 @@ ___ **Events**: = "Events" -*Defined in [api/types.ts:4827](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4827)* +*Defined in [api/types.ts:4827](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4827)* ___ @@ -60,7 +60,7 @@ ___ **Imaging**: = "Imaging" -*Defined in [api/types.ts:4831](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4831)* +*Defined in [api/types.ts:4831](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4831)* ___ @@ -69,7 +69,7 @@ ___ **Media**: = "Media" -*Defined in [api/types.ts:4835](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4835)* +*Defined in [api/types.ts:4835](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4835)* ___ @@ -78,7 +78,7 @@ ___ **PTZ**: = "PTZ" -*Defined in [api/types.ts:4839](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4839)* +*Defined in [api/types.ts:4839](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4839)* ___ diff --git a/docs/enums/_api_types_.defoggingmode.md b/docs/enums/_api_types_.defoggingmode.md index e22f915..6d84be1 100644 --- a/docs/enums/_api_types_.defoggingmode.md +++ b/docs/enums/_api_types_.defoggingmode.md @@ -20,7 +20,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5261](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5261)* +*Defined in [api/types.ts:5261](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5261)* ___ @@ -29,7 +29,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:5253](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5253)* +*Defined in [api/types.ts:5253](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5253)* ___ @@ -38,7 +38,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:5257](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5257)* +*Defined in [api/types.ts:5257](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5257)* ___ diff --git a/docs/enums/_api_types_.digitalidlestate.md b/docs/enums/_api_types_.digitalidlestate.md index c34bf8b..274f160 100644 --- a/docs/enums/_api_types_.digitalidlestate.md +++ b/docs/enums/_api_types_.digitalidlestate.md @@ -19,7 +19,7 @@ **closed**: = "closed" -*Defined in [api/types.ts:4959](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4959)* +*Defined in [api/types.ts:4959](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4959)* ___ @@ -28,7 +28,7 @@ ___ **open**: = "open" -*Defined in [api/types.ts:4963](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4963)* +*Defined in [api/types.ts:4963](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4963)* ___ diff --git a/docs/enums/_api_types_.direction.md b/docs/enums/_api_types_.direction.md index 50ce9aa..612ce98 100644 --- a/docs/enums/_api_types_.direction.md +++ b/docs/enums/_api_types_.direction.md @@ -20,7 +20,7 @@ **Any**: = "Any" -*Defined in [api/types.ts:5297](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5297)* +*Defined in [api/types.ts:5297](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5297)* ___ @@ -29,7 +29,7 @@ ___ **Left**: = "Left" -*Defined in [api/types.ts:5289](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5289)* +*Defined in [api/types.ts:5289](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5289)* ___ @@ -38,7 +38,7 @@ ___ **Right**: = "Right" -*Defined in [api/types.ts:5293](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5293)* +*Defined in [api/types.ts:5293](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5293)* ___ diff --git a/docs/enums/_api_types_.discoverymode.md b/docs/enums/_api_types_.discoverymode.md index d10d1c3..8b028ff 100644 --- a/docs/enums/_api_types_.discoverymode.md +++ b/docs/enums/_api_types_.discoverymode.md @@ -19,7 +19,7 @@ **Discoverable**: = "Discoverable" -*Defined in [api/types.ts:4565](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4565)* +*Defined in [api/types.ts:4565](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4565)* ___ @@ -28,7 +28,7 @@ ___ **NonDiscoverable**: = "NonDiscoverable" -*Defined in [api/types.ts:4569](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4569)* +*Defined in [api/types.ts:4569](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4569)* ___ diff --git a/docs/enums/_api_types_.dot11authandmangementsuite.md b/docs/enums/_api_types_.dot11authandmangementsuite.md index 9439479..83645d6 100644 --- a/docs/enums/_api_types_.dot11authandmangementsuite.md +++ b/docs/enums/_api_types_.dot11authandmangementsuite.md @@ -21,7 +21,7 @@ **Dot1X**: = "Dot1X" -*Defined in [api/types.ts:4797](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4797)* +*Defined in [api/types.ts:4797](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4797)* ___ @@ -30,7 +30,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4805](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4805)* +*Defined in [api/types.ts:4805](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4805)* ___ @@ -39,7 +39,7 @@ ___ **None**: = "None" -*Defined in [api/types.ts:4793](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4793)* +*Defined in [api/types.ts:4793](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4793)* ___ @@ -48,7 +48,7 @@ ___ **PSK**: = "PSK" -*Defined in [api/types.ts:4801](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4801)* +*Defined in [api/types.ts:4801](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4801)* ___ diff --git a/docs/enums/_api_types_.dot11cipher.md b/docs/enums/_api_types_.dot11cipher.md index 32f2573..44ff4c1 100644 --- a/docs/enums/_api_types_.dot11cipher.md +++ b/docs/enums/_api_types_.dot11cipher.md @@ -21,7 +21,7 @@ **Any**: = "Any" -*Defined in [api/types.ts:4749](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4749)* +*Defined in [api/types.ts:4749](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4749)* ___ @@ -30,7 +30,7 @@ ___ **CCMP**: = "CCMP" -*Defined in [api/types.ts:4741](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4741)* +*Defined in [api/types.ts:4741](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4741)* ___ @@ -39,7 +39,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4753](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4753)* +*Defined in [api/types.ts:4753](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4753)* ___ @@ -48,7 +48,7 @@ ___ **TKIP**: = "TKIP" -*Defined in [api/types.ts:4745](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4745)* +*Defined in [api/types.ts:4745](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4745)* ___ diff --git a/docs/enums/_api_types_.dot11securitymode.md b/docs/enums/_api_types_.dot11securitymode.md index 24ba432..ed9d328 100644 --- a/docs/enums/_api_types_.dot11securitymode.md +++ b/docs/enums/_api_types_.dot11securitymode.md @@ -22,7 +22,7 @@ **Dot1X**: = "Dot1X" -*Defined in [api/types.ts:4727](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4727)* +*Defined in [api/types.ts:4727](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4727)* ___ @@ -31,7 +31,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4731](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4731)* +*Defined in [api/types.ts:4731](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4731)* ___ @@ -40,7 +40,7 @@ ___ **None**: = "None" -*Defined in [api/types.ts:4715](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4715)* +*Defined in [api/types.ts:4715](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4715)* ___ @@ -49,7 +49,7 @@ ___ **PSK**: = "PSK" -*Defined in [api/types.ts:4723](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4723)* +*Defined in [api/types.ts:4723](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4723)* ___ @@ -58,7 +58,7 @@ ___ **WEP**: = "WEP" -*Defined in [api/types.ts:4719](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4719)* +*Defined in [api/types.ts:4719](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4719)* ___ diff --git a/docs/enums/_api_types_.dot11signalstrength.md b/docs/enums/_api_types_.dot11signalstrength.md index 371b653..2f83817 100644 --- a/docs/enums/_api_types_.dot11signalstrength.md +++ b/docs/enums/_api_types_.dot11signalstrength.md @@ -23,7 +23,7 @@ **Bad**: = "Bad" -*Defined in [api/types.ts:4771](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4771)* +*Defined in [api/types.ts:4771](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4771)* ___ @@ -32,7 +32,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4783](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4783)* +*Defined in [api/types.ts:4783](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4783)* ___ @@ -41,7 +41,7 @@ ___ **Good**: = "Good" -*Defined in [api/types.ts:4775](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4775)* +*Defined in [api/types.ts:4775](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4775)* ___ @@ -50,7 +50,7 @@ ___ **None**: = "None" -*Defined in [api/types.ts:4763](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4763)* +*Defined in [api/types.ts:4763](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4763)* ___ @@ -59,7 +59,7 @@ ___ **Very Bad**: = "Very Bad" -*Defined in [api/types.ts:4767](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4767)* +*Defined in [api/types.ts:4767](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4767)* ___ @@ -68,7 +68,7 @@ ___ **Very Good**: = "Very Good" -*Defined in [api/types.ts:4779](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4779)* +*Defined in [api/types.ts:4779](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4779)* ___ diff --git a/docs/enums/_api_types_.dot11stationmode.md b/docs/enums/_api_types_.dot11stationmode.md index 8d153d0..8cb5de9 100644 --- a/docs/enums/_api_types_.dot11stationmode.md +++ b/docs/enums/_api_types_.dot11stationmode.md @@ -20,7 +20,7 @@ **Ad-hoc**: = "Ad-hoc" -*Defined in [api/types.ts:4697](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4697)* +*Defined in [api/types.ts:4697](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4697)* ___ @@ -29,7 +29,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4705](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4705)* +*Defined in [api/types.ts:4705](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4705)* ___ @@ -38,7 +38,7 @@ ___ **Infrastructure**: = "Infrastructure" -*Defined in [api/types.ts:4701](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4701)* +*Defined in [api/types.ts:4701](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4701)* ___ diff --git a/docs/enums/_api_types_.duplex.md b/docs/enums/_api_types_.duplex.md index 9f508ce..d070e98 100644 --- a/docs/enums/_api_types_.duplex.md +++ b/docs/enums/_api_types_.duplex.md @@ -19,7 +19,7 @@ **Full**: = "Full" -*Defined in [api/types.ts:4579](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4579)* +*Defined in [api/types.ts:4579](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4579)* ___ @@ -28,7 +28,7 @@ ___ **Half**: = "Half" -*Defined in [api/types.ts:4583](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4583)* +*Defined in [api/types.ts:4583](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4583)* ___ diff --git a/docs/enums/_api_types_.dynamicdnstype.md b/docs/enums/_api_types_.dynamicdnstype.md index 9d8c8da..66797c2 100644 --- a/docs/enums/_api_types_.dynamicdnstype.md +++ b/docs/enums/_api_types_.dynamicdnstype.md @@ -20,7 +20,7 @@ **ClientUpdates**: = "ClientUpdates" -*Defined in [api/types.ts:4683](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4683)* +*Defined in [api/types.ts:4683](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4683)* ___ @@ -29,7 +29,7 @@ ___ **NoUpdate**: = "NoUpdate" -*Defined in [api/types.ts:4679](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4679)* +*Defined in [api/types.ts:4679](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4679)* ___ @@ -38,7 +38,7 @@ ___ **ServerUpdates**: = "ServerUpdates" -*Defined in [api/types.ts:4687](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4687)* +*Defined in [api/types.ts:4687](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4687)* ___ diff --git a/docs/enums/_api_types_.eflipmode.md b/docs/enums/_api_types_.eflipmode.md index c124c6c..5550b1c 100644 --- a/docs/enums/_api_types_.eflipmode.md +++ b/docs/enums/_api_types_.eflipmode.md @@ -20,7 +20,7 @@ **Extended**: = "Extended" -*Defined in [api/types.ts:4981](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4981)* +*Defined in [api/types.ts:4981](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4981)* ___ @@ -29,7 +29,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:4973](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4973)* +*Defined in [api/types.ts:4973](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4973)* ___ @@ -38,7 +38,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:4977](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4977)* +*Defined in [api/types.ts:4977](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4977)* ___ diff --git a/docs/enums/_api_types_.enabled.md b/docs/enums/_api_types_.enabled.md index 829c993..ebfaa54 100644 --- a/docs/enums/_api_types_.enabled.md +++ b/docs/enums/_api_types_.enabled.md @@ -19,7 +19,7 @@ **DISABLED**: = "DISABLED" -*Defined in [api/types.ts:5149](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5149)* +*Defined in [api/types.ts:5149](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5149)* ___ @@ -28,7 +28,7 @@ ___ **ENABLED**: = "ENABLED" -*Defined in [api/types.ts:5145](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5145)* +*Defined in [api/types.ts:5145](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5145)* ___ diff --git a/docs/enums/_api_types_.entity.md b/docs/enums/_api_types_.entity.md index e4e36fe..e57b567 100644 --- a/docs/enums/_api_types_.entity.md +++ b/docs/enums/_api_types_.entity.md @@ -20,7 +20,7 @@ **AudioSource**: = "AudioSource" -*Defined in [api/types.ts:4251](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4251)* +*Defined in [api/types.ts:4251](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4251)* ___ @@ -29,7 +29,7 @@ ___ **Device**: = "Device" -*Defined in [api/types.ts:4243](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4243)* +*Defined in [api/types.ts:4243](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4243)* ___ @@ -38,7 +38,7 @@ ___ **VideoSource**: = "VideoSource" -*Defined in [api/types.ts:4247](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4247)* +*Defined in [api/types.ts:4247](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4247)* ___ diff --git a/docs/enums/_api_types_.exposuremode.md b/docs/enums/_api_types_.exposuremode.md index 552401a..6d458ef 100644 --- a/docs/enums/_api_types_.exposuremode.md +++ b/docs/enums/_api_types_.exposuremode.md @@ -19,7 +19,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5131](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5131)* +*Defined in [api/types.ts:5131](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5131)* ___ @@ -28,7 +28,7 @@ ___ **MANUAL**: = "MANUAL" -*Defined in [api/types.ts:5135](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5135)* +*Defined in [api/types.ts:5135](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5135)* ___ diff --git a/docs/enums/_api_types_.exposurepriority.md b/docs/enums/_api_types_.exposurepriority.md index 633910e..dee50ee 100644 --- a/docs/enums/_api_types_.exposurepriority.md +++ b/docs/enums/_api_types_.exposurepriority.md @@ -19,7 +19,7 @@ **FrameRate**: = "FrameRate" -*Defined in [api/types.ts:5121](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5121)* +*Defined in [api/types.ts:5121](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5121)* ___ @@ -28,7 +28,7 @@ ___ **LowNoise**: = "LowNoise" -*Defined in [api/types.ts:5117](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5117)* +*Defined in [api/types.ts:5117](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5117)* ___ diff --git a/docs/enums/_api_types_.factorydefaulttype.md b/docs/enums/_api_types_.factorydefaulttype.md index ca8fb73..c211caa 100644 --- a/docs/enums/_api_types_.factorydefaulttype.md +++ b/docs/enums/_api_types_.factorydefaulttype.md @@ -21,7 +21,7 @@ Enumeration describing the available factory default modes. **Hard**: = "Hard" -*Defined in [api/types.ts:4863](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4863)* +*Defined in [api/types.ts:4863](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4863)* Indicates that a hard factory default is requested. @@ -32,7 +32,7 @@ ___ **Soft**: = "Soft" -*Defined in [api/types.ts:4867](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4867)* +*Defined in [api/types.ts:4867](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4867)* Indicates that a soft factory default is requested. diff --git a/docs/enums/_api_types_.h264profile.md b/docs/enums/_api_types_.h264profile.md index b12c249..ab72257 100644 --- a/docs/enums/_api_types_.h264profile.md +++ b/docs/enums/_api_types_.h264profile.md @@ -21,7 +21,7 @@ **Baseline**: = "Baseline" -*Defined in [api/types.ts:4383](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4383)* +*Defined in [api/types.ts:4383](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4383)* ___ @@ -30,7 +30,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4391](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4391)* +*Defined in [api/types.ts:4391](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4391)* ___ @@ -39,7 +39,7 @@ ___ **High**: = "High" -*Defined in [api/types.ts:4395](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4395)* +*Defined in [api/types.ts:4395](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4395)* ___ @@ -48,7 +48,7 @@ ___ **Main**: = "Main" -*Defined in [api/types.ts:4387](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4387)* +*Defined in [api/types.ts:4387](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4387)* ___ diff --git a/docs/enums/_api_types_.imagestabilizationmode.md b/docs/enums/_api_types_.imagestabilizationmode.md index 3561a39..35151a4 100644 --- a/docs/enums/_api_types_.imagestabilizationmode.md +++ b/docs/enums/_api_types_.imagestabilizationmode.md @@ -21,7 +21,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5199](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5199)* +*Defined in [api/types.ts:5199](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5199)* ___ @@ -30,7 +30,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:5203](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5203)* +*Defined in [api/types.ts:5203](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5203)* ___ @@ -39,7 +39,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:5191](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5191)* +*Defined in [api/types.ts:5191](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5191)* ___ @@ -48,7 +48,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:5195](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5195)* +*Defined in [api/types.ts:5195](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5195)* ___ diff --git a/docs/enums/_api_types_.ipaddressfiltertype.md b/docs/enums/_api_types_.ipaddressfiltertype.md index 8c87f78..71b678c 100644 --- a/docs/enums/_api_types_.ipaddressfiltertype.md +++ b/docs/enums/_api_types_.ipaddressfiltertype.md @@ -19,7 +19,7 @@ **Allow**: = "Allow" -*Defined in [api/types.ts:4665](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4665)* +*Defined in [api/types.ts:4665](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4665)* ___ @@ -28,7 +28,7 @@ ___ **Deny**: = "Deny" -*Defined in [api/types.ts:4669](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4669)* +*Defined in [api/types.ts:4669](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4669)* ___ diff --git a/docs/enums/_api_types_.iptype.md b/docs/enums/_api_types_.iptype.md index 2b321ae..e945008 100644 --- a/docs/enums/_api_types_.iptype.md +++ b/docs/enums/_api_types_.iptype.md @@ -19,7 +19,7 @@ **IPv4**: = "IPv4" -*Defined in [api/types.ts:4651](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4651)* +*Defined in [api/types.ts:4651](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4651)* ___ @@ -28,7 +28,7 @@ ___ **IPv6**: = "IPv6" -*Defined in [api/types.ts:4655](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4655)* +*Defined in [api/types.ts:4655](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4655)* ___ diff --git a/docs/enums/_api_types_.ipv6dhcpconfiguration.md b/docs/enums/_api_types_.ipv6dhcpconfiguration.md index b126612..e65805f 100644 --- a/docs/enums/_api_types_.ipv6dhcpconfiguration.md +++ b/docs/enums/_api_types_.ipv6dhcpconfiguration.md @@ -21,7 +21,7 @@ **Auto**: = "Auto" -*Defined in [api/types.ts:4593](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4593)* +*Defined in [api/types.ts:4593](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4593)* ___ @@ -30,7 +30,7 @@ ___ **Off**: = "Off" -*Defined in [api/types.ts:4605](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4605)* +*Defined in [api/types.ts:4605](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4605)* ___ @@ -39,7 +39,7 @@ ___ **Stateful**: = "Stateful" -*Defined in [api/types.ts:4597](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4597)* +*Defined in [api/types.ts:4597](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4597)* ___ @@ -48,7 +48,7 @@ ___ **Stateless**: = "Stateless" -*Defined in [api/types.ts:4601](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4601)* +*Defined in [api/types.ts:4601](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4601)* ___ diff --git a/docs/enums/_api_types_.ircutfilterautoboundarytype.md b/docs/enums/_api_types_.ircutfilterautoboundarytype.md index d008022..4df16dc 100644 --- a/docs/enums/_api_types_.ircutfilterautoboundarytype.md +++ b/docs/enums/_api_types_.ircutfilterautoboundarytype.md @@ -21,7 +21,7 @@ **Common**: = "Common" -*Defined in [api/types.ts:5213](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5213)* +*Defined in [api/types.ts:5213](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5213)* ___ @@ -30,7 +30,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:5225](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5225)* +*Defined in [api/types.ts:5225](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5225)* ___ @@ -39,7 +39,7 @@ ___ **ToOff**: = "ToOff" -*Defined in [api/types.ts:5221](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5221)* +*Defined in [api/types.ts:5221](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5221)* ___ @@ -48,7 +48,7 @@ ___ **ToOn**: = "ToOn" -*Defined in [api/types.ts:5217](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5217)* +*Defined in [api/types.ts:5217](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5217)* ___ diff --git a/docs/enums/_api_types_.ircutfiltermode.md b/docs/enums/_api_types_.ircutfiltermode.md index 2e612cc..061b1f7 100644 --- a/docs/enums/_api_types_.ircutfiltermode.md +++ b/docs/enums/_api_types_.ircutfiltermode.md @@ -20,7 +20,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5181](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5181)* +*Defined in [api/types.ts:5181](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5181)* ___ @@ -29,7 +29,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:5177](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5177)* +*Defined in [api/types.ts:5177](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5177)* ___ @@ -38,7 +38,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:5173](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5173)* +*Defined in [api/types.ts:5173](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5173)* ___ diff --git a/docs/enums/_api_types_.metadatacompressiontype.md b/docs/enums/_api_types_.metadatacompressiontype.md index 0d4b1cf..2c753ff 100644 --- a/docs/enums/_api_types_.metadatacompressiontype.md +++ b/docs/enums/_api_types_.metadatacompressiontype.md @@ -20,7 +20,7 @@ **EXI**: = "EXI" -*Defined in [api/types.ts:4505](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4505)* +*Defined in [api/types.ts:4505](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4505)* ___ @@ -29,7 +29,7 @@ ___ **GZIP**: = "GZIP" -*Defined in [api/types.ts:4501](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4501)* +*Defined in [api/types.ts:4501](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4501)* ___ @@ -38,7 +38,7 @@ ___ **None**: = "None" -*Defined in [api/types.ts:4497](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4497)* +*Defined in [api/types.ts:4497](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4497)* ___ diff --git a/docs/enums/_api_types_.modeofoperation.md b/docs/enums/_api_types_.modeofoperation.md index 8908f94..0b99d2f 100644 --- a/docs/enums/_api_types_.modeofoperation.md +++ b/docs/enums/_api_types_.modeofoperation.md @@ -22,7 +22,7 @@ This case should never happen. **Active**: = "Active" -*Defined in [api/types.ts:5433](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5433)* +*Defined in [api/types.ts:5433](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5433)* ___ @@ -31,7 +31,7 @@ ___ **Idle**: = "Idle" -*Defined in [api/types.ts:5429](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5429)* +*Defined in [api/types.ts:5429](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5429)* ___ @@ -40,7 +40,7 @@ ___ **Unknown**: = "Unknown" -*Defined in [api/types.ts:5437](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5437)* +*Defined in [api/types.ts:5437](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5437)* This case should never happen. diff --git a/docs/enums/_api_types_.movestatus.md b/docs/enums/_api_types_.movestatus.md index da1e1a2..bead7e7 100644 --- a/docs/enums/_api_types_.movestatus.md +++ b/docs/enums/_api_types_.movestatus.md @@ -20,7 +20,7 @@ **IDLE**: = "IDLE" -*Defined in [api/types.ts:4225](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4225)* +*Defined in [api/types.ts:4225](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4225)* ___ @@ -29,7 +29,7 @@ ___ **MOVING**: = "MOVING" -*Defined in [api/types.ts:4229](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4229)* +*Defined in [api/types.ts:4229](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4229)* ___ @@ -38,7 +38,7 @@ ___ **UNKNOWN**: = "UNKNOWN" -*Defined in [api/types.ts:4233](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4233)* +*Defined in [api/types.ts:4233](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4233)* ___ diff --git a/docs/enums/_api_types_.mpeg4profile.md b/docs/enums/_api_types_.mpeg4profile.md index a24ba9f..36c483a 100644 --- a/docs/enums/_api_types_.mpeg4profile.md +++ b/docs/enums/_api_types_.mpeg4profile.md @@ -19,7 +19,7 @@ **ASP**: = "ASP" -*Defined in [api/types.ts:4373](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4373)* +*Defined in [api/types.ts:4373](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4373)* ___ @@ -28,7 +28,7 @@ ___ **SP**: = "SP" -*Defined in [api/types.ts:4369](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4369)* +*Defined in [api/types.ts:4369](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4369)* ___ diff --git a/docs/enums/_api_types_.networkhosttype.md b/docs/enums/_api_types_.networkhosttype.md index 5730a99..7eb7cae 100644 --- a/docs/enums/_api_types_.networkhosttype.md +++ b/docs/enums/_api_types_.networkhosttype.md @@ -20,7 +20,7 @@ **DNS**: = "DNS" -*Defined in [api/types.ts:4641](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4641)* +*Defined in [api/types.ts:4641](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4641)* ___ @@ -29,7 +29,7 @@ ___ **IPv4**: = "IPv4" -*Defined in [api/types.ts:4633](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4633)* +*Defined in [api/types.ts:4633](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4633)* ___ @@ -38,7 +38,7 @@ ___ **IPv6**: = "IPv6" -*Defined in [api/types.ts:4637](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4637)* +*Defined in [api/types.ts:4637](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4637)* ___ diff --git a/docs/enums/_api_types_.networkprotocoltype.md b/docs/enums/_api_types_.networkprotocoltype.md index b127892..cc47fb9 100644 --- a/docs/enums/_api_types_.networkprotocoltype.md +++ b/docs/enums/_api_types_.networkprotocoltype.md @@ -20,7 +20,7 @@ **HTTP**: = "HTTP" -*Defined in [api/types.ts:4615](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4615)* +*Defined in [api/types.ts:4615](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4615)* ___ @@ -29,7 +29,7 @@ ___ **HTTPS**: = "HTTPS" -*Defined in [api/types.ts:4619](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4619)* +*Defined in [api/types.ts:4619](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4619)* ___ @@ -38,7 +38,7 @@ ___ **RTSP**: = "RTSP" -*Defined in [api/types.ts:4623](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4623)* +*Defined in [api/types.ts:4623](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4623)* ___ diff --git a/docs/enums/_api_types_.osdtype.md b/docs/enums/_api_types_.osdtype.md index 84e2843..968ab60 100644 --- a/docs/enums/_api_types_.osdtype.md +++ b/docs/enums/_api_types_.osdtype.md @@ -20,7 +20,7 @@ **Extended**: = "Extended" -*Defined in [api/types.ts:5455](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5455)* +*Defined in [api/types.ts:5455](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5455)* ___ @@ -29,7 +29,7 @@ ___ **Image**: = "Image" -*Defined in [api/types.ts:5451](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5451)* +*Defined in [api/types.ts:5451](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5451)* ___ @@ -38,7 +38,7 @@ ___ **Text**: = "Text" -*Defined in [api/types.ts:5447](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5447)* +*Defined in [api/types.ts:5447](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5447)* ___ diff --git a/docs/enums/_api_types_.propertyoperation.md b/docs/enums/_api_types_.propertyoperation.md index ae9091b..3bae12f 100644 --- a/docs/enums/_api_types_.propertyoperation.md +++ b/docs/enums/_api_types_.propertyoperation.md @@ -20,7 +20,7 @@ **Changed**: = "Changed" -*Defined in [api/types.ts:5279](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5279)* +*Defined in [api/types.ts:5279](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5279)* ___ @@ -29,7 +29,7 @@ ___ **Deleted**: = "Deleted" -*Defined in [api/types.ts:5275](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5275)* +*Defined in [api/types.ts:5275](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5275)* ___ @@ -38,7 +38,7 @@ ___ **Initialized**: = "Initialized" -*Defined in [api/types.ts:5271](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5271)* +*Defined in [api/types.ts:5271](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5271)* ___ diff --git a/docs/enums/_api_types_.ptzpresettourdirection.md b/docs/enums/_api_types_.ptzpresettourdirection.md index f9d773f..a86ada5 100644 --- a/docs/enums/_api_types_.ptzpresettourdirection.md +++ b/docs/enums/_api_types_.ptzpresettourdirection.md @@ -20,7 +20,7 @@ **Backward**: = "Backward" -*Defined in [api/types.ts:5039](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5039)* +*Defined in [api/types.ts:5039](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5039)* ___ @@ -29,7 +29,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:5043](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5043)* +*Defined in [api/types.ts:5043](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5043)* ___ @@ -38,7 +38,7 @@ ___ **Forward**: = "Forward" -*Defined in [api/types.ts:5035](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5035)* +*Defined in [api/types.ts:5035](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5035)* ___ diff --git a/docs/enums/_api_types_.ptzpresettouroperation.md b/docs/enums/_api_types_.ptzpresettouroperation.md index d27c2e3..cb8cbd6 100644 --- a/docs/enums/_api_types_.ptzpresettouroperation.md +++ b/docs/enums/_api_types_.ptzpresettouroperation.md @@ -21,7 +21,7 @@ **Extended**: = "Extended" -*Defined in [api/types.ts:5065](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5065)* +*Defined in [api/types.ts:5065](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5065)* ___ @@ -30,7 +30,7 @@ ___ **Pause**: = "Pause" -*Defined in [api/types.ts:5061](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5061)* +*Defined in [api/types.ts:5061](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5061)* ___ @@ -39,7 +39,7 @@ ___ **Start**: = "Start" -*Defined in [api/types.ts:5053](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5053)* +*Defined in [api/types.ts:5053](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5053)* ___ @@ -48,7 +48,7 @@ ___ **Stop**: = "Stop" -*Defined in [api/types.ts:5057](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5057)* +*Defined in [api/types.ts:5057](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5057)* ___ diff --git a/docs/enums/_api_types_.ptzpresettourstate.md b/docs/enums/_api_types_.ptzpresettourstate.md index 364903b..9d65aef 100644 --- a/docs/enums/_api_types_.ptzpresettourstate.md +++ b/docs/enums/_api_types_.ptzpresettourstate.md @@ -21,7 +21,7 @@ **Extended**: = "Extended" -*Defined in [api/types.ts:5025](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5025)* +*Defined in [api/types.ts:5025](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5025)* ___ @@ -30,7 +30,7 @@ ___ **Idle**: = "Idle" -*Defined in [api/types.ts:5013](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5013)* +*Defined in [api/types.ts:5013](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5013)* ___ @@ -39,7 +39,7 @@ ___ **Paused**: = "Paused" -*Defined in [api/types.ts:5021](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5021)* +*Defined in [api/types.ts:5021](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5021)* ___ @@ -48,7 +48,7 @@ ___ **Touring**: = "Touring" -*Defined in [api/types.ts:5017](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5017)* +*Defined in [api/types.ts:5017](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5017)* ___ diff --git a/docs/enums/_api_types_.receivermode.md b/docs/enums/_api_types_.receivermode.md index 7f41f6a..ce20391 100644 --- a/docs/enums/_api_types_.receivermode.md +++ b/docs/enums/_api_types_.receivermode.md @@ -25,7 +25,7 @@ **AlwaysConnect**: = "AlwaysConnect" -*Defined in [api/types.ts:5313](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5313)* +*Defined in [api/types.ts:5313](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5313)* The receiver attempts to maintain a persistent connection to the configured endpoint. @@ -36,7 +36,7 @@ ___ **AutoConnect**: = "AutoConnect" -*Defined in [api/types.ts:5309](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5309)* +*Defined in [api/types.ts:5309](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5309)* The receiver connects on demand, as required by consumers of the media streams. @@ -47,7 +47,7 @@ ___ **NeverConnect**: = "NeverConnect" -*Defined in [api/types.ts:5317](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5317)* +*Defined in [api/types.ts:5317](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5317)* The receiver does not attempt to connect. @@ -58,7 +58,7 @@ ___ **Unknown**: = "Unknown" -*Defined in [api/types.ts:5321](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5321)* +*Defined in [api/types.ts:5321](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5321)* This case should never happen. diff --git a/docs/enums/_api_types_.receiverstate.md b/docs/enums/_api_types_.receiverstate.md index 85a1cc2..9fdc318 100644 --- a/docs/enums/_api_types_.receiverstate.md +++ b/docs/enums/_api_types_.receiverstate.md @@ -25,7 +25,7 @@ **Connected**: = "Connected" -*Defined in [api/types.ts:5341](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5341)* +*Defined in [api/types.ts:5341](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5341)* The receiver is connected. @@ -36,7 +36,7 @@ ___ **Connecting**: = "Connecting" -*Defined in [api/types.ts:5337](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5337)* +*Defined in [api/types.ts:5337](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5337)* The receiver is attempting to connect. @@ -47,7 +47,7 @@ ___ **NotConnected**: = "NotConnected" -*Defined in [api/types.ts:5333](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5333)* +*Defined in [api/types.ts:5333](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5333)* The receiver is not connected. @@ -58,7 +58,7 @@ ___ **Unknown**: = "Unknown" -*Defined in [api/types.ts:5345](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5345)* +*Defined in [api/types.ts:5345](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5345)* This case should never happen. diff --git a/docs/enums/_api_types_.recordingstatus.md b/docs/enums/_api_types_.recordingstatus.md index 79f5a31..51c1096 100644 --- a/docs/enums/_api_types_.recordingstatus.md +++ b/docs/enums/_api_types_.recordingstatus.md @@ -25,7 +25,7 @@ This case should never happen. **Initiated**: = "Initiated" -*Defined in [api/types.ts:5377](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5377)* +*Defined in [api/types.ts:5377](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5377)* ___ @@ -34,7 +34,7 @@ ___ **Recording**: = "Recording" -*Defined in [api/types.ts:5381](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5381)* +*Defined in [api/types.ts:5381](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5381)* ___ @@ -43,7 +43,7 @@ ___ **Removed**: = "Removed" -*Defined in [api/types.ts:5393](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5393)* +*Defined in [api/types.ts:5393](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5393)* ___ @@ -52,7 +52,7 @@ ___ **Removing**: = "Removing" -*Defined in [api/types.ts:5389](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5389)* +*Defined in [api/types.ts:5389](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5389)* ___ @@ -61,7 +61,7 @@ ___ **Stopped**: = "Stopped" -*Defined in [api/types.ts:5385](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5385)* +*Defined in [api/types.ts:5385](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5385)* ___ @@ -70,7 +70,7 @@ ___ **Unknown**: = "Unknown" -*Defined in [api/types.ts:5397](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5397)* +*Defined in [api/types.ts:5397](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5397)* This case should never happen. diff --git a/docs/enums/_api_types_.relayidlestate.md b/docs/enums/_api_types_.relayidlestate.md index d4a45e8..fc08aea 100644 --- a/docs/enums/_api_types_.relayidlestate.md +++ b/docs/enums/_api_types_.relayidlestate.md @@ -19,7 +19,7 @@ **closed**: = "closed" -*Defined in [api/types.ts:4931](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4931)* +*Defined in [api/types.ts:4931](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4931)* ___ @@ -28,7 +28,7 @@ ___ **open**: = "open" -*Defined in [api/types.ts:4935](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4935)* +*Defined in [api/types.ts:4935](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4935)* ___ diff --git a/docs/enums/_api_types_.relaylogicalstate.md b/docs/enums/_api_types_.relaylogicalstate.md index dd26123..6de028a 100644 --- a/docs/enums/_api_types_.relaylogicalstate.md +++ b/docs/enums/_api_types_.relaylogicalstate.md @@ -19,7 +19,7 @@ **active**: = "active" -*Defined in [api/types.ts:4917](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4917)* +*Defined in [api/types.ts:4917](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4917)* ___ @@ -28,7 +28,7 @@ ___ **inactive**: = "inactive" -*Defined in [api/types.ts:4921](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4921)* +*Defined in [api/types.ts:4921](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4921)* ___ diff --git a/docs/enums/_api_types_.relaymode.md b/docs/enums/_api_types_.relaymode.md index 7cbd786..f7408b6 100644 --- a/docs/enums/_api_types_.relaymode.md +++ b/docs/enums/_api_types_.relaymode.md @@ -19,7 +19,7 @@ **Bistable**: = "Bistable" -*Defined in [api/types.ts:4949](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4949)* +*Defined in [api/types.ts:4949](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4949)* ___ @@ -28,7 +28,7 @@ ___ **Monostable**: = "Monostable" -*Defined in [api/types.ts:4945](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4945)* +*Defined in [api/types.ts:4945](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4945)* ___ diff --git a/docs/enums/_api_types_.reversemode.md b/docs/enums/_api_types_.reversemode.md index b91e366..7edc730 100644 --- a/docs/enums/_api_types_.reversemode.md +++ b/docs/enums/_api_types_.reversemode.md @@ -21,7 +21,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:4999](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4999)* +*Defined in [api/types.ts:4999](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4999)* ___ @@ -30,7 +30,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:5003](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5003)* +*Defined in [api/types.ts:5003](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5003)* ___ @@ -39,7 +39,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:4991](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4991)* +*Defined in [api/types.ts:4991](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4991)* ___ @@ -48,7 +48,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:4995](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4995)* +*Defined in [api/types.ts:4995](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4995)* ___ diff --git a/docs/enums/_api_types_.rotatemode.md b/docs/enums/_api_types_.rotatemode.md index 6eb48f8..6e9d7c5 100644 --- a/docs/enums/_api_types_.rotatemode.md +++ b/docs/enums/_api_types_.rotatemode.md @@ -22,7 +22,7 @@ Enable the Rotate feature. Degree of rotation is specified Degree parameter. **AUTO**: = "AUTO" -*Defined in [api/types.ts:4269](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4269)* +*Defined in [api/types.ts:4269](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4269)* Rotate feature is automatically activated by the device. @@ -33,7 +33,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:4261](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4261)* +*Defined in [api/types.ts:4261](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4261)* Enable the Rotate feature. Degree of rotation is specified Degree parameter. @@ -44,7 +44,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:4265](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4265)* +*Defined in [api/types.ts:4265](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4265)* Disable the Rotate feature. diff --git a/docs/enums/_api_types_.sceneorientationmode.md b/docs/enums/_api_types_.sceneorientationmode.md index 15f2b21..82ac291 100644 --- a/docs/enums/_api_types_.sceneorientationmode.md +++ b/docs/enums/_api_types_.sceneorientationmode.md @@ -19,7 +19,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:4283](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4283)* +*Defined in [api/types.ts:4283](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4283)* ___ @@ -28,7 +28,7 @@ ___ **MANUAL**: = "MANUAL" -*Defined in [api/types.ts:4279](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4279)* +*Defined in [api/types.ts:4279](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4279)* ___ diff --git a/docs/enums/_api_types_.sceneorientationoption.md b/docs/enums/_api_types_.sceneorientationoption.md index b25a54f..f0d6d34 100644 --- a/docs/enums/_api_types_.sceneorientationoption.md +++ b/docs/enums/_api_types_.sceneorientationoption.md @@ -24,7 +24,7 @@ **Above**: = "Above" -*Defined in [api/types.ts:4303](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4303)* +*Defined in [api/types.ts:4303](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4303)* ___ @@ -33,7 +33,7 @@ ___ **Below**: = "Below" -*Defined in [api/types.ts:4295](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4295)* +*Defined in [api/types.ts:4295](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4295)* ___ @@ -42,7 +42,7 @@ ___ **Horizon**: = "Horizon" -*Defined in [api/types.ts:4299](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4299)* +*Defined in [api/types.ts:4299](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4299)* ___ diff --git a/docs/enums/_api_types_.scopedefinition.md b/docs/enums/_api_types_.scopedefinition.md index 8ffb941..59c9d8f 100644 --- a/docs/enums/_api_types_.scopedefinition.md +++ b/docs/enums/_api_types_.scopedefinition.md @@ -19,7 +19,7 @@ **Configurable**: = "Configurable" -*Defined in [api/types.ts:4555](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4555)* +*Defined in [api/types.ts:4555](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4555)* ___ @@ -28,7 +28,7 @@ ___ **Fixed**: = "Fixed" -*Defined in [api/types.ts:4551](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4551)* +*Defined in [api/types.ts:4551](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4551)* ___ diff --git a/docs/enums/_api_types_.searchstate.md b/docs/enums/_api_types_.searchstate.md index d75e05e..f130bb2 100644 --- a/docs/enums/_api_types_.searchstate.md +++ b/docs/enums/_api_types_.searchstate.md @@ -23,7 +23,7 @@ The search is queued and not yet started. **Completed**: = "Completed" -*Defined in [api/types.ts:5363](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5363)* +*Defined in [api/types.ts:5363](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5363)* The search has been completed and no new results will be found. @@ -34,7 +34,7 @@ ___ **Queued**: = "Queued" -*Defined in [api/types.ts:5355](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5355)* +*Defined in [api/types.ts:5355](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5355)* The search is queued and not yet started. @@ -45,7 +45,7 @@ ___ **Searching**: = "Searching" -*Defined in [api/types.ts:5359](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5359)* +*Defined in [api/types.ts:5359](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5359)* The search is underway and not yet completed. @@ -56,7 +56,7 @@ ___ **Unknown**: = "Unknown" -*Defined in [api/types.ts:5367](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5367)* +*Defined in [api/types.ts:5367](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5367)* The state of the search is unknown. (This is not a valid response from GetSearchState.) diff --git a/docs/enums/_api_types_.setdatetimetype.md b/docs/enums/_api_types_.setdatetimetype.md index fefe1f1..405c0fc 100644 --- a/docs/enums/_api_types_.setdatetimetype.md +++ b/docs/enums/_api_types_.setdatetimetype.md @@ -21,7 +21,7 @@ Indicates that the date and time are set manually. **Manual**: = "Manual" -*Defined in [api/types.ts:4877](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4877)* +*Defined in [api/types.ts:4877](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4877)* Indicates that the date and time are set manually. @@ -32,7 +32,7 @@ ___ **NTP**: = "NTP" -*Defined in [api/types.ts:4881](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4881)* +*Defined in [api/types.ts:4881](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4881)* Indicates that the date and time are set through NTP diff --git a/docs/enums/_api_types_.streamtype.md b/docs/enums/_api_types_.streamtype.md index 0dca434..eb61815 100644 --- a/docs/enums/_api_types_.streamtype.md +++ b/docs/enums/_api_types_.streamtype.md @@ -19,7 +19,7 @@ **RTP-Multicast**: = "RTP-Multicast" -*Defined in [api/types.ts:4519](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4519)* +*Defined in [api/types.ts:4519](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4519)* ___ @@ -28,7 +28,7 @@ ___ **RTP-Unicast**: = "RTP-Unicast" -*Defined in [api/types.ts:4515](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4515)* +*Defined in [api/types.ts:4515](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4515)* ___ diff --git a/docs/enums/_api_types_.systemlogtype.md b/docs/enums/_api_types_.systemlogtype.md index fd5359f..8486d3f 100644 --- a/docs/enums/_api_types_.systemlogtype.md +++ b/docs/enums/_api_types_.systemlogtype.md @@ -21,7 +21,7 @@ Enumeration describing the available system log modes. **Access**: = "Access" -*Defined in [api/types.ts:4853](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4853)* +*Defined in [api/types.ts:4853](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4853)* Indicates that a access log is requested. @@ -32,7 +32,7 @@ ___ **System**: = "System" -*Defined in [api/types.ts:4849](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4849)* +*Defined in [api/types.ts:4849](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4849)* Indicates that a system log is requested. diff --git a/docs/enums/_api_types_.tonecompensationmode.md b/docs/enums/_api_types_.tonecompensationmode.md index fe40503..e94e3ee 100644 --- a/docs/enums/_api_types_.tonecompensationmode.md +++ b/docs/enums/_api_types_.tonecompensationmode.md @@ -20,7 +20,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5243](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5243)* +*Defined in [api/types.ts:5243](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5243)* ___ @@ -29,7 +29,7 @@ ___ **OFF**: = "OFF" -*Defined in [api/types.ts:5235](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5235)* +*Defined in [api/types.ts:5235](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5235)* ___ @@ -38,7 +38,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:5239](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5239)* +*Defined in [api/types.ts:5239](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5239)* ___ diff --git a/docs/enums/_api_types_.tracktype.md b/docs/enums/_api_types_.tracktype.md index 6f175ee..078e8d7 100644 --- a/docs/enums/_api_types_.tracktype.md +++ b/docs/enums/_api_types_.tracktype.md @@ -23,7 +23,7 @@ Placeholder for future extension. **Audio**: = "Audio" -*Defined in [api/types.ts:5411](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5411)* +*Defined in [api/types.ts:5411](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5411)* ___ @@ -32,7 +32,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:5419](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5419)* +*Defined in [api/types.ts:5419](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5419)* Placeholder for future extension. @@ -43,7 +43,7 @@ ___ **Metadata**: = "Metadata" -*Defined in [api/types.ts:5415](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5415)* +*Defined in [api/types.ts:5415](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5415)* ___ @@ -52,7 +52,7 @@ ___ **Video**: = "Video" -*Defined in [api/types.ts:5407](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5407)* +*Defined in [api/types.ts:5407](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5407)* ___ diff --git a/docs/enums/_api_types_.transportprotocol.md b/docs/enums/_api_types_.transportprotocol.md index dc7235f..9d4fbf1 100644 --- a/docs/enums/_api_types_.transportprotocol.md +++ b/docs/enums/_api_types_.transportprotocol.md @@ -23,7 +23,7 @@ This value is deprecated. **HTTP**: = "HTTP" -*Defined in [api/types.ts:4541](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4541)* +*Defined in [api/types.ts:4541](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4541)* ___ @@ -32,7 +32,7 @@ ___ **RTSP**: = "RTSP" -*Defined in [api/types.ts:4537](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4537)* +*Defined in [api/types.ts:4537](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4537)* ___ @@ -41,7 +41,7 @@ ___ **TCP**: = "TCP" -*Defined in [api/types.ts:4533](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4533)* +*Defined in [api/types.ts:4533](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4533)* This value is deprecated. @@ -52,7 +52,7 @@ ___ **UDP**: = "UDP" -*Defined in [api/types.ts:4529](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4529)* +*Defined in [api/types.ts:4529](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4529)* ___ diff --git a/docs/enums/_api_types_.userlevel.md b/docs/enums/_api_types_.userlevel.md index a4f3ee6..fef3bad 100644 --- a/docs/enums/_api_types_.userlevel.md +++ b/docs/enums/_api_types_.userlevel.md @@ -22,7 +22,7 @@ **Administrator**: = "Administrator" -*Defined in [api/types.ts:4891](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4891)* +*Defined in [api/types.ts:4891](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4891)* ___ @@ -31,7 +31,7 @@ ___ **Anonymous**: = "Anonymous" -*Defined in [api/types.ts:4903](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4903)* +*Defined in [api/types.ts:4903](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4903)* ___ @@ -40,7 +40,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4907](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4907)* +*Defined in [api/types.ts:4907](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4907)* ___ @@ -49,7 +49,7 @@ ___ **Operator**: = "Operator" -*Defined in [api/types.ts:4895](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4895)* +*Defined in [api/types.ts:4895](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4895)* ___ @@ -58,7 +58,7 @@ ___ **User**: = "User" -*Defined in [api/types.ts:4899](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4899)* +*Defined in [api/types.ts:4899](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4899)* ___ diff --git a/docs/enums/_api_types_.videoencoding.md b/docs/enums/_api_types_.videoencoding.md index 3532973..21acb18 100644 --- a/docs/enums/_api_types_.videoencoding.md +++ b/docs/enums/_api_types_.videoencoding.md @@ -20,7 +20,7 @@ **H264**: = "H264" -*Defined in [api/types.ts:4359](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4359)* +*Defined in [api/types.ts:4359](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4359)* ___ @@ -29,7 +29,7 @@ ___ **JPEG**: = "JPEG" -*Defined in [api/types.ts:4351](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4351)* +*Defined in [api/types.ts:4351](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4351)* ___ @@ -38,7 +38,7 @@ ___ **MPEG4**: = "MPEG4" -*Defined in [api/types.ts:4355](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4355)* +*Defined in [api/types.ts:4355](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4355)* ___ diff --git a/docs/enums/_api_types_.videoencodingmimenames.md b/docs/enums/_api_types_.videoencodingmimenames.md index 5103612..86818f6 100644 --- a/docs/enums/_api_types_.videoencodingmimenames.md +++ b/docs/enums/_api_types_.videoencodingmimenames.md @@ -23,7 +23,7 @@ Video Media Subtypes as referenced by IANA (without the leading "video/" Video M **H264**: = "H264" -*Defined in [api/types.ts:4413](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4413)* +*Defined in [api/types.ts:4413](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4413)* ___ @@ -32,7 +32,7 @@ ___ **H265**: = "H265" -*Defined in [api/types.ts:4417](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4417)* +*Defined in [api/types.ts:4417](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4417)* ___ @@ -41,7 +41,7 @@ ___ **JPEG**: = "JPEG" -*Defined in [api/types.ts:4405](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4405)* +*Defined in [api/types.ts:4405](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4405)* ___ @@ -50,7 +50,7 @@ ___ **MPV4-ES**: = "MPV4-ES" -*Defined in [api/types.ts:4409](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4409)* +*Defined in [api/types.ts:4409](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4409)* ___ diff --git a/docs/enums/_api_types_.videoencodingprofiles.md b/docs/enums/_api_types_.videoencodingprofiles.md index 9043ae4..5ba2f92 100644 --- a/docs/enums/_api_types_.videoencodingprofiles.md +++ b/docs/enums/_api_types_.videoencodingprofiles.md @@ -24,7 +24,7 @@ **AdvancedSimple**: = "AdvancedSimple" -*Defined in [api/types.ts:4431](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4431)* +*Defined in [api/types.ts:4431](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4431)* ___ @@ -33,7 +33,7 @@ ___ **Baseline**: = "Baseline" -*Defined in [api/types.ts:4435](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4435)* +*Defined in [api/types.ts:4435](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4435)* ___ @@ -42,7 +42,7 @@ ___ **Extended**: = "Extended" -*Defined in [api/types.ts:4447](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4447)* +*Defined in [api/types.ts:4447](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4447)* ___ @@ -51,7 +51,7 @@ ___ **High**: = "High" -*Defined in [api/types.ts:4451](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4451)* +*Defined in [api/types.ts:4451](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4451)* ___ @@ -60,7 +60,7 @@ ___ **Main**: = "Main" -*Defined in [api/types.ts:4439](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4439)* +*Defined in [api/types.ts:4439](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4439)* ___ @@ -69,7 +69,7 @@ ___ **Main10**: = "Main10" -*Defined in [api/types.ts:4443](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4443)* +*Defined in [api/types.ts:4443](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4443)* ___ @@ -78,7 +78,7 @@ ___ **Simple**: = "Simple" -*Defined in [api/types.ts:4427](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4427)* +*Defined in [api/types.ts:4427](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4427)* ___ diff --git a/docs/enums/_api_types_.viewmodes.md b/docs/enums/_api_types_.viewmodes.md index f0633d6..ad316ca 100644 --- a/docs/enums/_api_types_.viewmodes.md +++ b/docs/enums/_api_types_.viewmodes.md @@ -27,7 +27,7 @@ Source view modes supported by device. **180Panorama**: = "180Panorama" -*Defined in [api/types.ts:4321](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4321)* +*Defined in [api/types.ts:4321](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4321)* 180 degree panoramic view. @@ -38,7 +38,7 @@ ___ **360Panorama**: = "360Panorama" -*Defined in [api/types.ts:4317](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4317)* +*Defined in [api/types.ts:4317](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4317)* 360 degree panoramic view. @@ -49,7 +49,7 @@ ___ **Dewarp**: = "Dewarp" -*Defined in [api/types.ts:4341](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4341)* +*Defined in [api/types.ts:4341](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4341)* Dewarped view mode for device supporting fisheye lens. @@ -60,7 +60,7 @@ ___ **Fisheye**: = "Fisheye" -*Defined in [api/types.ts:4313](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4313)* +*Defined in [api/types.ts:4313](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4313)* Undewarped viewmode from device supporting fisheye lens. @@ -71,7 +71,7 @@ ___ **LeftHalf**: = "LeftHalf" -*Defined in [api/types.ts:4333](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4333)* +*Defined in [api/types.ts:4333](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4333)* Viewmode combining the left side sensors, applicable for devices supporting multiple sensors. @@ -82,7 +82,7 @@ ___ **Original**: = "Original" -*Defined in [api/types.ts:4329](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4329)* +*Defined in [api/types.ts:4329](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4329)* Unaltered view from the sensor. @@ -93,7 +93,7 @@ ___ **Quad**: = "Quad" -*Defined in [api/types.ts:4325](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4325)* +*Defined in [api/types.ts:4325](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4325)* View mode combining four streams in single Quad, eg., applicable for devices supporting four heads. @@ -104,7 +104,7 @@ ___ **RightHalf**: = "RightHalf" -*Defined in [api/types.ts:4337](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4337)* +*Defined in [api/types.ts:4337](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4337)* Viewmode combining the right side sensors, applicable for devices supporting multiple sensors. diff --git a/docs/enums/_api_types_.whitebalancemode.md b/docs/enums/_api_types_.whitebalancemode.md index dc5c54e..795b18c 100644 --- a/docs/enums/_api_types_.whitebalancemode.md +++ b/docs/enums/_api_types_.whitebalancemode.md @@ -19,7 +19,7 @@ **AUTO**: = "AUTO" -*Defined in [api/types.ts:5159](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5159)* +*Defined in [api/types.ts:5159](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5159)* ___ @@ -28,7 +28,7 @@ ___ **MANUAL**: = "MANUAL" -*Defined in [api/types.ts:5163](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5163)* +*Defined in [api/types.ts:5163](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5163)* ___ diff --git a/docs/enums/_api_types_.widedynamicmode.md b/docs/enums/_api_types_.widedynamicmode.md index 3caabe9..8ba632a 100644 --- a/docs/enums/_api_types_.widedynamicmode.md +++ b/docs/enums/_api_types_.widedynamicmode.md @@ -19,7 +19,7 @@ **OFF**: = "OFF" -*Defined in [api/types.ts:5089](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5089)* +*Defined in [api/types.ts:5089](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5089)* ___ @@ -28,7 +28,7 @@ ___ **ON**: = "ON" -*Defined in [api/types.ts:5093](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L5093)* +*Defined in [api/types.ts:5093](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L5093)* ___ diff --git a/docs/enums/_soap_request_.soap_node.md b/docs/enums/_soap_request_.soap_node.md index 88d813a..53e3a57 100644 --- a/docs/enums/_soap_request_.soap_node.md +++ b/docs/enums/_soap_request_.soap_node.md @@ -20,7 +20,7 @@ **Body**: = "S11:Body" -*Defined in [soap/request.ts:65](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L65)* +*Defined in [soap/request.ts:61](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L61)* ___ @@ -29,7 +29,7 @@ ___ **Envelope**: = "S11:Envelope" -*Defined in [soap/request.ts:64](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L64)* +*Defined in [soap/request.ts:60](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L60)* ___ @@ -38,7 +38,7 @@ ___ **Header**: = "S11:Header" -*Defined in [soap/request.ts:63](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L63)* +*Defined in [soap/request.ts:59](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L59)* ___ diff --git a/docs/enums/_soap_request_.xmlns.md b/docs/enums/_soap_request_.xmlns.md index 6232ac1..354852c 100644 --- a/docs/enums/_soap_request_.xmlns.md +++ b/docs/enums/_soap_request_.xmlns.md @@ -50,7 +50,7 @@ **S11**: = "xmlns:S11="http://www.w3.org/2003/05/soap-envelope"" -*Defined in [soap/request.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L9)* +*Defined in [soap/request.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L16)* ___ @@ -59,7 +59,7 @@ ___ **ns1**: = "xmlns:ns1="http://www.onvif.org/ver10/accesscontrol/wsdl"" -*Defined in [soap/request.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L17)* +*Defined in [soap/request.ts:24](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L24)* ___ @@ -68,7 +68,7 @@ ___ **ns2**: = "xmlns:ns2="http://www.onvif.org/ver10/pacs"" -*Defined in [soap/request.ts:40](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L40)* +*Defined in [soap/request.ts:47](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L47)* ___ @@ -77,7 +77,7 @@ ___ **ns3**: = "xmlns:ns3="http://www.onvif.org/ver10/actionengine/wsdl"" -*Defined in [soap/request.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L18)* +*Defined in [soap/request.ts:25](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L25)* ___ @@ -86,7 +86,7 @@ ___ **tad**: = "xmlns:tad="http://www.onvif.org/ver10/analyticsdevice/wsdl"" -*Defined in [soap/request.ts:19](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L19)* +*Defined in [soap/request.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L26)* ___ @@ -95,7 +95,7 @@ ___ **tan**: = "xmlns:tan="http://www.onvif.org/ver20/analytics/wsdl"" -*Defined in [soap/request.ts:37](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L37)* +*Defined in [soap/request.ts:44](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L44)* ___ @@ -104,7 +104,7 @@ ___ **tds**: = "xmlns:tds="http://www.onvif.org/ver10/device/wsdl"" -*Defined in [soap/request.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L13)* +*Defined in [soap/request.ts:20](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L20)* ___ @@ -113,7 +113,7 @@ ___ **ter**: = "xmlns:ter="http://www.onvif.org/ver10/error"" -*Defined in [soap/request.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L38)* +*Defined in [soap/request.ts:45](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L45)* ___ @@ -122,7 +122,7 @@ ___ **tev**: = "xmlns:tev="http://www.onvif.org/ver10/events/wsdl"" -*Defined in [soap/request.ts:28](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L28)* +*Defined in [soap/request.ts:35](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L35)* ___ @@ -131,7 +131,7 @@ ___ **timg**: = "xmlns:timg="http://www.onvif.org/ver20/imaging/wsdl"" -*Defined in [soap/request.ts:20](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L20)* +*Defined in [soap/request.ts:27](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L27)* ___ @@ -140,7 +140,7 @@ ___ **tns1**: = "xmlns:tns1="http://www.onvif.org/ver10/topics"" -*Defined in [soap/request.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L39)* +*Defined in [soap/request.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L46)* ___ @@ -149,7 +149,7 @@ ___ **tptz**: = "xmlns:tptz="http://www.onvif.org/ver20/ptz/wsdl"" -*Defined in [soap/request.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L21)* +*Defined in [soap/request.ts:28](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L28)* ___ @@ -158,7 +158,7 @@ ___ **trc**: = "xmlns:trc="http://www.onvif.org/ver10/recording/wsdl"" -*Defined in [soap/request.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L22)* +*Defined in [soap/request.ts:29](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L29)* ___ @@ -167,7 +167,7 @@ ___ **trt**: = "xmlns:trt="http://www.onvif.org/ver10/media/wsdl"" -*Defined in [soap/request.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L14)* +*Defined in [soap/request.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L21)* ___ @@ -176,7 +176,7 @@ ___ **trv**: = "xmlns:trv="http://www.onvif.org/ver10/receiver/wsdl"" -*Defined in [soap/request.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L23)* +*Defined in [soap/request.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L30)* ___ @@ -185,7 +185,7 @@ ___ **tse**: = "xmlns:tse="http://www.onvif.org/ver10/search/wsdl"" -*Defined in [soap/request.ts:24](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L24)* +*Defined in [soap/request.ts:31](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L31)* ___ @@ -194,7 +194,7 @@ ___ **tt**: = "xmlns:tt="http://www.onvif.org/ver10/schema"" -*Defined in [soap/request.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L12)* +*Defined in [soap/request.ts:19](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L19)* ___ @@ -203,7 +203,7 @@ ___ **vifsvr**: = "xmlns:vifsvr="http://www.onvif.org/ver10/events/wsdl/PullPointSubscriptionBinding"" -*Defined in [soap/request.ts:25](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L25)* +*Defined in [soap/request.ts:32](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L32)* ___ @@ -212,7 +212,7 @@ ___ **vifsvr10**: = "xmlns:vifsvr10="http://www.onvif.org/ver20/analytics/wsdl/AnalyticsEngineBinding"" -*Defined in [soap/request.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L26)* +*Defined in [soap/request.ts:33](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L33)* ___ @@ -221,7 +221,7 @@ ___ **vifsvr2**: = "xmlns:vifsvr2="http://www.onvif.org/ver10/events/wsdl/EventBinding"" -*Defined in [soap/request.ts:27](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L27)* +*Defined in [soap/request.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L34)* ___ @@ -230,7 +230,7 @@ ___ **vifsvr3**: = "xmlns:vifsvr3="http://www.onvif.org/ver10/events/wsdl/SubscriptionManagerBinding"" -*Defined in [soap/request.ts:29](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L29)* +*Defined in [soap/request.ts:36](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L36)* ___ @@ -239,7 +239,7 @@ ___ **vifsvr4**: = "xmlns:vifsvr4="http://www.onvif.org/ver10/events/wsdl/NotificationProducerBinding"" -*Defined in [soap/request.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L30)* +*Defined in [soap/request.ts:37](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L37)* ___ @@ -248,7 +248,7 @@ ___ **vifsvr5**: = "xmlns:vifsvr5="http://www.onvif.org/ver10/events/wsdl/NotificationConsumerBinding"" -*Defined in [soap/request.ts:31](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L31)* +*Defined in [soap/request.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L38)* ___ @@ -257,7 +257,7 @@ ___ **vifsvr6**: = "xmlns:vifsvr6="http://www.onvif.org/ver10/events/wsdl/PullPointBinding"" -*Defined in [soap/request.ts:32](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L32)* +*Defined in [soap/request.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L39)* ___ @@ -266,7 +266,7 @@ ___ **vifsvr7**: = "xmlns:vifsvr7="http://www.onvif.org/ver10/events/wsdl/CreatePullPointBinding"" -*Defined in [soap/request.ts:33](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L33)* +*Defined in [soap/request.ts:40](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L40)* ___ @@ -275,7 +275,7 @@ ___ **vifsvr8**: = "xmlns:vifsvr8="http://www.onvif.org/ver10/events/wsdl/PausableSubscriptionManagerBinding"" -*Defined in [soap/request.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L34)* +*Defined in [soap/request.ts:41](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L41)* ___ @@ -284,7 +284,7 @@ ___ **vifsvr9**: = "xmlns:vifsvr9="http://www.onvif.org/ver20/analytics/wsdl/RuleEngineBinding"" -*Defined in [soap/request.ts:36](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L36)* +*Defined in [soap/request.ts:43](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L43)* ___ @@ -293,7 +293,7 @@ ___ **wsa5**: = "xmlns:wsa5="http://www.w3.org/2005/08/addressing"" -*Defined in [soap/request.ts:41](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L41)* +*Defined in [soap/request.ts:48](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L48)* ___ @@ -302,7 +302,7 @@ ___ **wsnt**: = "xmlns:wsnt="http://docs.oasis-open.org/wsn/b-2"" -*Defined in [soap/request.ts:35](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L35)* +*Defined in [soap/request.ts:42](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L42)* ___ @@ -311,7 +311,7 @@ ___ **wsse**: = "xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"" -*Defined in [soap/request.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L10)* +*Defined in [soap/request.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L17)* ___ @@ -320,7 +320,7 @@ ___ **wsu**: = "xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"" -*Defined in [soap/request.ts:11](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L11)* +*Defined in [soap/request.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L18)* ___ @@ -329,7 +329,7 @@ ___ **xsd**: = "xmlns:xsd="http://www.w3.org/2001/XMLSchema"" -*Defined in [soap/request.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L16)* +*Defined in [soap/request.ts:23](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L23)* ___ @@ -338,7 +338,7 @@ ___ **xsi**: = "xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"" -*Defined in [soap/request.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L15)* +*Defined in [soap/request.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L22)* ___ diff --git a/docs/interfaces/_api_types_.aacdecoptions.md b/docs/interfaces/_api_types_.aacdecoptions.md index a85fec5..ed1b6da 100644 --- a/docs/interfaces/_api_types_.aacdecoptions.md +++ b/docs/interfaces/_api_types_.aacdecoptions.md @@ -25,7 +25,7 @@ List of supported bitrates in kbps **● Bitrate**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:962](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L962)* +*Defined in [api/types.ts:962](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L962)* ___ @@ -34,7 +34,7 @@ ___ **● SampleRateRange**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:963](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L963)* +*Defined in [api/types.ts:963](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L963)* ___ diff --git a/docs/interfaces/_api_types_.absolutefocus.md b/docs/interfaces/_api_types_.absolutefocus.md index 713a425..984d6c8 100644 --- a/docs/interfaces/_api_types_.absolutefocus.md +++ b/docs/interfaces/_api_types_.absolutefocus.md @@ -27,16 +27,16 @@ **● Position**: *`number`* -*Defined in [api/types.ts:2599](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2599)* +*Defined in [api/types.ts:2599](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2599)* ___ -### Speed +### `` Speed -**● Speed**: *`number`* +**● Speed**: *`undefined` \| `number`* -*Defined in [api/types.ts:2600](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2600)* +*Defined in [api/types.ts:2600](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2600)* ___ diff --git a/docs/interfaces/_api_types_.absolutefocusoptions.md b/docs/interfaces/_api_types_.absolutefocusoptions.md index 87354c4..d9d42b7 100644 --- a/docs/interfaces/_api_types_.absolutefocusoptions.md +++ b/docs/interfaces/_api_types_.absolutefocusoptions.md @@ -27,16 +27,16 @@ **● Position**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2637](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2637)* +*Defined in [api/types.ts:2637](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2637)* ___ -### Speed +### `` Speed **● Speed**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2638](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2638)* +*Defined in [api/types.ts:2638](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2638)* ___ diff --git a/docs/interfaces/_api_types_.actionengineeventpayload.md b/docs/interfaces/_api_types_.actionengineeventpayload.md index bae597b..f7305b6 100644 --- a/docs/interfaces/_api_types_.actionengineeventpayload.md +++ b/docs/interfaces/_api_types_.actionengineeventpayload.md @@ -23,38 +23,38 @@ Action Engine Event Payload data structure contains the information about the ON -### Extension +### `` Extension **● Extension**: *[ActionEngineEventPayloadExtension](_api_types_.actionengineeventpayloadextension.md)* -*Defined in [api/types.ts:3904](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3904)* +*Defined in [api/types.ts:3904](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3904)* ___ -### Fault +### `` Fault -**● Fault**: *[Fault](_api_types_.fault.md)* +**● Fault**: *[Fault](_api_types_.actionengineeventpayload.md#fault)* -*Defined in [api/types.ts:3903](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3903)* +*Defined in [api/types.ts:3903](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3903)* ___ -### RequestInfo +### `` RequestInfo **● RequestInfo**: *[Envelope](_api_types_.envelope.md)* -*Defined in [api/types.ts:3901](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3901)* +*Defined in [api/types.ts:3901](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3901)* ___ -### ResponseInfo +### `` ResponseInfo **● ResponseInfo**: *[Envelope](_api_types_.envelope.md)* -*Defined in [api/types.ts:3902](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3902)* +*Defined in [api/types.ts:3902](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3902)* ___ diff --git a/docs/interfaces/_api_types_.activeconnection.md b/docs/interfaces/_api_types_.activeconnection.md index 0ac0110..b229f2c 100644 --- a/docs/interfaces/_api_types_.activeconnection.md +++ b/docs/interfaces/_api_types_.activeconnection.md @@ -23,7 +23,7 @@ **● CurrentBitrate**: *`number`* -*Defined in [api/types.ts:3939](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3939)* +*Defined in [api/types.ts:3939](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3939)* ___ @@ -32,7 +32,7 @@ ___ **● CurrentFps**: *`number`* -*Defined in [api/types.ts:3940](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3940)* +*Defined in [api/types.ts:3940](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3940)* ___ diff --git a/docs/interfaces/_api_types_.analyticscapabilities.md b/docs/interfaces/_api_types_.analyticscapabilities.md index 7f9cada..1647d45 100644 --- a/docs/interfaces/_api_types_.analyticscapabilities.md +++ b/docs/interfaces/_api_types_.analyticscapabilities.md @@ -26,7 +26,7 @@ Analytics service URI. **● AnalyticsModuleSupport**: *`boolean`* -*Defined in [api/types.ts:1473](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1473)* +*Defined in [api/types.ts:1473](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1473)* ___ @@ -35,7 +35,7 @@ ___ **● RuleSupport**: *`boolean`* -*Defined in [api/types.ts:1472](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1472)* +*Defined in [api/types.ts:1472](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1472)* ___ @@ -44,7 +44,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1471](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1471)* +*Defined in [api/types.ts:1471](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1471)* ___ diff --git a/docs/interfaces/_api_types_.analyticsdevicecapabilities.md b/docs/interfaces/_api_types_.analyticsdevicecapabilities.md index 63ebdff..ce178ee 100644 --- a/docs/interfaces/_api_types_.analyticsdevicecapabilities.md +++ b/docs/interfaces/_api_types_.analyticsdevicecapabilities.md @@ -22,20 +22,20 @@ Obsolete property. -### Extension +### `` Extension **● Extension**: *[AnalyticsDeviceExtension](_api_types_.analyticsdeviceextension.md)* -*Defined in [api/types.ts:1742](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1742)* +*Defined in [api/types.ts:1742](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1742)* ___ -### RuleSupport +### `` RuleSupport -**● RuleSupport**: *`boolean`* +**● RuleSupport**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1741](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1741)* +*Defined in [api/types.ts:1741](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1741)* ___ @@ -44,7 +44,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1740](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1740)* +*Defined in [api/types.ts:1740](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1740)* ___ diff --git a/docs/interfaces/_api_types_.analyticsdeviceengineconfiguration.md b/docs/interfaces/_api_types_.analyticsdeviceengineconfiguration.md index 2f0d0fc..8e6432c 100644 --- a/docs/interfaces/_api_types_.analyticsdeviceengineconfiguration.md +++ b/docs/interfaces/_api_types_.analyticsdeviceengineconfiguration.md @@ -23,16 +23,16 @@ **● EngineConfiguration**: *[EngineConfiguration](_api_types_.engineconfiguration.md)* -*Defined in [api/types.ts:3798](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3798)* +*Defined in [api/types.ts:3798](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3798)* ___ -### Extension +### `` Extension **● Extension**: *[AnalyticsDeviceEngineConfigurationExtension](_api_types_.analyticsdeviceengineconfigurationextension.md)* -*Defined in [api/types.ts:3799](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3799)* +*Defined in [api/types.ts:3799](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3799)* ___ diff --git a/docs/interfaces/_api_types_.analyticsengine.md b/docs/interfaces/_api_types_.analyticsengine.md index 8b94804..9eeead6 100644 --- a/docs/interfaces/_api_types_.analyticsengine.md +++ b/docs/interfaces/_api_types_.analyticsengine.md @@ -22,7 +22,7 @@ **● AnalyticsEngineConfiguration**: *[AnalyticsDeviceEngineConfiguration](_api_types_.analyticsdeviceengineconfiguration.md)* -*Defined in [api/types.ts:3791](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3791)* +*Defined in [api/types.ts:3791](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3791)* ___ diff --git a/docs/interfaces/_api_types_.analyticsengineconfiguration.md b/docs/interfaces/_api_types_.analyticsengineconfiguration.md index 6965f82..99e5683 100644 --- a/docs/interfaces/_api_types_.analyticsengineconfiguration.md +++ b/docs/interfaces/_api_types_.analyticsengineconfiguration.md @@ -19,20 +19,20 @@ -### AnalyticsModule +### `` AnalyticsModule **● AnalyticsModule**: *[Config](_api_types_.config.md)* -*Defined in [api/types.ts:3182](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3182)* +*Defined in [api/types.ts:3182](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3182)* ___ -### Extension +### `` Extension **● Extension**: *[AnalyticsEngineConfigurationExtension](_api_types_.analyticsengineconfigurationextension.md)* -*Defined in [api/types.ts:3183](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3183)* +*Defined in [api/types.ts:3183](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3183)* ___ diff --git a/docs/interfaces/_api_types_.analyticsenginecontrol.md b/docs/interfaces/_api_types_.analyticsenginecontrol.md index 6608079..4959634 100644 --- a/docs/interfaces/_api_types_.analyticsenginecontrol.md +++ b/docs/interfaces/_api_types_.analyticsenginecontrol.md @@ -30,7 +30,7 @@ Token of the analytics engine (AnalyticsEngine) being controlled. **● EngineConfigToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3873](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3873)* +*Defined in [api/types.ts:3873](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3873)* ___ @@ -39,7 +39,7 @@ ___ **● EngineToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3872](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3872)* +*Defined in [api/types.ts:3872](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3872)* ___ @@ -48,7 +48,7 @@ ___ **● InputToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3874](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3874)* +*Defined in [api/types.ts:3874](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3874)* ___ @@ -57,16 +57,16 @@ ___ **● Mode**: *[ModeOfOperation](../enums/_api_types_.modeofoperation.md)* -*Defined in [api/types.ts:3878](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3878)* +*Defined in [api/types.ts:3878](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3878)* ___ -### Multicast +### `` Multicast **● Multicast**: *[MulticastConfiguration](_api_types_.multicastconfiguration.md)* -*Defined in [api/types.ts:3876](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3876)* +*Defined in [api/types.ts:3876](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3876)* ___ @@ -75,7 +75,7 @@ ___ **● ReceiverToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3875](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3875)* +*Defined in [api/types.ts:3875](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3875)* ___ @@ -84,7 +84,7 @@ ___ **● Subscription**: *[Config](_api_types_.config.md)* -*Defined in [api/types.ts:3877](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3877)* +*Defined in [api/types.ts:3877](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3877)* ___ diff --git a/docs/interfaces/_api_types_.analyticsengineinput.md b/docs/interfaces/_api_types_.analyticsengineinput.md index 173b524..478044d 100644 --- a/docs/interfaces/_api_types_.analyticsengineinput.md +++ b/docs/interfaces/_api_types_.analyticsengineinput.md @@ -24,7 +24,7 @@ **● MetadataInput**: *[MetadataInput](_api_types_.metadatainput.md)* -*Defined in [api/types.ts:3836](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3836)* +*Defined in [api/types.ts:3836](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3836)* ___ @@ -33,7 +33,7 @@ ___ **● SourceIdentification**: *[SourceIdentification](_api_types_.sourceidentification.md)* -*Defined in [api/types.ts:3834](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3834)* +*Defined in [api/types.ts:3834](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3834)* ___ @@ -42,7 +42,7 @@ ___ **● VideoInput**: *[VideoEncoderConfiguration](_api_types_.videoencoderconfiguration.md)* -*Defined in [api/types.ts:3835](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3835)* +*Defined in [api/types.ts:3835](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3835)* ___ diff --git a/docs/interfaces/_api_types_.analyticsengineinputinfo.md b/docs/interfaces/_api_types_.analyticsengineinputinfo.md index acbfc89..1ec1834 100644 --- a/docs/interfaces/_api_types_.analyticsengineinputinfo.md +++ b/docs/interfaces/_api_types_.analyticsengineinputinfo.md @@ -19,20 +19,20 @@ -### Extension +### `` Extension **● Extension**: *[AnalyticsEngineInputInfoExtension](_api_types_.analyticsengineinputinfoextension.md)* -*Defined in [api/types.ts:3821](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3821)* +*Defined in [api/types.ts:3821](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3821)* ___ -### InputInfo +### `` InputInfo **● InputInfo**: *[Config](_api_types_.config.md)* -*Defined in [api/types.ts:3820](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3820)* +*Defined in [api/types.ts:3820](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3820)* ___ diff --git a/docs/interfaces/_api_types_.analyticsstate.md b/docs/interfaces/_api_types_.analyticsstate.md index cdf612d..0e3aee7 100644 --- a/docs/interfaces/_api_types_.analyticsstate.md +++ b/docs/interfaces/_api_types_.analyticsstate.md @@ -19,11 +19,11 @@ -### Error +### `` Error -**● Error**: *`string`* +**● Error**: *`undefined` \| `string`* -*Defined in [api/types.ts:3893](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3893)* +*Defined in [api/types.ts:3893](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3893)* ___ @@ -32,7 +32,7 @@ ___ **● State**: *`string`* -*Defined in [api/types.ts:3894](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3894)* +*Defined in [api/types.ts:3894](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3894)* ___ diff --git a/docs/interfaces/_api_types_.analyticsstateinformation.md b/docs/interfaces/_api_types_.analyticsstateinformation.md index 1e3c528..eaa8f24 100644 --- a/docs/interfaces/_api_types_.analyticsstateinformation.md +++ b/docs/interfaces/_api_types_.analyticsstateinformation.md @@ -25,7 +25,7 @@ Token of the control object whose status is requested. **● AnalyticsEngineControlToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3885](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3885)* +*Defined in [api/types.ts:3885](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3885)* ___ @@ -34,7 +34,7 @@ ___ **● State**: *[AnalyticsState](_api_types_.analyticsstate.md)* -*Defined in [api/types.ts:3886](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3886)* +*Defined in [api/types.ts:3886](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3886)* ___ diff --git a/docs/interfaces/_api_types_.arrayoffileprogress.md b/docs/interfaces/_api_types_.arrayoffileprogress.md index 9fd32e0..38f0f70 100644 --- a/docs/interfaces/_api_types_.arrayoffileprogress.md +++ b/docs/interfaces/_api_types_.arrayoffileprogress.md @@ -21,20 +21,20 @@ Exported file name and export progress information -### Extension +### `` Extension **● Extension**: *[ArrayOfFileProgressExtension](_api_types_.arrayoffileprogressextension.md)* -*Defined in [api/types.ts:4156](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4156)* +*Defined in [api/types.ts:4156](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4156)* ___ -### FileProgress +### `` FileProgress -**● FileProgress**: *[FileProgress](_api_types_.fileprogress.md)* +**● FileProgress**: *[FileProgress](_api_types_.arrayoffileprogress.md#fileprogress)* -*Defined in [api/types.ts:4155](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4155)* +*Defined in [api/types.ts:4155](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4155)* ___ diff --git a/docs/interfaces/_api_types_.audioattributes.md b/docs/interfaces/_api_types_.audioattributes.md index 7ece420..520e83e 100644 --- a/docs/interfaces/_api_types_.audioattributes.md +++ b/docs/interfaces/_api_types_.audioattributes.md @@ -22,11 +22,11 @@ The bitrate in kbps. -### Bitrate +### `` Bitrate -**● Bitrate**: *`number`* +**● Bitrate**: *`undefined` \| `number`* -*Defined in [api/types.ts:3625](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3625)* +*Defined in [api/types.ts:3625](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3625)* ___ @@ -35,7 +35,7 @@ ___ **● Encoding**: *`string`* -*Defined in [api/types.ts:3626](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3626)* +*Defined in [api/types.ts:3626](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3626)* ___ @@ -44,7 +44,7 @@ ___ **● Samplerate**: *`number`* -*Defined in [api/types.ts:3627](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3627)* +*Defined in [api/types.ts:3627](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3627)* ___ diff --git a/docs/interfaces/_api_types_.audioclasscandidate.md b/docs/interfaces/_api_types_.audioclasscandidate.md index 8c69928..941582b 100644 --- a/docs/interfaces/_api_types_.audioclasscandidate.md +++ b/docs/interfaces/_api_types_.audioclasscandidate.md @@ -25,7 +25,7 @@ Indicates audio class label **● Likelihood**: *`number`* -*Defined in [api/types.ts:3918](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3918)* +*Defined in [api/types.ts:3918](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3918)* ___ @@ -34,7 +34,7 @@ ___ **● Type**: *[AudioClassType](../modules/_api_types_.md#audioclasstype)* -*Defined in [api/types.ts:3917](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3917)* +*Defined in [api/types.ts:3917](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3917)* ___ diff --git a/docs/interfaces/_api_types_.audioclassdescriptor.md b/docs/interfaces/_api_types_.audioclassdescriptor.md index c91888a..0877473 100644 --- a/docs/interfaces/_api_types_.audioclassdescriptor.md +++ b/docs/interfaces/_api_types_.audioclassdescriptor.md @@ -21,20 +21,20 @@ Array of audio class label and class probability -### ClassCandidate +### `` ClassCandidate **● ClassCandidate**: *[AudioClassCandidate](_api_types_.audioclasscandidate.md)* -*Defined in [api/types.ts:3925](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3925)* +*Defined in [api/types.ts:3925](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3925)* ___ -### Extension +### `` Extension **● Extension**: *[AudioClassDescriptorExtension](_api_types_.audioclassdescriptorextension.md)* -*Defined in [api/types.ts:3926](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3926)* +*Defined in [api/types.ts:3926](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3926)* ___ diff --git a/docs/interfaces/_api_types_.audiodecoderconfigurationoptions.md b/docs/interfaces/_api_types_.audiodecoderconfigurationoptions.md index cb30dce..9d8d55c 100644 --- a/docs/interfaces/_api_types_.audiodecoderconfigurationoptions.md +++ b/docs/interfaces/_api_types_.audiodecoderconfigurationoptions.md @@ -23,38 +23,38 @@ If the device is able to decode AAC encoded audio this section describes the sup -### AACDecOptions +### `` AACDecOptions -**● AACDecOptions**: *[AACDecOptions](_api_types_.aacdecoptions.md)* +**● AACDecOptions**: *[AACDecOptions](_api_types_.audiodecoderconfigurationoptions.md#aacdecoptions)* -*Defined in [api/types.ts:944](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L944)* +*Defined in [api/types.ts:944](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L944)* ___ -### Extension +### `` Extension **● Extension**: *[AudioDecoderConfigurationOptionsExtension](_api_types_.audiodecoderconfigurationoptionsextension.md)* -*Defined in [api/types.ts:947](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L947)* +*Defined in [api/types.ts:947](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L947)* ___ -### G711DecOptions +### `` G711DecOptions -**● G711DecOptions**: *[G711DecOptions](_api_types_.g711decoptions.md)* +**● G711DecOptions**: *[G711DecOptions](_api_types_.audiodecoderconfigurationoptions.md#g711decoptions)* -*Defined in [api/types.ts:945](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L945)* +*Defined in [api/types.ts:945](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L945)* ___ -### G726DecOptions +### `` G726DecOptions -**● G726DecOptions**: *[G726DecOptions](_api_types_.g726decoptions.md)* +**● G726DecOptions**: *[G726DecOptions](_api_types_.audiodecoderconfigurationoptions.md#g726decoptions)* -*Defined in [api/types.ts:946](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L946)* +*Defined in [api/types.ts:946](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L946)* ___ diff --git a/docs/interfaces/_api_types_.audioencoder2configuration.md b/docs/interfaces/_api_types_.audioencoder2configuration.md index 34e2ff6..1dcec8d 100644 --- a/docs/interfaces/_api_types_.audioencoder2configuration.md +++ b/docs/interfaces/_api_types_.audioencoder2configuration.md @@ -27,7 +27,7 @@ Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMi **● Bitrate**: *`number`* -*Defined in [api/types.ts:739](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L739)* +*Defined in [api/types.ts:739](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L739)* ___ @@ -36,16 +36,16 @@ ___ **● Encoding**: *`string`* -*Defined in [api/types.ts:737](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L737)* +*Defined in [api/types.ts:737](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L737)* ___ -### Multicast +### `` Multicast **● Multicast**: *[MulticastConfiguration](_api_types_.multicastconfiguration.md)* -*Defined in [api/types.ts:738](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L738)* +*Defined in [api/types.ts:738](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L738)* ___ @@ -54,7 +54,7 @@ ___ **● SampleRate**: *`number`* -*Defined in [api/types.ts:740](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L740)* +*Defined in [api/types.ts:740](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L740)* ___ diff --git a/docs/interfaces/_api_types_.audioencoder2configurationoptions.md b/docs/interfaces/_api_types_.audioencoder2configurationoptions.md index 86fee69..ce29838 100644 --- a/docs/interfaces/_api_types_.audioencoder2configurationoptions.md +++ b/docs/interfaces/_api_types_.audioencoder2configurationoptions.md @@ -26,7 +26,7 @@ Audio Media Subtype for the audio format. For definitions see tt:AudioEncodingMi **● BitrateList**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:748](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L748)* +*Defined in [api/types.ts:748](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L748)* ___ @@ -35,7 +35,7 @@ ___ **● Encoding**: *`string`* -*Defined in [api/types.ts:747](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L747)* +*Defined in [api/types.ts:747](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L747)* ___ @@ -44,7 +44,7 @@ ___ **● SampleRateList**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:749](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L749)* +*Defined in [api/types.ts:749](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L749)* ___ diff --git a/docs/interfaces/_api_types_.audioencoderconfiguration.md b/docs/interfaces/_api_types_.audioencoderconfiguration.md index eabcf0f..5a07cfc 100644 --- a/docs/interfaces/_api_types_.audioencoderconfiguration.md +++ b/docs/interfaces/_api_types_.audioencoderconfiguration.md @@ -28,7 +28,7 @@ Audio codec used for encoding the audio input (either G.711, G.726 or AAC) **● Bitrate**: *`number`* -*Defined in [api/types.ts:711](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L711)* +*Defined in [api/types.ts:711](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L711)* ___ @@ -37,7 +37,7 @@ ___ **● Encoding**: *[AudioEncoding](../enums/_api_types_.audioencoding.md)* -*Defined in [api/types.ts:710](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L710)* +*Defined in [api/types.ts:710](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L710)* ___ @@ -46,7 +46,7 @@ ___ **● Multicast**: *[MulticastConfiguration](_api_types_.multicastconfiguration.md)* -*Defined in [api/types.ts:713](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L713)* +*Defined in [api/types.ts:713](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L713)* ___ @@ -55,7 +55,7 @@ ___ **● SampleRate**: *`number`* -*Defined in [api/types.ts:712](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L712)* +*Defined in [api/types.ts:712](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L712)* ___ @@ -64,7 +64,7 @@ ___ **● SessionTimeout**: *`string`* -*Defined in [api/types.ts:714](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L714)* +*Defined in [api/types.ts:714](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L714)* ___ diff --git a/docs/interfaces/_api_types_.audioencoderconfigurationoption.md b/docs/interfaces/_api_types_.audioencoderconfigurationoption.md index 76558a8..4db0fe9 100644 --- a/docs/interfaces/_api_types_.audioencoderconfigurationoption.md +++ b/docs/interfaces/_api_types_.audioencoderconfigurationoption.md @@ -26,7 +26,7 @@ The enoding used for audio data (either G.711, G.726 or AAC) **● BitrateList**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:729](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L729)* +*Defined in [api/types.ts:729](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L729)* ___ @@ -35,7 +35,7 @@ ___ **● Encoding**: *[AudioEncoding](../enums/_api_types_.audioencoding.md)* -*Defined in [api/types.ts:728](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L728)* +*Defined in [api/types.ts:728](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L728)* ___ @@ -44,7 +44,7 @@ ___ **● SampleRateList**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:730](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L730)* +*Defined in [api/types.ts:730](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L730)* ___ diff --git a/docs/interfaces/_api_types_.audioencoderconfigurationoptions.md b/docs/interfaces/_api_types_.audioencoderconfigurationoptions.md index 6566ad4..b37914c 100644 --- a/docs/interfaces/_api_types_.audioencoderconfigurationoptions.md +++ b/docs/interfaces/_api_types_.audioencoderconfigurationoptions.md @@ -20,11 +20,11 @@ list of supported AudioEncoderConfigurations -### Options +### `` Options **● Options**: *[AudioEncoderConfigurationOption](_api_types_.audioencoderconfigurationoption.md)* -*Defined in [api/types.ts:721](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L721)* +*Defined in [api/types.ts:721](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L721)* ___ diff --git a/docs/interfaces/_api_types_.audiooutputconfiguration.md b/docs/interfaces/_api_types_.audiooutputconfiguration.md index d570fe4..08ea181 100644 --- a/docs/interfaces/_api_types_.audiooutputconfiguration.md +++ b/docs/interfaces/_api_types_.audiooutputconfiguration.md @@ -26,7 +26,7 @@ Token of the phsycial Audio output. **● OutputLevel**: *`number`* -*Defined in [api/types.ts:921](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L921)* +*Defined in [api/types.ts:921](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L921)* ___ @@ -35,16 +35,16 @@ ___ **● OutputToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:919](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L919)* +*Defined in [api/types.ts:919](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L919)* ___ -### SendPrimacy +### `` SendPrimacy -**● SendPrimacy**: *`string`* +**● SendPrimacy**: *`undefined` \| `string`* -*Defined in [api/types.ts:920](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L920)* +*Defined in [api/types.ts:920](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L920)* ___ diff --git a/docs/interfaces/_api_types_.audiooutputconfigurationoptions.md b/docs/interfaces/_api_types_.audiooutputconfigurationoptions.md index 2ef47d9..4c31b78 100644 --- a/docs/interfaces/_api_types_.audiooutputconfigurationoptions.md +++ b/docs/interfaces/_api_types_.audiooutputconfigurationoptions.md @@ -26,7 +26,7 @@ Tokens of the physical Audio outputs (typically one). **● OutputLevelRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:930](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L930)* +*Defined in [api/types.ts:930](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L930)* ___ @@ -35,16 +35,16 @@ ___ **● OutputTokensAvailable**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:928](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L928)* +*Defined in [api/types.ts:928](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L928)* ___ -### SendPrimacyOptions +### `` SendPrimacyOptions -**● SendPrimacyOptions**: *`string`* +**● SendPrimacyOptions**: *`undefined` \| `string`* -*Defined in [api/types.ts:929](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L929)* +*Defined in [api/types.ts:929](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L929)* ___ diff --git a/docs/interfaces/_api_types_.audiosource.md b/docs/interfaces/_api_types_.audiosource.md index d761d89..0d7ceed 100644 --- a/docs/interfaces/_api_types_.audiosource.md +++ b/docs/interfaces/_api_types_.audiosource.md @@ -24,7 +24,7 @@ Representation of a physical audio input. **● Channels**: *`number`* -*Defined in [api/types.ts:350](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L350)* +*Defined in [api/types.ts:350](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L350)* ___ diff --git a/docs/interfaces/_api_types_.audiosourceconfiguration.md b/docs/interfaces/_api_types_.audiosourceconfiguration.md index 9623d33..6abf65d 100644 --- a/docs/interfaces/_api_types_.audiosourceconfiguration.md +++ b/docs/interfaces/_api_types_.audiosourceconfiguration.md @@ -24,7 +24,7 @@ Token of the Audio Source the configuration applies to **● SourceToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:689](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L689)* +*Defined in [api/types.ts:689](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L689)* ___ diff --git a/docs/interfaces/_api_types_.audiosourceconfigurationoptions.md b/docs/interfaces/_api_types_.audiosourceconfigurationoptions.md index 7bcc7ac..67c9024 100644 --- a/docs/interfaces/_api_types_.audiosourceconfigurationoptions.md +++ b/docs/interfaces/_api_types_.audiosourceconfigurationoptions.md @@ -21,11 +21,11 @@ Tokens of the audio source the configuration can be used for. -### Extension +### `` Extension **● Extension**: *[AudioSourceOptionsExtension](_api_types_.audiosourceoptionsextension.md)* -*Defined in [api/types.ts:697](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L697)* +*Defined in [api/types.ts:697](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L697)* ___ @@ -34,7 +34,7 @@ ___ **● InputTokensAvailable**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:696](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L696)* +*Defined in [api/types.ts:696](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L696)* ___ diff --git a/docs/interfaces/_api_types_.backlightcompensation.md b/docs/interfaces/_api_types_.backlightcompensation.md index 5e7d6f3..b73510f 100644 --- a/docs/interfaces/_api_types_.backlightcompensation.md +++ b/docs/interfaces/_api_types_.backlightcompensation.md @@ -25,7 +25,7 @@ Backlight compensation mode (on/off). **● Level**: *`number`* -*Defined in [api/types.ts:2511](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2511)* +*Defined in [api/types.ts:2511](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2511)* ___ @@ -34,7 +34,7 @@ ___ **● Mode**: *[BacklightCompensationMode](../enums/_api_types_.backlightcompensationmode.md)* -*Defined in [api/types.ts:2510](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2510)* +*Defined in [api/types.ts:2510](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2510)* ___ diff --git a/docs/interfaces/_api_types_.backlightcompensation20.md b/docs/interfaces/_api_types_.backlightcompensation20.md index d0f400f..f02769d 100644 --- a/docs/interfaces/_api_types_.backlightcompensation20.md +++ b/docs/interfaces/_api_types_.backlightcompensation20.md @@ -21,11 +21,11 @@ Type describing whether BLC mode is enabled or disabled (on/off). -### Level +### `` Level -**● Level**: *`number`* +**● Level**: *`undefined` \| `number`* -*Defined in [api/types.ts:2796](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2796)* +*Defined in [api/types.ts:2796](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2796)* ___ @@ -34,7 +34,7 @@ ___ **● Mode**: *[BacklightCompensationMode](../enums/_api_types_.backlightcompensationmode.md)* -*Defined in [api/types.ts:2795](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2795)* +*Defined in [api/types.ts:2795](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2795)* ___ diff --git a/docs/interfaces/_api_types_.backlightcompensationoptions.md b/docs/interfaces/_api_types_.backlightcompensationoptions.md index 7cef96b..9315310 100644 --- a/docs/interfaces/_api_types_.backlightcompensationoptions.md +++ b/docs/interfaces/_api_types_.backlightcompensationoptions.md @@ -23,7 +23,7 @@ **● Level**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2543](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2543)* +*Defined in [api/types.ts:2543](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2543)* ___ @@ -32,7 +32,7 @@ ___ **● Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* -*Defined in [api/types.ts:2542](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2542)* +*Defined in [api/types.ts:2542](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2542)* ___ diff --git a/docs/interfaces/_api_types_.backlightcompensationoptions20.md b/docs/interfaces/_api_types_.backlightcompensationoptions20.md index 663d53b..3f32ce2 100644 --- a/docs/interfaces/_api_types_.backlightcompensationoptions20.md +++ b/docs/interfaces/_api_types_.backlightcompensationoptions20.md @@ -23,11 +23,11 @@ -### Level +### `` Level **● Level**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2951](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2951)* +*Defined in [api/types.ts:2951](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2951)* ___ @@ -36,7 +36,7 @@ ___ **● Mode**: *[BacklightCompensationMode](../enums/_api_types_.backlightcompensationmode.md)* -*Defined in [api/types.ts:2950](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2950)* +*Defined in [api/types.ts:2950](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2950)* ___ diff --git a/docs/interfaces/_api_types_.backupfile.md b/docs/interfaces/_api_types_.backupfile.md index 26905a5..ac377e3 100644 --- a/docs/interfaces/_api_types_.backupfile.md +++ b/docs/interfaces/_api_types_.backupfile.md @@ -23,7 +23,7 @@ **● Data**: *[AttachmentData](_api_types_.attachmentdata.md)* -*Defined in [api/types.ts:1785](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1785)* +*Defined in [api/types.ts:1785](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1785)* ___ @@ -32,7 +32,7 @@ ___ **● Name**: *`string`* -*Defined in [api/types.ts:1784](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1784)* +*Defined in [api/types.ts:1784](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1784)* ___ diff --git a/docs/interfaces/_api_types_.binarydata.md b/docs/interfaces/_api_types_.binarydata.md index 12a72b1..9e1b3cc 100644 --- a/docs/interfaces/_api_types_.binarydata.md +++ b/docs/interfaces/_api_types_.binarydata.md @@ -24,7 +24,7 @@ base64 encoded binary data. **● Data**: *`string`* -*Defined in [api/types.ts:1771](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1771)* +*Defined in [api/types.ts:1771](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1771)* ___ diff --git a/docs/interfaces/_api_types_.capabilities.md b/docs/interfaces/_api_types_.capabilities.md index 6d40b97..b988b83 100644 --- a/docs/interfaces/_api_types_.capabilities.md +++ b/docs/interfaces/_api_types_.capabilities.md @@ -26,65 +26,65 @@ Analytics capabilities -### Analytics +### `` Analytics **● Analytics**: *[AnalyticsCapabilities](_api_types_.analyticscapabilities.md)* -*Defined in [api/types.ts:1438](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1438)* +*Defined in [api/types.ts:1438](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1438)* ___ -### Device +### `` Device **● Device**: *[DeviceCapabilities](_api_types_.devicecapabilities.md)* -*Defined in [api/types.ts:1439](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1439)* +*Defined in [api/types.ts:1439](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1439)* ___ -### Events +### `` Events **● Events**: *[EventCapabilities](_api_types_.eventcapabilities.md)* -*Defined in [api/types.ts:1440](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1440)* +*Defined in [api/types.ts:1440](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1440)* ___ -### Extension +### `` Extension **● Extension**: *[CapabilitiesExtension](_api_types_.capabilitiesextension.md)* -*Defined in [api/types.ts:1444](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1444)* +*Defined in [api/types.ts:1444](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1444)* ___ -### Imaging +### `` Imaging **● Imaging**: *[ImagingCapabilities](_api_types_.imagingcapabilities.md)* -*Defined in [api/types.ts:1441](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1441)* +*Defined in [api/types.ts:1441](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1441)* ___ -### Media +### `` Media **● Media**: *[MediaCapabilities](_api_types_.mediacapabilities.md)* -*Defined in [api/types.ts:1442](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1442)* +*Defined in [api/types.ts:1442](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1442)* ___ -### PTZ +### `` PTZ **● PTZ**: *[PTZCapabilities](_api_types_.ptzcapabilities.md)* -*Defined in [api/types.ts:1443](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1443)* +*Defined in [api/types.ts:1443](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1443)* ___ diff --git a/docs/interfaces/_api_types_.capabilitiesextension.md b/docs/interfaces/_api_types_.capabilitiesextension.md index 1ca78bb..bb5da95 100644 --- a/docs/interfaces/_api_types_.capabilitiesextension.md +++ b/docs/interfaces/_api_types_.capabilitiesextension.md @@ -25,74 +25,74 @@ -### AnalyticsDevice +### `` AnalyticsDevice **● AnalyticsDevice**: *[AnalyticsDeviceCapabilities](_api_types_.analyticsdevicecapabilities.md)* -*Defined in [api/types.ts:1457](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1457)* +*Defined in [api/types.ts:1457](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1457)* ___ -### DeviceIO +### `` DeviceIO **● DeviceIO**: *[DeviceIOCapabilities](_api_types_.deviceiocapabilities.md)* -*Defined in [api/types.ts:1451](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1451)* +*Defined in [api/types.ts:1451](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1451)* ___ -### Display +### `` Display **● Display**: *[DisplayCapabilities](_api_types_.displaycapabilities.md)* -*Defined in [api/types.ts:1452](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1452)* +*Defined in [api/types.ts:1452](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1452)* ___ -### Extensions +### `` Extensions **● Extensions**: *[CapabilitiesExtension2](_api_types_.capabilitiesextension2.md)* -*Defined in [api/types.ts:1458](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1458)* +*Defined in [api/types.ts:1458](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1458)* ___ -### Receiver +### `` Receiver **● Receiver**: *[ReceiverCapabilities](_api_types_.receivercapabilities.md)* -*Defined in [api/types.ts:1456](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1456)* +*Defined in [api/types.ts:1456](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1456)* ___ -### Recording +### `` Recording **● Recording**: *[RecordingCapabilities](_api_types_.recordingcapabilities.md)* -*Defined in [api/types.ts:1453](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1453)* +*Defined in [api/types.ts:1453](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1453)* ___ -### Replay +### `` Replay **● Replay**: *[ReplayCapabilities](_api_types_.replaycapabilities.md)* -*Defined in [api/types.ts:1455](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1455)* +*Defined in [api/types.ts:1455](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1455)* ___ -### Search +### `` Search **● Search**: *[SearchCapabilities](_api_types_.searchcapabilities.md)* -*Defined in [api/types.ts:1454](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1454)* +*Defined in [api/types.ts:1454](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1454)* ___ diff --git a/docs/interfaces/_api_types_.celllayout.md b/docs/interfaces/_api_types_.celllayout.md index 8dca7aa..7d13cc0 100644 --- a/docs/interfaces/_api_types_.celllayout.md +++ b/docs/interfaces/_api_types_.celllayout.md @@ -24,7 +24,7 @@ Mapping of the cell grid to the Video frame. The cell grid is starting from the **● Transformation**: *[Transformation](_api_types_.transformation.md)* -*Defined in [api/types.ts:3312](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3312)* +*Defined in [api/types.ts:3312](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3312)* ___ diff --git a/docs/interfaces/_api_types_.certificate.md b/docs/interfaces/_api_types_.certificate.md index c09a7a3..2dcb7d8 100644 --- a/docs/interfaces/_api_types_.certificate.md +++ b/docs/interfaces/_api_types_.certificate.md @@ -25,7 +25,7 @@ Certificate id. **● Certificate**: *[BinaryData](_api_types_.binarydata.md)* -*Defined in [api/types.ts:1912](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1912)* +*Defined in [api/types.ts:1912](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1912)* ___ @@ -34,7 +34,7 @@ ___ **● CertificateID**: *`string`* -*Defined in [api/types.ts:1911](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1911)* +*Defined in [api/types.ts:1911](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1911)* ___ diff --git a/docs/interfaces/_api_types_.certificategenerationparameters.md b/docs/interfaces/_api_types_.certificategenerationparameters.md index 4e942ec..28eaca5 100644 --- a/docs/interfaces/_api_types_.certificategenerationparameters.md +++ b/docs/interfaces/_api_types_.certificategenerationparameters.md @@ -22,47 +22,47 @@ -### CertificateID +### `` CertificateID -**● CertificateID**: *`string`* +**● CertificateID**: *`undefined` \| `string`* -*Defined in [api/types.ts:1894](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1894)* +*Defined in [api/types.ts:1894](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1894)* ___ -### Extension +### `` Extension **● Extension**: *[CertificateGenerationParametersExtension](_api_types_.certificategenerationparametersextension.md)* -*Defined in [api/types.ts:1898](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1898)* +*Defined in [api/types.ts:1898](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1898)* ___ -### Subject +### `` Subject -**● Subject**: *`string`* +**● Subject**: *`undefined` \| `string`* -*Defined in [api/types.ts:1895](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1895)* +*Defined in [api/types.ts:1895](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1895)* ___ -### ValidNotAfter +### `` ValidNotAfter -**● ValidNotAfter**: *`string`* +**● ValidNotAfter**: *`undefined` \| `string`* -*Defined in [api/types.ts:1897](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1897)* +*Defined in [api/types.ts:1897](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1897)* ___ -### ValidNotBefore +### `` ValidNotBefore -**● ValidNotBefore**: *`string`* +**● ValidNotBefore**: *`undefined` \| `string`* -*Defined in [api/types.ts:1896](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1896)* +*Defined in [api/types.ts:1896](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1896)* ___ diff --git a/docs/interfaces/_api_types_.certificateinformation.md b/docs/interfaces/_api_types_.certificateinformation.md index 2174e3e..01b520a 100644 --- a/docs/interfaces/_api_types_.certificateinformation.md +++ b/docs/interfaces/_api_types_.certificateinformation.md @@ -34,97 +34,97 @@ Validity Range is from "NotBefore" to "NotAfter"; the corresponding DateTimeRang **● CertificateID**: *`string`* -*Defined in [api/types.ts:1936](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1936)* +*Defined in [api/types.ts:1936](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1936)* ___ -### ExtendedKeyUsage +### `` ExtendedKeyUsage **● ExtendedKeyUsage**: *[CertificateUsage](_api_types_.certificateusage.md)* -*Defined in [api/types.ts:1940](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1940)* +*Defined in [api/types.ts:1940](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1940)* ___ -### Extension +### `` Extension **● Extension**: *[CertificateInformationExtension](_api_types_.certificateinformationextension.md)* -*Defined in [api/types.ts:1946](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1946)* +*Defined in [api/types.ts:1946](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1946)* ___ -### IssuerDN +### `` IssuerDN -**● IssuerDN**: *`string`* +**● IssuerDN**: *`undefined` \| `string`* -*Defined in [api/types.ts:1937](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1937)* +*Defined in [api/types.ts:1937](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1937)* ___ -### KeyLength +### `` KeyLength -**● KeyLength**: *`number`* +**● KeyLength**: *`undefined` \| `number`* -*Defined in [api/types.ts:1941](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1941)* +*Defined in [api/types.ts:1941](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1941)* ___ -### KeyUsage +### `` KeyUsage **● KeyUsage**: *[CertificateUsage](_api_types_.certificateusage.md)* -*Defined in [api/types.ts:1939](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1939)* +*Defined in [api/types.ts:1939](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1939)* ___ -### SerialNum +### `` SerialNum -**● SerialNum**: *`string`* +**● SerialNum**: *`undefined` \| `string`* -*Defined in [api/types.ts:1943](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1943)* +*Defined in [api/types.ts:1943](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1943)* ___ -### SignatureAlgorithm +### `` SignatureAlgorithm -**● SignatureAlgorithm**: *`string`* +**● SignatureAlgorithm**: *`undefined` \| `string`* -*Defined in [api/types.ts:1944](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1944)* +*Defined in [api/types.ts:1944](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1944)* ___ -### SubjectDN +### `` SubjectDN -**● SubjectDN**: *`string`* +**● SubjectDN**: *`undefined` \| `string`* -*Defined in [api/types.ts:1938](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1938)* +*Defined in [api/types.ts:1938](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1938)* ___ -### Validity +### `` Validity **● Validity**: *[DateTimeRange](_api_types_.datetimerange.md)* -*Defined in [api/types.ts:1945](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1945)* +*Defined in [api/types.ts:1945](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1945)* ___ -### Version +### `` Version -**● Version**: *`string`* +**● Version**: *`undefined` \| `string`* -*Defined in [api/types.ts:1942](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1942)* +*Defined in [api/types.ts:1942](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1942)* ___ diff --git a/docs/interfaces/_api_types_.certificatestatus.md b/docs/interfaces/_api_types_.certificatestatus.md index e13376c..47c2d75 100644 --- a/docs/interfaces/_api_types_.certificatestatus.md +++ b/docs/interfaces/_api_types_.certificatestatus.md @@ -25,7 +25,7 @@ Certificate id. **● CertificateID**: *`string`* -*Defined in [api/types.ts:1919](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1919)* +*Defined in [api/types.ts:1919](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1919)* ___ @@ -34,7 +34,7 @@ ___ **● Status**: *`boolean`* -*Defined in [api/types.ts:1920](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1920)* +*Defined in [api/types.ts:1920](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1920)* ___ diff --git a/docs/interfaces/_api_types_.certificatewithprivatekey.md b/docs/interfaces/_api_types_.certificatewithprivatekey.md index c68e22e..174d161 100644 --- a/docs/interfaces/_api_types_.certificatewithprivatekey.md +++ b/docs/interfaces/_api_types_.certificatewithprivatekey.md @@ -24,16 +24,16 @@ **● Certificate**: *[BinaryData](_api_types_.binarydata.md)* -*Defined in [api/types.ts:1928](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1928)* +*Defined in [api/types.ts:1928](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1928)* ___ -### CertificateID +### `` CertificateID -**● CertificateID**: *`string`* +**● CertificateID**: *`undefined` \| `string`* -*Defined in [api/types.ts:1927](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1927)* +*Defined in [api/types.ts:1927](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1927)* ___ @@ -42,7 +42,7 @@ ___ **● PrivateKey**: *[BinaryData](_api_types_.binarydata.md)* -*Defined in [api/types.ts:1929](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1929)* +*Defined in [api/types.ts:1929](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1929)* ___ diff --git a/docs/interfaces/_api_types_.codingcapabilities.md b/docs/interfaces/_api_types_.codingcapabilities.md index 4b0262e..c5ef2d8 100644 --- a/docs/interfaces/_api_types_.codingcapabilities.md +++ b/docs/interfaces/_api_types_.codingcapabilities.md @@ -22,20 +22,20 @@ This type contains the Audio and Video coding capabilities of a display service. -### AudioDecodingCapabilities +### `` AudioDecodingCapabilities **● AudioDecodingCapabilities**: *[AudioDecoderConfigurationOptions](_api_types_.audiodecoderconfigurationoptions.md)* -*Defined in [api/types.ts:3354](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3354)* +*Defined in [api/types.ts:3354](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3354)* ___ -### AudioEncodingCapabilities +### `` AudioEncodingCapabilities **● AudioEncodingCapabilities**: *[AudioEncoderConfigurationOptions](_api_types_.audioencoderconfigurationoptions.md)* -*Defined in [api/types.ts:3353](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3353)* +*Defined in [api/types.ts:3353](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3353)* ___ @@ -44,7 +44,7 @@ ___ **● VideoDecodingCapabilities**: *[VideoDecoderConfigurationOptions](_api_types_.videodecoderconfigurationoptions.md)* -*Defined in [api/types.ts:3355](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3355)* +*Defined in [api/types.ts:3355](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3355)* ___ diff --git a/docs/interfaces/_api_types_.coloroptions.md b/docs/interfaces/_api_types_.coloroptions.md index 145a57c..5df0cee 100644 --- a/docs/interfaces/_api_types_.coloroptions.md +++ b/docs/interfaces/_api_types_.coloroptions.md @@ -25,7 +25,7 @@ Describe the option of the color supported. Either list each color or define the **● ColorList**: *[Color](_api_types_.color.md)* -*Defined in [api/types.ts:4049](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4049)* +*Defined in [api/types.ts:4049](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4049)* ___ @@ -34,7 +34,7 @@ ___ **● ColorspaceRange**: *[ColorspaceRange](_api_types_.colorspacerange.md)* -*Defined in [api/types.ts:4050](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4050)* +*Defined in [api/types.ts:4050](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4050)* ___ diff --git a/docs/interfaces/_api_types_.colorspacerange.md b/docs/interfaces/_api_types_.colorspacerange.md index f653a03..1899b17 100644 --- a/docs/interfaces/_api_types_.colorspacerange.md +++ b/docs/interfaces/_api_types_.colorspacerange.md @@ -25,7 +25,7 @@ **● Colorspace**: *`string`* -*Defined in [api/types.ts:4038](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4038)* +*Defined in [api/types.ts:4038](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4038)* ___ @@ -34,7 +34,7 @@ ___ **● X**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:4035](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4035)* +*Defined in [api/types.ts:4035](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4035)* ___ @@ -43,7 +43,7 @@ ___ **● Y**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:4036](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4036)* +*Defined in [api/types.ts:4036](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4036)* ___ @@ -52,7 +52,7 @@ ___ **● Z**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:4037](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4037)* +*Defined in [api/types.ts:4037](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4037)* ___ diff --git a/docs/interfaces/_api_types_.config.md b/docs/interfaces/_api_types_.config.md index 201a62e..838e256 100644 --- a/docs/interfaces/_api_types_.config.md +++ b/docs/interfaces/_api_types_.config.md @@ -24,7 +24,7 @@ List of configuration parameters as defined in the correspding description. **● Parameters**: *[ItemList](_api_types_.itemlist.md)* -*Defined in [api/types.ts:3210](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3210)* +*Defined in [api/types.ts:3210](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3210)* ___ diff --git a/docs/interfaces/_api_types_.configdescription.md b/docs/interfaces/_api_types_.configdescription.md index d833623..a93034b 100644 --- a/docs/interfaces/_api_types_.configdescription.md +++ b/docs/interfaces/_api_types_.configdescription.md @@ -27,20 +27,20 @@ -### Extension +### `` Extension **● Extension**: *[ConfigDescriptionExtension](_api_types_.configdescriptionextension.md)* -*Defined in [api/types.ts:3224](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3224)* +*Defined in [api/types.ts:3224](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3224)* ___ -### Messages +### `` Messages **● Messages**: *`any`* -*Defined in [api/types.ts:3222](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3222)* +*Defined in [api/types.ts:3222](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3222)* ___ @@ -49,7 +49,7 @@ ___ **● Parameters**: *[ItemListDescription](_api_types_.itemlistdescription.md)* -*Defined in [api/types.ts:3221](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3221)* +*Defined in [api/types.ts:3221](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3221)* ___ @@ -58,7 +58,7 @@ ___ **● ParentTopic**: *`string`* -*Defined in [api/types.ts:3223](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3223)* +*Defined in [api/types.ts:3223](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3223)* ___ diff --git a/docs/interfaces/_api_types_.configurationentity.md b/docs/interfaces/_api_types_.configurationentity.md index f0336cd..a030bca 100644 --- a/docs/interfaces/_api_types_.configurationentity.md +++ b/docs/interfaces/_api_types_.configurationentity.md @@ -25,7 +25,7 @@ Base type defining the common properties of a configuration. **● Name**: *[Name](_api_types_.configurationentity.md#name)* -*Defined in [api/types.ts:396](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L396)* +*Defined in [api/types.ts:396](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L396)* ___ @@ -34,7 +34,7 @@ ___ **● UseCount**: *`number`* -*Defined in [api/types.ts:397](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L397)* +*Defined in [api/types.ts:397](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L397)* ___ diff --git a/docs/interfaces/_api_types_.continuousfocus.md b/docs/interfaces/_api_types_.continuousfocus.md index 83e305e..6d99c93 100644 --- a/docs/interfaces/_api_types_.continuousfocus.md +++ b/docs/interfaces/_api_types_.continuousfocus.md @@ -26,7 +26,7 @@ **● Speed**: *`number`* -*Defined in [api/types.ts:2619](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2619)* +*Defined in [api/types.ts:2619](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2619)* ___ diff --git a/docs/interfaces/_api_types_.continuousfocusoptions.md b/docs/interfaces/_api_types_.continuousfocusoptions.md index d9ed7c9..2c3c130 100644 --- a/docs/interfaces/_api_types_.continuousfocusoptions.md +++ b/docs/interfaces/_api_types_.continuousfocusoptions.md @@ -26,7 +26,7 @@ **● Speed**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2657](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2657)* +*Defined in [api/types.ts:2657](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2657)* ___ diff --git a/docs/interfaces/_api_types_.date.md b/docs/interfaces/_api_types_.date.md index df79403..5edfb06 100644 --- a/docs/interfaces/_api_types_.date.md +++ b/docs/interfaces/_api_types_.date.md @@ -26,7 +26,7 @@ Range is 1 to 12. **● Day**: *`number`* -*Defined in [api/types.ts:1835](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1835)* +*Defined in [api/types.ts:1835](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1835)* ___ @@ -35,7 +35,7 @@ ___ **● Month**: *`number`* -*Defined in [api/types.ts:1834](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1834)* +*Defined in [api/types.ts:1834](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1834)* ___ @@ -44,7 +44,7 @@ ___ **● Year**: *`number`* -*Defined in [api/types.ts:1833](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1833)* +*Defined in [api/types.ts:1833](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1833)* ___ diff --git a/docs/interfaces/_api_types_.datetime.md b/docs/interfaces/_api_types_.datetime.md index 5ce5ccb..ab6464f 100644 --- a/docs/interfaces/_api_types_.datetime.md +++ b/docs/interfaces/_api_types_.datetime.md @@ -23,7 +23,7 @@ **● Date**: *[Date](_api_types_.date.md)* -*Defined in [api/types.ts:1826](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1826)* +*Defined in [api/types.ts:1826](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1826)* ___ @@ -32,7 +32,7 @@ ___ **● Time**: *[Time](_api_types_.time.md)* -*Defined in [api/types.ts:1825](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1825)* +*Defined in [api/types.ts:1825](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1825)* ___ diff --git a/docs/interfaces/_api_types_.datetimerange.md b/docs/interfaces/_api_types_.datetimerange.md index da84be0..2dbe09d 100644 --- a/docs/interfaces/_api_types_.datetimerange.md +++ b/docs/interfaces/_api_types_.datetimerange.md @@ -23,7 +23,7 @@ **● From**: *`string`* -*Defined in [api/types.ts:3428](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3428)* +*Defined in [api/types.ts:3428](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3428)* ___ @@ -32,7 +32,7 @@ ___ **● Until**: *`string`* -*Defined in [api/types.ts:3429](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3429)* +*Defined in [api/types.ts:3429](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3429)* ___ diff --git a/docs/interfaces/_api_types_.defogging.md b/docs/interfaces/_api_types_.defogging.md index ae9a968..d44bb1f 100644 --- a/docs/interfaces/_api_types_.defogging.md +++ b/docs/interfaces/_api_types_.defogging.md @@ -22,20 +22,20 @@ Parameter to enable/disable or automatic Defogging feature. Its options shall be -### Extension +### `` Extension **● Extension**: *[DefoggingExtension](_api_types_.defoggingextension.md)* -*Defined in [api/types.ts:2838](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2838)* +*Defined in [api/types.ts:2838](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2838)* ___ -### Level +### `` Level -**● Level**: *`number`* +**● Level**: *`undefined` \| `number`* -*Defined in [api/types.ts:2837](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2837)* +*Defined in [api/types.ts:2837](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2837)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *`string`* -*Defined in [api/types.ts:2836](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2836)* +*Defined in [api/types.ts:2836](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2836)* ___ diff --git a/docs/interfaces/_api_types_.defoggingoptions.md b/docs/interfaces/_api_types_.defoggingoptions.md index f4a7d06..12942d0 100644 --- a/docs/interfaces/_api_types_.defoggingoptions.md +++ b/docs/interfaces/_api_types_.defoggingoptions.md @@ -25,7 +25,7 @@ Supported options for Defogging mode. Its options shall be chosen from tt:Defogg **● Level**: *`boolean`* -*Defined in [api/types.ts:3098](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3098)* +*Defined in [api/types.ts:3098](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3098)* ___ @@ -34,7 +34,7 @@ ___ **● Mode**: *`string`* -*Defined in [api/types.ts:3097](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3097)* +*Defined in [api/types.ts:3097](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3097)* ___ diff --git a/docs/interfaces/_api_types_.devicecapabilities.md b/docs/interfaces/_api_types_.devicecapabilities.md index 30a36bc..14f8b8a 100644 --- a/docs/interfaces/_api_types_.devicecapabilities.md +++ b/docs/interfaces/_api_types_.devicecapabilities.md @@ -25,47 +25,47 @@ Device service URI. -### Extension +### `` Extension **● Extension**: *[DeviceCapabilitiesExtension](_api_types_.devicecapabilitiesextension.md)* -*Defined in [api/types.ts:1485](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1485)* +*Defined in [api/types.ts:1485](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1485)* ___ -### IO +### `` IO **● IO**: *[IOCapabilities](_api_types_.iocapabilities.md)* -*Defined in [api/types.ts:1483](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1483)* +*Defined in [api/types.ts:1483](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1483)* ___ -### Network +### `` Network **● Network**: *[NetworkCapabilities](_api_types_.networkcapabilities.md)* -*Defined in [api/types.ts:1481](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1481)* +*Defined in [api/types.ts:1481](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1481)* ___ -### Security +### `` Security **● Security**: *[SecurityCapabilities](_api_types_.securitycapabilities.md)* -*Defined in [api/types.ts:1484](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1484)* +*Defined in [api/types.ts:1484](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1484)* ___ -### System +### `` System **● System**: *[SystemCapabilities](_api_types_.systemcapabilities.md)* -*Defined in [api/types.ts:1482](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1482)* +*Defined in [api/types.ts:1482](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1482)* ___ @@ -74,7 +74,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1480](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1480)* +*Defined in [api/types.ts:1480](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1480)* ___ diff --git a/docs/interfaces/_api_types_.deviceiocapabilities.md b/docs/interfaces/_api_types_.deviceiocapabilities.md index b177e0e..b2efe58 100644 --- a/docs/interfaces/_api_types_.deviceiocapabilities.md +++ b/docs/interfaces/_api_types_.deviceiocapabilities.md @@ -27,7 +27,7 @@ **● AudioOutputs**: *`number`* -*Defined in [api/types.ts:1685](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1685)* +*Defined in [api/types.ts:1685](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1685)* ___ @@ -36,7 +36,7 @@ ___ **● AudioSources**: *`number`* -*Defined in [api/types.ts:1684](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1684)* +*Defined in [api/types.ts:1684](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1684)* ___ @@ -45,7 +45,7 @@ ___ **● RelayOutputs**: *`number`* -*Defined in [api/types.ts:1686](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1686)* +*Defined in [api/types.ts:1686](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1686)* ___ @@ -54,7 +54,7 @@ ___ **● VideoOutputs**: *`number`* -*Defined in [api/types.ts:1683](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1683)* +*Defined in [api/types.ts:1683](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1683)* ___ @@ -63,7 +63,7 @@ ___ **● VideoSources**: *`number`* -*Defined in [api/types.ts:1682](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1682)* +*Defined in [api/types.ts:1682](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1682)* ___ @@ -72,7 +72,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1681](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1681)* +*Defined in [api/types.ts:1681](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1681)* ___ diff --git a/docs/interfaces/_api_types_.displaycapabilities.md b/docs/interfaces/_api_types_.displaycapabilities.md index 5624297..8f6b14b 100644 --- a/docs/interfaces/_api_types_.displaycapabilities.md +++ b/docs/interfaces/_api_types_.displaycapabilities.md @@ -25,7 +25,7 @@ Indication that the SetLayout command supports only predefined layouts. **● FixedLayout**: *`boolean`* -*Defined in [api/types.ts:1694](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1694)* +*Defined in [api/types.ts:1694](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1694)* ___ @@ -34,7 +34,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1693](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1693)* +*Defined in [api/types.ts:1693](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1693)* ___ diff --git a/docs/interfaces/_api_types_.dnsinformation.md b/docs/interfaces/_api_types_.dnsinformation.md index 8a92d25..a3e3693 100644 --- a/docs/interfaces/_api_types_.dnsinformation.md +++ b/docs/interfaces/_api_types_.dnsinformation.md @@ -24,29 +24,29 @@ Indicates whether or not DNS information is retrieved from DHCP. -### DNSFromDHCP +### `` DNSFromDHCP **● DNSFromDHCP**: *[IPAddress](_api_types_.ipaddress.md)* -*Defined in [api/types.ts:1209](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1209)* +*Defined in [api/types.ts:1209](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1209)* ___ -### DNSManual +### `` DNSManual **● DNSManual**: *[IPAddress](_api_types_.ipaddress.md)* -*Defined in [api/types.ts:1210](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1210)* +*Defined in [api/types.ts:1210](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1210)* ___ -### Extension +### `` Extension **● Extension**: *[DNSInformationExtension](_api_types_.dnsinformationextension.md)* -*Defined in [api/types.ts:1211](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1211)* +*Defined in [api/types.ts:1211](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1211)* ___ @@ -55,16 +55,16 @@ ___ **● FromDHCP**: *`boolean`* -*Defined in [api/types.ts:1207](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1207)* +*Defined in [api/types.ts:1207](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1207)* ___ -### SearchDomain +### `` SearchDomain -**● SearchDomain**: *`string`* +**● SearchDomain**: *`undefined` \| `string`* -*Defined in [api/types.ts:1208](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1208)* +*Defined in [api/types.ts:1208](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1208)* ___ diff --git a/docs/interfaces/_api_types_.dot11availablenetworks.md b/docs/interfaces/_api_types_.dot11availablenetworks.md index 626e5ff..e6f823e 100644 --- a/docs/interfaces/_api_types_.dot11availablenetworks.md +++ b/docs/interfaces/_api_types_.dot11availablenetworks.md @@ -26,47 +26,47 @@ See IEEE802.11 7.3.2.25.2 for details. -### AuthAndMangementSuite +### `` AuthAndMangementSuite **● AuthAndMangementSuite**: *[Dot11AuthAndMangementSuite](../enums/_api_types_.dot11authandmangementsuite.md)* -*Defined in [api/types.ts:1421](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1421)* +*Defined in [api/types.ts:1421](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1421)* ___ -### BSSID +### `` BSSID -**● BSSID**: *`string`* +**● BSSID**: *`undefined` \| `string`* -*Defined in [api/types.ts:1420](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1420)* +*Defined in [api/types.ts:1420](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1420)* ___ -### Extension +### `` Extension **● Extension**: *[Dot11AvailableNetworksExtension](_api_types_.dot11availablenetworksextension.md)* -*Defined in [api/types.ts:1425](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1425)* +*Defined in [api/types.ts:1425](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1425)* ___ -### GroupCipher +### `` GroupCipher **● GroupCipher**: *[Dot11Cipher](../enums/_api_types_.dot11cipher.md)* -*Defined in [api/types.ts:1423](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1423)* +*Defined in [api/types.ts:1423](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1423)* ___ -### PairCipher +### `` PairCipher **● PairCipher**: *[Dot11Cipher](../enums/_api_types_.dot11cipher.md)* -*Defined in [api/types.ts:1422](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1422)* +*Defined in [api/types.ts:1422](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1422)* ___ @@ -75,16 +75,16 @@ ___ **● SSID**: *[Dot11SSIDType](../modules/_api_types_.md#dot11ssidtype)* -*Defined in [api/types.ts:1419](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1419)* +*Defined in [api/types.ts:1419](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1419)* ___ -### SignalStrength +### `` SignalStrength **● SignalStrength**: *[Dot11SignalStrength](../enums/_api_types_.dot11signalstrength.md)* -*Defined in [api/types.ts:1424](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1424)* +*Defined in [api/types.ts:1424](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1424)* ___ diff --git a/docs/interfaces/_api_types_.dot11capabilities.md b/docs/interfaces/_api_types_.dot11capabilities.md index a3c70af..ef45ca2 100644 --- a/docs/interfaces/_api_types_.dot11capabilities.md +++ b/docs/interfaces/_api_types_.dot11capabilities.md @@ -26,7 +26,7 @@ **● AdHocStationMode**: *`boolean`* -*Defined in [api/types.ts:1399](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1399)* +*Defined in [api/types.ts:1399](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1399)* ___ @@ -35,7 +35,7 @@ ___ **● MultipleConfiguration**: *`boolean`* -*Defined in [api/types.ts:1398](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1398)* +*Defined in [api/types.ts:1398](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1398)* ___ @@ -44,7 +44,7 @@ ___ **● ScanAvailableNetworks**: *`boolean`* -*Defined in [api/types.ts:1397](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1397)* +*Defined in [api/types.ts:1397](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1397)* ___ @@ -53,7 +53,7 @@ ___ **● TKIP**: *`boolean`* -*Defined in [api/types.ts:1396](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1396)* +*Defined in [api/types.ts:1396](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1396)* ___ @@ -62,7 +62,7 @@ ___ **● WEP**: *`boolean`* -*Defined in [api/types.ts:1400](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1400)* +*Defined in [api/types.ts:1400](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1400)* ___ diff --git a/docs/interfaces/_api_types_.dot11configuration.md b/docs/interfaces/_api_types_.dot11configuration.md index 9306418..864a5f8 100644 --- a/docs/interfaces/_api_types_.dot11configuration.md +++ b/docs/interfaces/_api_types_.dot11configuration.md @@ -26,7 +26,7 @@ **● Alias**: *[Name](../modules/_api_types_.md#name)* -*Defined in [api/types.ts:1346](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1346)* +*Defined in [api/types.ts:1346](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1346)* ___ @@ -35,7 +35,7 @@ ___ **● Mode**: *[Dot11StationMode](../enums/_api_types_.dot11stationmode.md)* -*Defined in [api/types.ts:1345](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1345)* +*Defined in [api/types.ts:1345](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1345)* ___ @@ -44,7 +44,7 @@ ___ **● Priority**: *[NetworkInterfaceConfigPriority](../modules/_api_types_.md#networkinterfaceconfigpriority)* -*Defined in [api/types.ts:1347](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1347)* +*Defined in [api/types.ts:1347](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1347)* ___ @@ -53,7 +53,7 @@ ___ **● SSID**: *[Dot11SSIDType](../modules/_api_types_.md#dot11ssidtype)* -*Defined in [api/types.ts:1344](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1344)* +*Defined in [api/types.ts:1344](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1344)* ___ @@ -62,7 +62,7 @@ ___ **● Security**: *[Dot11SecurityConfiguration](_api_types_.dot11securityconfiguration.md)* -*Defined in [api/types.ts:1348](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1348)* +*Defined in [api/types.ts:1348](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1348)* ___ diff --git a/docs/interfaces/_api_types_.dot11pskset.md b/docs/interfaces/_api_types_.dot11pskset.md index 2c0bb32..77a332d 100644 --- a/docs/interfaces/_api_types_.dot11pskset.md +++ b/docs/interfaces/_api_types_.dot11pskset.md @@ -25,29 +25,29 @@ -### Extension +### `` Extension **● Extension**: *[Dot11PSKSetExtension](_api_types_.dot11psksetextension.md)* -*Defined in [api/types.ts:1377](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1377)* +*Defined in [api/types.ts:1377](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1377)* ___ -### Key +### `` Key **● Key**: *[Dot11PSK](../modules/_api_types_.md#dot11psk)* -*Defined in [api/types.ts:1375](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1375)* +*Defined in [api/types.ts:1375](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1375)* ___ -### Passphrase +### `` Passphrase **● Passphrase**: *[Dot11PSKPassphrase](../modules/_api_types_.md#dot11pskpassphrase)* -*Defined in [api/types.ts:1376](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1376)* +*Defined in [api/types.ts:1376](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1376)* ___ diff --git a/docs/interfaces/_api_types_.dot11securityconfiguration.md b/docs/interfaces/_api_types_.dot11securityconfiguration.md index cd4d693..0ff7463 100644 --- a/docs/interfaces/_api_types_.dot11securityconfiguration.md +++ b/docs/interfaces/_api_types_.dot11securityconfiguration.md @@ -22,29 +22,29 @@ -### Algorithm +### `` Algorithm **● Algorithm**: *[Dot11Cipher](../enums/_api_types_.dot11cipher.md)* -*Defined in [api/types.ts:1356](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1356)* +*Defined in [api/types.ts:1356](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1356)* ___ -### Dot1X +### `` Dot1X **● Dot1X**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:1358](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1358)* +*Defined in [api/types.ts:1358](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1358)* ___ -### Extension +### `` Extension **● Extension**: *[Dot11SecurityConfigurationExtension](_api_types_.dot11securityconfigurationextension.md)* -*Defined in [api/types.ts:1359](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1359)* +*Defined in [api/types.ts:1359](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1359)* ___ @@ -53,16 +53,16 @@ ___ **● Mode**: *[Dot11SecurityMode](../enums/_api_types_.dot11securitymode.md)* -*Defined in [api/types.ts:1355](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1355)* +*Defined in [api/types.ts:1355](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1355)* ___ -### PSK +### `` PSK **● PSK**: *[Dot11PSKSet](_api_types_.dot11pskset.md)* -*Defined in [api/types.ts:1357](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1357)* +*Defined in [api/types.ts:1357](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1357)* ___ diff --git a/docs/interfaces/_api_types_.dot11status.md b/docs/interfaces/_api_types_.dot11status.md index f814ce3..4279be7 100644 --- a/docs/interfaces/_api_types_.dot11status.md +++ b/docs/interfaces/_api_types_.dot11status.md @@ -27,34 +27,34 @@ **● ActiveConfigAlias**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:1412](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1412)* +*Defined in [api/types.ts:1412](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1412)* ___ -### BSSID +### `` BSSID -**● BSSID**: *`string`* +**● BSSID**: *`undefined` \| `string`* -*Defined in [api/types.ts:1408](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1408)* +*Defined in [api/types.ts:1408](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1408)* ___ -### GroupCipher +### `` GroupCipher **● GroupCipher**: *[Dot11Cipher](../enums/_api_types_.dot11cipher.md)* -*Defined in [api/types.ts:1410](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1410)* +*Defined in [api/types.ts:1410](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1410)* ___ -### PairCipher +### `` PairCipher **● PairCipher**: *[Dot11Cipher](../enums/_api_types_.dot11cipher.md)* -*Defined in [api/types.ts:1409](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1409)* +*Defined in [api/types.ts:1409](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1409)* ___ @@ -63,16 +63,16 @@ ___ **● SSID**: *[Dot11SSIDType](../modules/_api_types_.md#dot11ssidtype)* -*Defined in [api/types.ts:1407](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1407)* +*Defined in [api/types.ts:1407](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1407)* ___ -### SignalStrength +### `` SignalStrength **● SignalStrength**: *[Dot11SignalStrength](../enums/_api_types_.dot11signalstrength.md)* -*Defined in [api/types.ts:1411](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1411)* +*Defined in [api/types.ts:1411](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1411)* ___ diff --git a/docs/interfaces/_api_types_.dot1xconfiguration.md b/docs/interfaces/_api_types_.dot1xconfiguration.md index b4ed949..ea289f2 100644 --- a/docs/interfaces/_api_types_.dot1xconfiguration.md +++ b/docs/interfaces/_api_types_.dot1xconfiguration.md @@ -28,20 +28,20 @@ -### AnonymousID +### `` AnonymousID -**● AnonymousID**: *`string`* +**● AnonymousID**: *`undefined` \| `string`* -*Defined in [api/types.ts:1969](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1969)* +*Defined in [api/types.ts:1969](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1969)* ___ -### CACertificateID +### `` CACertificateID -**● CACertificateID**: *`string`* +**● CACertificateID**: *`undefined` \| `string`* -*Defined in [api/types.ts:1971](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1971)* +*Defined in [api/types.ts:1971](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1971)* ___ @@ -50,7 +50,7 @@ ___ **● Dot1XConfigurationToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:1967](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1967)* +*Defined in [api/types.ts:1967](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1967)* ___ @@ -59,25 +59,25 @@ ___ **● EAPMethod**: *`number`* -*Defined in [api/types.ts:1970](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1970)* +*Defined in [api/types.ts:1970](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1970)* ___ -### EAPMethodConfiguration +### `` EAPMethodConfiguration -**● EAPMethodConfiguration**: *[EAPMethodConfiguration](_api_types_.eapmethodconfiguration.md)* +**● EAPMethodConfiguration**: *[EAPMethodConfiguration](_api_types_.dot1xconfiguration.md#eapmethodconfiguration)* -*Defined in [api/types.ts:1972](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1972)* +*Defined in [api/types.ts:1972](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1972)* ___ -### Extension +### `` Extension **● Extension**: *[Dot1XConfigurationExtension](_api_types_.dot1xconfigurationextension.md)* -*Defined in [api/types.ts:1973](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1973)* +*Defined in [api/types.ts:1973](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1973)* ___ @@ -86,7 +86,7 @@ ___ **● Identity**: *`string`* -*Defined in [api/types.ts:1968](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1968)* +*Defined in [api/types.ts:1968](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1968)* ___ diff --git a/docs/interfaces/_api_types_.durationrange.md b/docs/interfaces/_api_types_.durationrange.md index 5061d64..fbfa8bb 100644 --- a/docs/interfaces/_api_types_.durationrange.md +++ b/docs/interfaces/_api_types_.durationrange.md @@ -25,7 +25,7 @@ Range of duration greater equal Min duration and less equal Max duration. **● Max**: *`string`* -*Defined in [api/types.ts:299](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L299)* +*Defined in [api/types.ts:299](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L299)* ___ @@ -34,7 +34,7 @@ ___ **● Min**: *`string`* -*Defined in [api/types.ts:298](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L298)* +*Defined in [api/types.ts:298](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L298)* ___ diff --git a/docs/interfaces/_api_types_.dynamicdnsinformation.md b/docs/interfaces/_api_types_.dynamicdnsinformation.md index 5819bfd..4dc0d09 100644 --- a/docs/interfaces/_api_types_.dynamicdnsinformation.md +++ b/docs/interfaces/_api_types_.dynamicdnsinformation.md @@ -23,29 +23,29 @@ Dynamic DNS type. -### Extension +### `` Extension **● Extension**: *[DynamicDNSInformationExtension](_api_types_.dynamicdnsinformationextension.md)* -*Defined in [api/types.ts:1243](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1243)* +*Defined in [api/types.ts:1243](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1243)* ___ -### Name +### `` Name **● Name**: *[DNSName](../modules/_api_types_.md#dnsname)* -*Defined in [api/types.ts:1241](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1241)* +*Defined in [api/types.ts:1241](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1241)* ___ -### TTL +### `` TTL -**● TTL**: *`string`* +**● TTL**: *`undefined` \| `string`* -*Defined in [api/types.ts:1242](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1242)* +*Defined in [api/types.ts:1242](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1242)* ___ @@ -54,7 +54,7 @@ ___ **● Type**: *[DynamicDNSType](../enums/_api_types_.dynamicdnstype.md)* -*Defined in [api/types.ts:1240](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1240)* +*Defined in [api/types.ts:1240](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1240)* ___ diff --git a/docs/interfaces/_api_types_.eapmethodconfiguration.md b/docs/interfaces/_api_types_.eapmethodconfiguration.md index c4acf47..ddcfc2f 100644 --- a/docs/interfaces/_api_types_.eapmethodconfiguration.md +++ b/docs/interfaces/_api_types_.eapmethodconfiguration.md @@ -22,29 +22,29 @@ Confgiuration information for TLS Method. -### Extension +### `` Extension **● Extension**: *[EapMethodExtension](_api_types_.eapmethodextension.md)* -*Defined in [api/types.ts:1988](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1988)* +*Defined in [api/types.ts:1988](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1988)* ___ -### Password +### `` Password -**● Password**: *`string`* +**● Password**: *`undefined` \| `string`* -*Defined in [api/types.ts:1987](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1987)* +*Defined in [api/types.ts:1987](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1987)* ___ -### TLSConfiguration +### `` TLSConfiguration -**● TLSConfiguration**: *[TLSConfiguration](_api_types_.tlsconfiguration.md)* +**● TLSConfiguration**: *[TLSConfiguration](_api_types_.eapmethodconfiguration.md#tlsconfiguration)* -*Defined in [api/types.ts:1986](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1986)* +*Defined in [api/types.ts:1986](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1986)* ___ diff --git a/docs/interfaces/_api_types_.eflip.md b/docs/interfaces/_api_types_.eflip.md index 31a9c1e..a4396b9 100644 --- a/docs/interfaces/_api_types_.eflip.md +++ b/docs/interfaces/_api_types_.eflip.md @@ -24,7 +24,7 @@ Parameter to enable/disable E-Flip feature. **● Mode**: *[EFlipMode](../enums/_api_types_.eflipmode.md)* -*Defined in [api/types.ts:2138](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2138)* +*Defined in [api/types.ts:2138](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2138)* ___ diff --git a/docs/interfaces/_api_types_.eflipoptions.md b/docs/interfaces/_api_types_.eflipoptions.md index 9d5bc26..8349be9 100644 --- a/docs/interfaces/_api_types_.eflipoptions.md +++ b/docs/interfaces/_api_types_.eflipoptions.md @@ -21,20 +21,20 @@ Options of EFlip mode parameter. -### Extension +### `` Extension **● Extension**: *[EFlipOptionsExtension](_api_types_.eflipoptionsextension.md)* -*Defined in [api/types.ts:2186](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2186)* +*Defined in [api/types.ts:2186](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2186)* ___ -### Mode +### `` Mode **● Mode**: *[EFlipMode](../enums/_api_types_.eflipmode.md)* -*Defined in [api/types.ts:2185](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2185)* +*Defined in [api/types.ts:2185](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2185)* ___ diff --git a/docs/interfaces/_api_types_.engineconfiguration.md b/docs/interfaces/_api_types_.engineconfiguration.md index 7f47e14..4ff74a5 100644 --- a/docs/interfaces/_api_types_.engineconfiguration.md +++ b/docs/interfaces/_api_types_.engineconfiguration.md @@ -23,7 +23,7 @@ **● AnalyticsEngineInputInfo**: *[AnalyticsEngineInputInfo](_api_types_.analyticsengineinputinfo.md)* -*Defined in [api/types.ts:3813](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3813)* +*Defined in [api/types.ts:3813](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3813)* ___ @@ -32,7 +32,7 @@ ___ **● VideoAnalyticsConfiguration**: *[VideoAnalyticsConfiguration](_api_types_.videoanalyticsconfiguration.md)* -*Defined in [api/types.ts:3812](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3812)* +*Defined in [api/types.ts:3812](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3812)* ___ diff --git a/docs/interfaces/_api_types_.eventcapabilities.md b/docs/interfaces/_api_types_.eventcapabilities.md index 93db06d..36f7336 100644 --- a/docs/interfaces/_api_types_.eventcapabilities.md +++ b/docs/interfaces/_api_types_.eventcapabilities.md @@ -27,7 +27,7 @@ Event service URI. **● WSPausableSubscriptionManagerInterfaceSupport**: *`boolean`* -*Defined in [api/types.ts:1501](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1501)* +*Defined in [api/types.ts:1501](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1501)* ___ @@ -36,7 +36,7 @@ ___ **● WSPullPointSupport**: *`boolean`* -*Defined in [api/types.ts:1500](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1500)* +*Defined in [api/types.ts:1500](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1500)* ___ @@ -45,7 +45,7 @@ ___ **● WSSubscriptionPolicySupport**: *`boolean`* -*Defined in [api/types.ts:1499](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1499)* +*Defined in [api/types.ts:1499](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1499)* ___ @@ -54,7 +54,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1498](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1498)* +*Defined in [api/types.ts:1498](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1498)* ___ diff --git a/docs/interfaces/_api_types_.eventsubscription.md b/docs/interfaces/_api_types_.eventsubscription.md index f5a3463..013fbf6 100644 --- a/docs/interfaces/_api_types_.eventsubscription.md +++ b/docs/interfaces/_api_types_.eventsubscription.md @@ -21,20 +21,20 @@ Subcription handling in the same way as base notification subscription. -### Filter +### `` Filter **● Filter**: *`any`* -*Defined in [api/types.ts:791](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L791)* +*Defined in [api/types.ts:791](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L791)* ___ -### SubscriptionPolicy +### `` SubscriptionPolicy **● SubscriptionPolicy**: *`any`* -*Defined in [api/types.ts:792](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L792)* +*Defined in [api/types.ts:792](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L792)* ___ diff --git a/docs/interfaces/_api_types_.exposure.md b/docs/interfaces/_api_types_.exposure.md index b2e0ad5..2e17181 100644 --- a/docs/interfaces/_api_types_.exposure.md +++ b/docs/interfaces/_api_types_.exposure.md @@ -42,7 +42,7 @@ **● ExposureTime**: *`number`* -*Defined in [api/types.ts:2491](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2491)* +*Defined in [api/types.ts:2491](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2491)* ___ @@ -51,7 +51,7 @@ ___ **● Gain**: *`number`* -*Defined in [api/types.ts:2492](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2492)* +*Defined in [api/types.ts:2492](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2492)* ___ @@ -60,7 +60,7 @@ ___ **● Iris**: *`number`* -*Defined in [api/types.ts:2493](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2493)* +*Defined in [api/types.ts:2493](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2493)* ___ @@ -69,7 +69,7 @@ ___ **● MaxExposureTime**: *`number`* -*Defined in [api/types.ts:2486](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2486)* +*Defined in [api/types.ts:2486](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2486)* ___ @@ -78,7 +78,7 @@ ___ **● MaxGain**: *`number`* -*Defined in [api/types.ts:2488](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2488)* +*Defined in [api/types.ts:2488](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2488)* ___ @@ -87,7 +87,7 @@ ___ **● MaxIris**: *`number`* -*Defined in [api/types.ts:2490](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2490)* +*Defined in [api/types.ts:2490](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2490)* ___ @@ -96,7 +96,7 @@ ___ **● MinExposureTime**: *`number`* -*Defined in [api/types.ts:2485](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2485)* +*Defined in [api/types.ts:2485](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2485)* ___ @@ -105,7 +105,7 @@ ___ **● MinGain**: *`number`* -*Defined in [api/types.ts:2487](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2487)* +*Defined in [api/types.ts:2487](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2487)* ___ @@ -114,7 +114,7 @@ ___ **● MinIris**: *`number`* -*Defined in [api/types.ts:2489](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2489)* +*Defined in [api/types.ts:2489](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2489)* ___ @@ -123,7 +123,7 @@ ___ **● Mode**: *[ExposureMode](../enums/_api_types_.exposuremode.md)* -*Defined in [api/types.ts:2482](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2482)* +*Defined in [api/types.ts:2482](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2482)* ___ @@ -132,7 +132,7 @@ ___ **● Priority**: *[ExposurePriority](../enums/_api_types_.exposurepriority.md)* -*Defined in [api/types.ts:2483](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2483)* +*Defined in [api/types.ts:2483](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2483)* ___ @@ -141,7 +141,7 @@ ___ **● Window**: *[Rectangle](_api_types_.rectangle.md)* -*Defined in [api/types.ts:2484](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2484)* +*Defined in [api/types.ts:2484](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2484)* ___ diff --git a/docs/interfaces/_api_types_.exposure20.md b/docs/interfaces/_api_types_.exposure20.md index 7716a1e..1317f37 100644 --- a/docs/interfaces/_api_types_.exposure20.md +++ b/docs/interfaces/_api_types_.exposure20.md @@ -31,83 +31,83 @@ Type describing the exposure settings. -### ExposureTime +### `` ExposureTime -**● ExposureTime**: *`number`* +**● ExposureTime**: *`undefined` \| `number`* -*Defined in [api/types.ts:2812](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2812)* +*Defined in [api/types.ts:2812](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2812)* ___ -### Gain +### `` Gain -**● Gain**: *`number`* +**● Gain**: *`undefined` \| `number`* -*Defined in [api/types.ts:2813](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2813)* +*Defined in [api/types.ts:2813](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2813)* ___ -### Iris +### `` Iris -**● Iris**: *`number`* +**● Iris**: *`undefined` \| `number`* -*Defined in [api/types.ts:2814](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2814)* +*Defined in [api/types.ts:2814](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2814)* ___ -### MaxExposureTime +### `` MaxExposureTime -**● MaxExposureTime**: *`number`* +**● MaxExposureTime**: *`undefined` \| `number`* -*Defined in [api/types.ts:2807](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2807)* +*Defined in [api/types.ts:2807](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2807)* ___ -### MaxGain +### `` MaxGain -**● MaxGain**: *`number`* +**● MaxGain**: *`undefined` \| `number`* -*Defined in [api/types.ts:2809](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2809)* +*Defined in [api/types.ts:2809](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2809)* ___ -### MaxIris +### `` MaxIris -**● MaxIris**: *`number`* +**● MaxIris**: *`undefined` \| `number`* -*Defined in [api/types.ts:2811](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2811)* +*Defined in [api/types.ts:2811](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2811)* ___ -### MinExposureTime +### `` MinExposureTime -**● MinExposureTime**: *`number`* +**● MinExposureTime**: *`undefined` \| `number`* -*Defined in [api/types.ts:2806](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2806)* +*Defined in [api/types.ts:2806](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2806)* ___ -### MinGain +### `` MinGain -**● MinGain**: *`number`* +**● MinGain**: *`undefined` \| `number`* -*Defined in [api/types.ts:2808](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2808)* +*Defined in [api/types.ts:2808](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2808)* ___ -### MinIris +### `` MinIris -**● MinIris**: *`number`* +**● MinIris**: *`undefined` \| `number`* -*Defined in [api/types.ts:2810](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2810)* +*Defined in [api/types.ts:2810](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2810)* ___ @@ -116,25 +116,25 @@ ___ **● Mode**: *[ExposureMode](../enums/_api_types_.exposuremode.md)* -*Defined in [api/types.ts:2803](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2803)* +*Defined in [api/types.ts:2803](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2803)* ___ -### Priority +### `` Priority **● Priority**: *[ExposurePriority](../enums/_api_types_.exposurepriority.md)* -*Defined in [api/types.ts:2804](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2804)* +*Defined in [api/types.ts:2804](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2804)* ___ -### Window +### `` Window **● Window**: *[Rectangle](_api_types_.rectangle.md)* -*Defined in [api/types.ts:2805](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2805)* +*Defined in [api/types.ts:2805](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2805)* ___ diff --git a/docs/interfaces/_api_types_.exposureoptions.md b/docs/interfaces/_api_types_.exposureoptions.md index 8a63e39..d0008d2 100644 --- a/docs/interfaces/_api_types_.exposureoptions.md +++ b/docs/interfaces/_api_types_.exposureoptions.md @@ -32,7 +32,7 @@ **● ExposureTime**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2568](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2568)* +*Defined in [api/types.ts:2568](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2568)* ___ @@ -41,7 +41,7 @@ ___ **● Gain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2569](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2569)* +*Defined in [api/types.ts:2569](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2569)* ___ @@ -50,7 +50,7 @@ ___ **● Iris**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2570](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2570)* +*Defined in [api/types.ts:2570](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2570)* ___ @@ -59,7 +59,7 @@ ___ **● MaxExposureTime**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2563](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2563)* +*Defined in [api/types.ts:2563](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2563)* ___ @@ -68,7 +68,7 @@ ___ **● MaxGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2565](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2565)* +*Defined in [api/types.ts:2565](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2565)* ___ @@ -77,7 +77,7 @@ ___ **● MaxIris**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2567](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2567)* +*Defined in [api/types.ts:2567](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2567)* ___ @@ -86,7 +86,7 @@ ___ **● MinExposureTime**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2562](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2562)* +*Defined in [api/types.ts:2562](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2562)* ___ @@ -95,7 +95,7 @@ ___ **● MinGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2564](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2564)* +*Defined in [api/types.ts:2564](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2564)* ___ @@ -104,7 +104,7 @@ ___ **● MinIris**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2566](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2566)* +*Defined in [api/types.ts:2566](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2566)* ___ @@ -113,7 +113,7 @@ ___ **● Mode**: *[ExposureMode](../enums/_api_types_.exposuremode.md)* -*Defined in [api/types.ts:2560](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2560)* +*Defined in [api/types.ts:2560](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2560)* ___ @@ -122,7 +122,7 @@ ___ **● Priority**: *[ExposurePriority](../enums/_api_types_.exposurepriority.md)* -*Defined in [api/types.ts:2561](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2561)* +*Defined in [api/types.ts:2561](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2561)* ___ diff --git a/docs/interfaces/_api_types_.exposureoptions20.md b/docs/interfaces/_api_types_.exposureoptions20.md index 04c24e0..2e0f59a 100644 --- a/docs/interfaces/_api_types_.exposureoptions20.md +++ b/docs/interfaces/_api_types_.exposureoptions20.md @@ -37,83 +37,83 @@ -### ExposureTime +### `` ExposureTime **● ExposureTime**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2972](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2972)* +*Defined in [api/types.ts:2972](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2972)* ___ -### Gain +### `` Gain **● Gain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2973](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2973)* +*Defined in [api/types.ts:2973](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2973)* ___ -### Iris +### `` Iris **● Iris**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2974](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2974)* +*Defined in [api/types.ts:2974](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2974)* ___ -### MaxExposureTime +### `` MaxExposureTime **● MaxExposureTime**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2967](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2967)* +*Defined in [api/types.ts:2967](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2967)* ___ -### MaxGain +### `` MaxGain **● MaxGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2969](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2969)* +*Defined in [api/types.ts:2969](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2969)* ___ -### MaxIris +### `` MaxIris **● MaxIris**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2971](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2971)* +*Defined in [api/types.ts:2971](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2971)* ___ -### MinExposureTime +### `` MinExposureTime **● MinExposureTime**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2966](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2966)* +*Defined in [api/types.ts:2966](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2966)* ___ -### MinGain +### `` MinGain **● MinGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2968](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2968)* +*Defined in [api/types.ts:2968](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2968)* ___ -### MinIris +### `` MinIris **● MinIris**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2970](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2970)* +*Defined in [api/types.ts:2970](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2970)* ___ @@ -122,16 +122,16 @@ ___ **● Mode**: *[ExposureMode](../enums/_api_types_.exposuremode.md)* -*Defined in [api/types.ts:2964](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2964)* +*Defined in [api/types.ts:2964](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2964)* ___ -### Priority +### `` Priority **● Priority**: *[ExposurePriority](../enums/_api_types_.exposurepriority.md)* -*Defined in [api/types.ts:2965](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2965)* +*Defined in [api/types.ts:2965](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2965)* ___ diff --git a/docs/interfaces/_api_types_.fault.md b/docs/interfaces/_api_types_.fault.md index c585bdb..7631192 100644 --- a/docs/interfaces/_api_types_.fault.md +++ b/docs/interfaces/_api_types_.fault.md @@ -25,20 +25,20 @@ -### detail +### `` detail -**● detail**: *[detail](_api_types_.detail.md)* +**● detail**: *[detail](_api_types_.fault.md#detail)* -*Defined in [api/types.ts:4209](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4209)* +*Defined in [api/types.ts:4209](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4209)* ___ -### faultactor +### `` faultactor -**● faultactor**: *`string`* +**● faultactor**: *`undefined` \| `string`* -*Defined in [api/types.ts:4208](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4208)* +*Defined in [api/types.ts:4208](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4208)* ___ @@ -47,7 +47,7 @@ ___ **● faultcode**: *`any`* -*Defined in [api/types.ts:4206](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4206)* +*Defined in [api/types.ts:4206](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4206)* ___ @@ -56,7 +56,7 @@ ___ **● faultstring**: *`string`* -*Defined in [api/types.ts:4207](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4207)* +*Defined in [api/types.ts:4207](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4207)* ___ diff --git a/docs/interfaces/_api_types_.fileprogress.md b/docs/interfaces/_api_types_.fileprogress.md index b4939f6..252c264 100644 --- a/docs/interfaces/_api_types_.fileprogress.md +++ b/docs/interfaces/_api_types_.fileprogress.md @@ -25,7 +25,7 @@ Exported file name **● FileName**: *`string`* -*Defined in [api/types.ts:4147](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4147)* +*Defined in [api/types.ts:4147](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4147)* ___ @@ -34,7 +34,7 @@ ___ **● Progress**: *`number`* -*Defined in [api/types.ts:4148](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4148)* +*Defined in [api/types.ts:4148](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4148)* ___ diff --git a/docs/interfaces/_api_types_.findeventresult.md b/docs/interfaces/_api_types_.findeventresult.md index 7c28dfc..f1e47c3 100644 --- a/docs/interfaces/_api_types_.findeventresult.md +++ b/docs/interfaces/_api_types_.findeventresult.md @@ -28,7 +28,7 @@ The recording where this event was found. Empty string if no recording is associ **● Event**: *`any`* -*Defined in [api/types.ts:3502](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3502)* +*Defined in [api/types.ts:3502](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3502)* ___ @@ -37,7 +37,7 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3499](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3499)* +*Defined in [api/types.ts:3499](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3499)* ___ @@ -46,7 +46,7 @@ ___ **● StartStateEvent**: *`boolean`* -*Defined in [api/types.ts:3503](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3503)* +*Defined in [api/types.ts:3503](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3503)* ___ @@ -55,7 +55,7 @@ ___ **● Time**: *`string`* -*Defined in [api/types.ts:3501](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3501)* +*Defined in [api/types.ts:3501](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3501)* ___ @@ -64,7 +64,7 @@ ___ **● TrackToken**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3500](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3500)* +*Defined in [api/types.ts:3500](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3500)* ___ diff --git a/docs/interfaces/_api_types_.findeventresultlist.md b/docs/interfaces/_api_types_.findeventresultlist.md index 9dd3588..bcdb6a9 100644 --- a/docs/interfaces/_api_types_.findeventresultlist.md +++ b/docs/interfaces/_api_types_.findeventresultlist.md @@ -21,11 +21,11 @@ The state of the search when the result is returned. Indicates if there can be m -### Result +### `` Result **● Result**: *[FindEventResult](_api_types_.findeventresult.md)* -*Defined in [api/types.ts:3492](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3492)* +*Defined in [api/types.ts:3492](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3492)* ___ @@ -34,7 +34,7 @@ ___ **● SearchState**: *[SearchState](../enums/_api_types_.searchstate.md)* -*Defined in [api/types.ts:3491](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3491)* +*Defined in [api/types.ts:3491](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3491)* ___ diff --git a/docs/interfaces/_api_types_.findmetadataresult.md b/docs/interfaces/_api_types_.findmetadataresult.md index e7742cf..a32a87d 100644 --- a/docs/interfaces/_api_types_.findmetadataresult.md +++ b/docs/interfaces/_api_types_.findmetadataresult.md @@ -26,7 +26,7 @@ A reference to the recording containing the metadata. **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3536](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3536)* +*Defined in [api/types.ts:3536](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3536)* ___ @@ -35,7 +35,7 @@ ___ **● Time**: *`string`* -*Defined in [api/types.ts:3538](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3538)* +*Defined in [api/types.ts:3538](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3538)* ___ @@ -44,7 +44,7 @@ ___ **● TrackToken**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3537](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3537)* +*Defined in [api/types.ts:3537](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3537)* ___ diff --git a/docs/interfaces/_api_types_.findmetadataresultlist.md b/docs/interfaces/_api_types_.findmetadataresultlist.md index 834bc77..49f615a 100644 --- a/docs/interfaces/_api_types_.findmetadataresultlist.md +++ b/docs/interfaces/_api_types_.findmetadataresultlist.md @@ -21,11 +21,11 @@ The state of the search when the result is returned. Indicates if there can be m -### Result +### `` Result **● Result**: *[FindMetadataResult](_api_types_.findmetadataresult.md)* -*Defined in [api/types.ts:3529](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3529)* +*Defined in [api/types.ts:3529](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3529)* ___ @@ -34,7 +34,7 @@ ___ **● SearchState**: *[SearchState](../enums/_api_types_.searchstate.md)* -*Defined in [api/types.ts:3528](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3528)* +*Defined in [api/types.ts:3528](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3528)* ___ diff --git a/docs/interfaces/_api_types_.findptzpositionresult.md b/docs/interfaces/_api_types_.findptzpositionresult.md index be602a1..2850464 100644 --- a/docs/interfaces/_api_types_.findptzpositionresult.md +++ b/docs/interfaces/_api_types_.findptzpositionresult.md @@ -27,7 +27,7 @@ A reference to the recording containing the PTZ position. **● Position**: *[PTZVector](_api_types_.ptzvector.md)* -*Defined in [api/types.ts:3521](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3521)* +*Defined in [api/types.ts:3521](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3521)* ___ @@ -36,7 +36,7 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3518](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3518)* +*Defined in [api/types.ts:3518](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3518)* ___ @@ -45,7 +45,7 @@ ___ **● Time**: *`string`* -*Defined in [api/types.ts:3520](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3520)* +*Defined in [api/types.ts:3520](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3520)* ___ @@ -54,7 +54,7 @@ ___ **● TrackToken**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3519](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3519)* +*Defined in [api/types.ts:3519](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3519)* ___ diff --git a/docs/interfaces/_api_types_.findptzpositionresultlist.md b/docs/interfaces/_api_types_.findptzpositionresultlist.md index 3884519..d54b851 100644 --- a/docs/interfaces/_api_types_.findptzpositionresultlist.md +++ b/docs/interfaces/_api_types_.findptzpositionresultlist.md @@ -21,11 +21,11 @@ The state of the search when the result is returned. Indicates if there can be m -### Result +### `` Result **● Result**: *[FindPTZPositionResult](_api_types_.findptzpositionresult.md)* -*Defined in [api/types.ts:3511](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3511)* +*Defined in [api/types.ts:3511](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3511)* ___ @@ -34,7 +34,7 @@ ___ **● SearchState**: *[SearchState](../enums/_api_types_.searchstate.md)* -*Defined in [api/types.ts:3510](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3510)* +*Defined in [api/types.ts:3510](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3510)* ___ diff --git a/docs/interfaces/_api_types_.findrecordingresultlist.md b/docs/interfaces/_api_types_.findrecordingresultlist.md index e6e02df..57717ec 100644 --- a/docs/interfaces/_api_types_.findrecordingresultlist.md +++ b/docs/interfaces/_api_types_.findrecordingresultlist.md @@ -21,11 +21,11 @@ The state of the search when the result is returned. Indicates if there can be m -### RecordingInformation +### `` RecordingInformation -**● RecordingInformation**: *[RecordingInformation](_api_types_.recordinginformation.md)* +**● RecordingInformation**: *[RecordingInformation](_api_types_.findrecordingresultlist.md#recordinginformation)* -*Defined in [api/types.ts:3484](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3484)* +*Defined in [api/types.ts:3484](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3484)* ___ @@ -34,7 +34,7 @@ ___ **● SearchState**: *[SearchState](../enums/_api_types_.searchstate.md)* -*Defined in [api/types.ts:3483](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3483)* +*Defined in [api/types.ts:3483](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3483)* ___ diff --git a/docs/interfaces/_api_types_.floatlist.md b/docs/interfaces/_api_types_.floatlist.md index 7b1d1a8..44d1bba 100644 --- a/docs/interfaces/_api_types_.floatlist.md +++ b/docs/interfaces/_api_types_.floatlist.md @@ -18,11 +18,11 @@ -### Items +### `` Items -**● Items**: *`number`* +**● Items**: *`undefined` \| `number`* -*Defined in [api/types.ts:313](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L313)* +*Defined in [api/types.ts:313](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L313)* ___ diff --git a/docs/interfaces/_api_types_.floatrange.md b/docs/interfaces/_api_types_.floatrange.md index 13d9a03..c820966 100644 --- a/docs/interfaces/_api_types_.floatrange.md +++ b/docs/interfaces/_api_types_.floatrange.md @@ -25,7 +25,7 @@ Range of values greater equal Min value and less equal Max value. **● Max**: *`number`* -*Defined in [api/types.ts:291](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L291)* +*Defined in [api/types.ts:291](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L291)* ___ @@ -34,7 +34,7 @@ ___ **● Min**: *`number`* -*Defined in [api/types.ts:290](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L290)* +*Defined in [api/types.ts:290](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L290)* ___ diff --git a/docs/interfaces/_api_types_.focusconfiguration.md b/docs/interfaces/_api_types_.focusconfiguration.md index fddb8f9..1d16c13 100644 --- a/docs/interfaces/_api_types_.focusconfiguration.md +++ b/docs/interfaces/_api_types_.focusconfiguration.md @@ -27,7 +27,7 @@ Parameter to set autofocus near limit (unit: meter). **● AutoFocusMode**: *[AutoFocusMode](../enums/_api_types_.autofocusmode.md)* -*Defined in [api/types.ts:2443](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2443)* +*Defined in [api/types.ts:2443](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2443)* ___ @@ -36,7 +36,7 @@ ___ **● DefaultSpeed**: *`number`* -*Defined in [api/types.ts:2444](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2444)* +*Defined in [api/types.ts:2444](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2444)* ___ @@ -45,7 +45,7 @@ ___ **● FarLimit**: *`number`* -*Defined in [api/types.ts:2446](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2446)* +*Defined in [api/types.ts:2446](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2446)* ___ @@ -54,7 +54,7 @@ ___ **● NearLimit**: *`number`* -*Defined in [api/types.ts:2445](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2445)* +*Defined in [api/types.ts:2445](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2445)* ___ diff --git a/docs/interfaces/_api_types_.focusconfiguration20.md b/docs/interfaces/_api_types_.focusconfiguration20.md index ffa0e63..f2f8c18 100644 --- a/docs/interfaces/_api_types_.focusconfiguration20.md +++ b/docs/interfaces/_api_types_.focusconfiguration20.md @@ -37,43 +37,43 @@ **● AutoFocusMode**: *[AutoFocusMode](../enums/_api_types_.autofocusmode.md)* -*Defined in [api/types.ts:3027](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3027)* +*Defined in [api/types.ts:3027](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3027)* ___ -### DefaultSpeed +### `` DefaultSpeed -**● DefaultSpeed**: *`number`* +**● DefaultSpeed**: *`undefined` \| `number`* -*Defined in [api/types.ts:3028](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3028)* +*Defined in [api/types.ts:3028](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3028)* ___ -### Extension +### `` Extension **● Extension**: *[FocusConfiguration20Extension](_api_types_.focusconfiguration20extension.md)* -*Defined in [api/types.ts:3031](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3031)* +*Defined in [api/types.ts:3031](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3031)* ___ -### FarLimit +### `` FarLimit -**● FarLimit**: *`number`* +**● FarLimit**: *`undefined` \| `number`* -*Defined in [api/types.ts:3030](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3030)* +*Defined in [api/types.ts:3030](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3030)* ___ -### NearLimit +### `` NearLimit -**● NearLimit**: *`number`* +**● NearLimit**: *`undefined` \| `number`* -*Defined in [api/types.ts:3029](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3029)* +*Defined in [api/types.ts:3029](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3029)* ___ diff --git a/docs/interfaces/_api_types_.focusmove.md b/docs/interfaces/_api_types_.focusmove.md index 964fafe..31272a4 100644 --- a/docs/interfaces/_api_types_.focusmove.md +++ b/docs/interfaces/_api_types_.focusmove.md @@ -24,29 +24,29 @@ -### Absolute +### `` Absolute **● Absolute**: *[AbsoluteFocus](_api_types_.absolutefocus.md)* -*Defined in [api/types.ts:2588](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2588)* +*Defined in [api/types.ts:2588](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2588)* ___ -### Continuous +### `` Continuous **● Continuous**: *[ContinuousFocus](_api_types_.continuousfocus.md)* -*Defined in [api/types.ts:2590](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2590)* +*Defined in [api/types.ts:2590](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2590)* ___ -### Relative +### `` Relative **● Relative**: *[RelativeFocus](_api_types_.relativefocus.md)* -*Defined in [api/types.ts:2589](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2589)* +*Defined in [api/types.ts:2589](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2589)* ___ diff --git a/docs/interfaces/_api_types_.focusoptions.md b/docs/interfaces/_api_types_.focusoptions.md index 360c616..9c45696 100644 --- a/docs/interfaces/_api_types_.focusoptions.md +++ b/docs/interfaces/_api_types_.focusoptions.md @@ -21,11 +21,11 @@ -### AutoFocusModes +### `` AutoFocusModes **● AutoFocusModes**: *[AutoFocusMode](../enums/_api_types_.autofocusmode.md)* -*Defined in [api/types.ts:2550](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2550)* +*Defined in [api/types.ts:2550](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2550)* ___ @@ -34,7 +34,7 @@ ___ **● DefaultSpeed**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2551](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2551)* +*Defined in [api/types.ts:2551](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2551)* ___ @@ -43,7 +43,7 @@ ___ **● FarLimit**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2553](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2553)* +*Defined in [api/types.ts:2553](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2553)* ___ @@ -52,7 +52,7 @@ ___ **● NearLimit**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2552](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2552)* +*Defined in [api/types.ts:2552](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2552)* ___ diff --git a/docs/interfaces/_api_types_.focusoptions20.md b/docs/interfaces/_api_types_.focusoptions20.md index 91a3ca0..52cc6a3 100644 --- a/docs/interfaces/_api_types_.focusoptions20.md +++ b/docs/interfaces/_api_types_.focusoptions20.md @@ -31,47 +31,47 @@ -### AutoFocusModes +### `` AutoFocusModes **● AutoFocusModes**: *[AutoFocusMode](../enums/_api_types_.autofocusmode.md)* -*Defined in [api/types.ts:3072](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3072)* +*Defined in [api/types.ts:3072](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3072)* ___ -### DefaultSpeed +### `` DefaultSpeed **● DefaultSpeed**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:3073](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3073)* +*Defined in [api/types.ts:3073](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3073)* ___ -### Extension +### `` Extension **● Extension**: *[FocusOptions20Extension](_api_types_.focusoptions20extension.md)* -*Defined in [api/types.ts:3076](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3076)* +*Defined in [api/types.ts:3076](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3076)* ___ -### FarLimit +### `` FarLimit **● FarLimit**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:3075](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3075)* +*Defined in [api/types.ts:3075](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3075)* ___ -### NearLimit +### `` NearLimit **● NearLimit**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:3074](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3074)* +*Defined in [api/types.ts:3074](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3074)* ___ diff --git a/docs/interfaces/_api_types_.focusstatus.md b/docs/interfaces/_api_types_.focusstatus.md index e62cac5..9f6ad11 100644 --- a/docs/interfaces/_api_types_.focusstatus.md +++ b/docs/interfaces/_api_types_.focusstatus.md @@ -28,7 +28,7 @@ **● Error**: *`string`* -*Defined in [api/types.ts:2436](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2436)* +*Defined in [api/types.ts:2436](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2436)* ___ @@ -37,7 +37,7 @@ ___ **● MoveStatus**: *[MoveStatus](../enums/_api_types_.movestatus.md)* -*Defined in [api/types.ts:2435](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2435)* +*Defined in [api/types.ts:2435](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2435)* ___ @@ -46,7 +46,7 @@ ___ **● Position**: *`number`* -*Defined in [api/types.ts:2434](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2434)* +*Defined in [api/types.ts:2434](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2434)* ___ diff --git a/docs/interfaces/_api_types_.focusstatus20.md b/docs/interfaces/_api_types_.focusstatus20.md index 538d218..a0d9688 100644 --- a/docs/interfaces/_api_types_.focusstatus20.md +++ b/docs/interfaces/_api_types_.focusstatus20.md @@ -25,20 +25,20 @@ -### Error +### `` Error -**● Error**: *`string`* +**● Error**: *`undefined` \| `string`* -*Defined in [api/types.ts:2693](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2693)* +*Defined in [api/types.ts:2693](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2693)* ___ -### Extension +### `` Extension **● Extension**: *[FocusStatus20Extension](_api_types_.focusstatus20extension.md)* -*Defined in [api/types.ts:2694](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2694)* +*Defined in [api/types.ts:2694](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2694)* ___ @@ -47,7 +47,7 @@ ___ **● MoveStatus**: *[MoveStatus](../enums/_api_types_.movestatus.md)* -*Defined in [api/types.ts:2692](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2692)* +*Defined in [api/types.ts:2692](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2692)* ___ @@ -56,7 +56,7 @@ ___ **● Position**: *`number`* -*Defined in [api/types.ts:2691](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2691)* +*Defined in [api/types.ts:2691](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2691)* ___ diff --git a/docs/interfaces/_api_types_.g711decoptions.md b/docs/interfaces/_api_types_.g711decoptions.md index 2c5776d..34e443e 100644 --- a/docs/interfaces/_api_types_.g711decoptions.md +++ b/docs/interfaces/_api_types_.g711decoptions.md @@ -25,7 +25,7 @@ List of supported bitrates in kbps **● Bitrate**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:954](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L954)* +*Defined in [api/types.ts:954](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L954)* ___ @@ -34,7 +34,7 @@ ___ **● SampleRateRange**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:955](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L955)* +*Defined in [api/types.ts:955](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L955)* ___ diff --git a/docs/interfaces/_api_types_.g726decoptions.md b/docs/interfaces/_api_types_.g726decoptions.md index a1591e6..1440361 100644 --- a/docs/interfaces/_api_types_.g726decoptions.md +++ b/docs/interfaces/_api_types_.g726decoptions.md @@ -25,7 +25,7 @@ List of supported bitrates in kbps **● Bitrate**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:970](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L970)* +*Defined in [api/types.ts:970](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L970)* ___ @@ -34,7 +34,7 @@ ___ **● SampleRateRange**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:971](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L971)* +*Defined in [api/types.ts:971](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L971)* ___ diff --git a/docs/interfaces/_api_types_.getrecordingjobsresponseitem.md b/docs/interfaces/_api_types_.getrecordingjobsresponseitem.md index 4b993b1..3bf1006 100644 --- a/docs/interfaces/_api_types_.getrecordingjobsresponseitem.md +++ b/docs/interfaces/_api_types_.getrecordingjobsresponseitem.md @@ -23,7 +23,7 @@ **● JobConfiguration**: *[RecordingJobConfiguration](_api_types_.recordingjobconfiguration.md)* -*Defined in [api/types.ts:3775](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3775)* +*Defined in [api/types.ts:3775](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3775)* ___ @@ -32,7 +32,7 @@ ___ **● JobToken**: *[RecordingJobReference](../modules/_api_types_.md#recordingjobreference)* -*Defined in [api/types.ts:3774](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3774)* +*Defined in [api/types.ts:3774](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3774)* ___ diff --git a/docs/interfaces/_api_types_.getrecordingsresponseitem.md b/docs/interfaces/_api_types_.getrecordingsresponseitem.md index 4af799e..98f770f 100644 --- a/docs/interfaces/_api_types_.getrecordingsresponseitem.md +++ b/docs/interfaces/_api_types_.getrecordingsresponseitem.md @@ -26,7 +26,7 @@ Token of the recording. **● Configuration**: *[RecordingConfiguration](_api_types_.recordingconfiguration.md)* -*Defined in [api/types.ts:3662](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3662)* +*Defined in [api/types.ts:3662](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3662)* ___ @@ -35,7 +35,7 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3661](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3661)* +*Defined in [api/types.ts:3661](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3661)* ___ @@ -44,7 +44,7 @@ ___ **● Tracks**: *[GetTracksResponseList](_api_types_.gettracksresponselist.md)* -*Defined in [api/types.ts:3663](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3663)* +*Defined in [api/types.ts:3663](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3663)* ___ diff --git a/docs/interfaces/_api_types_.gettracksresponseitem.md b/docs/interfaces/_api_types_.gettracksresponseitem.md index 4fa7090..82192a9 100644 --- a/docs/interfaces/_api_types_.gettracksresponseitem.md +++ b/docs/interfaces/_api_types_.gettracksresponseitem.md @@ -25,7 +25,7 @@ Token of the track. **● Configuration**: *[TrackConfiguration](_api_types_.trackconfiguration.md)* -*Defined in [api/types.ts:3678](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3678)* +*Defined in [api/types.ts:3678](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3678)* ___ @@ -34,7 +34,7 @@ ___ **● TrackToken**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3677](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3677)* +*Defined in [api/types.ts:3677](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3677)* ___ diff --git a/docs/interfaces/_api_types_.gettracksresponselist.md b/docs/interfaces/_api_types_.gettracksresponselist.md index d631beb..ef7acc2 100644 --- a/docs/interfaces/_api_types_.gettracksresponselist.md +++ b/docs/interfaces/_api_types_.gettracksresponselist.md @@ -20,11 +20,11 @@ Configuration of a track. -### Track +### `` Track **● Track**: *[GetTracksResponseItem](_api_types_.gettracksresponseitem.md)* -*Defined in [api/types.ts:3670](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3670)* +*Defined in [api/types.ts:3670](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3670)* ___ diff --git a/docs/interfaces/_api_types_.h264configuration.md b/docs/interfaces/_api_types_.h264configuration.md index 8910d37..d1b3835 100644 --- a/docs/interfaces/_api_types_.h264configuration.md +++ b/docs/interfaces/_api_types_.h264configuration.md @@ -25,7 +25,7 @@ Group of Video frames length. Determines typically the interval in which the I-F **● GovLength**: *`number`* -*Defined in [api/types.ts:565](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L565)* +*Defined in [api/types.ts:565](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L565)* ___ @@ -34,7 +34,7 @@ ___ **● H264Profile**: *[H264Profile](../enums/_api_types_.h264profile.md)* -*Defined in [api/types.ts:566](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L566)* +*Defined in [api/types.ts:566](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L566)* ___ diff --git a/docs/interfaces/_api_types_.h264decoptions.md b/docs/interfaces/_api_types_.h264decoptions.md index 0269b84..4fabda2 100644 --- a/docs/interfaces/_api_types_.h264decoptions.md +++ b/docs/interfaces/_api_types_.h264decoptions.md @@ -27,7 +27,7 @@ List of supported H.264 Video Resolutions **● ResolutionsAvailable**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:878](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L878)* +*Defined in [api/types.ts:878](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L878)* ___ @@ -36,7 +36,7 @@ ___ **● SupportedFrameRate**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:881](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L881)* +*Defined in [api/types.ts:881](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L881)* ___ @@ -45,7 +45,7 @@ ___ **● SupportedH264Profiles**: *[H264Profile](../enums/_api_types_.h264profile.md)* -*Defined in [api/types.ts:879](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L879)* +*Defined in [api/types.ts:879](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L879)* ___ @@ -54,7 +54,7 @@ ___ **● SupportedInputBitrate**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:880](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L880)* +*Defined in [api/types.ts:880](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L880)* ___ diff --git a/docs/interfaces/_api_types_.h264options.md b/docs/interfaces/_api_types_.h264options.md index f47f7ed..fc67759 100644 --- a/docs/interfaces/_api_types_.h264options.md +++ b/docs/interfaces/_api_types_.h264options.md @@ -28,7 +28,7 @@ List of supported image sizes. **● EncodingIntervalRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:637](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L637)* +*Defined in [api/types.ts:637](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L637)* ___ @@ -37,7 +37,7 @@ ___ **● FrameRateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:636](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L636)* +*Defined in [api/types.ts:636](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L636)* ___ @@ -46,7 +46,7 @@ ___ **● GovLengthRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:635](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L635)* +*Defined in [api/types.ts:635](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L635)* ___ @@ -55,7 +55,7 @@ ___ **● H264ProfilesSupported**: *[H264Profile](../enums/_api_types_.h264profile.md)* -*Defined in [api/types.ts:638](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L638)* +*Defined in [api/types.ts:638](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L638)* ___ @@ -64,7 +64,7 @@ ___ **● ResolutionsAvailable**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:634](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L634)* +*Defined in [api/types.ts:634](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L634)* ___ diff --git a/docs/interfaces/_api_types_.h264options2.md b/docs/interfaces/_api_types_.h264options2.md index 4686fa7..35f373d 100644 --- a/docs/interfaces/_api_types_.h264options2.md +++ b/docs/interfaces/_api_types_.h264options2.md @@ -24,7 +24,7 @@ Supported range of encoded bitrate in kbps. **● BitrateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:645](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L645)* +*Defined in [api/types.ts:645](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L645)* ___ diff --git a/docs/interfaces/_api_types_.hostnameinformation.md b/docs/interfaces/_api_types_.hostnameinformation.md index ca6cf85..5e3b0ce 100644 --- a/docs/interfaces/_api_types_.hostnameinformation.md +++ b/docs/interfaces/_api_types_.hostnameinformation.md @@ -22,11 +22,11 @@ Indicates whether the hostname is obtained from DHCP or not. -### Extension +### `` Extension **● Extension**: *[HostnameInformationExtension](_api_types_.hostnameinformationextension.md)* -*Defined in [api/types.ts:1194](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1194)* +*Defined in [api/types.ts:1194](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1194)* ___ @@ -35,16 +35,16 @@ ___ **● FromDHCP**: *`boolean`* -*Defined in [api/types.ts:1192](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1192)* +*Defined in [api/types.ts:1192](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1192)* ___ -### Name +### `` Name -**● Name**: *`string`* +**● Name**: *`undefined` \| `string`* -*Defined in [api/types.ts:1193](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1193)* +*Defined in [api/types.ts:1193](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1193)* ___ diff --git a/docs/interfaces/_api_types_.imagestabilization.md b/docs/interfaces/_api_types_.imagestabilization.md index 0942612..6eb02a0 100644 --- a/docs/interfaces/_api_types_.imagestabilization.md +++ b/docs/interfaces/_api_types_.imagestabilization.md @@ -22,20 +22,20 @@ Parameter to enable/disable Image Stabilization feature. -### Extension +### `` Extension **● Extension**: *[ImageStabilizationExtension](_api_types_.imagestabilizationextension.md)* -*Defined in [api/types.ts:2758](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2758)* +*Defined in [api/types.ts:2758](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2758)* ___ -### Level +### `` Level -**● Level**: *`number`* +**● Level**: *`undefined` \| `number`* -*Defined in [api/types.ts:2757](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2757)* +*Defined in [api/types.ts:2757](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2757)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *[ImageStabilizationMode](../enums/_api_types_.imagestabilizationmode.md)* -*Defined in [api/types.ts:2756](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2756)* +*Defined in [api/types.ts:2756](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2756)* ___ diff --git a/docs/interfaces/_api_types_.imagestabilizationoptions.md b/docs/interfaces/_api_types_.imagestabilizationoptions.md index 5947b0f..3996adb 100644 --- a/docs/interfaces/_api_types_.imagestabilizationoptions.md +++ b/docs/interfaces/_api_types_.imagestabilizationoptions.md @@ -22,20 +22,20 @@ Supported options of Image Stabilization mode parameter. -### Extension +### `` Extension **● Extension**: *[ImageStabilizationOptionsExtension](_api_types_.imagestabilizationoptionsextension.md)* -*Defined in [api/types.ts:2911](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2911)* +*Defined in [api/types.ts:2911](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2911)* ___ -### Level +### `` Level **● Level**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2910](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2910)* +*Defined in [api/types.ts:2910](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2910)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *[ImageStabilizationMode](../enums/_api_types_.imagestabilizationmode.md)* -*Defined in [api/types.ts:2909](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2909)* +*Defined in [api/types.ts:2909](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2909)* ___ diff --git a/docs/interfaces/_api_types_.imagingcapabilities.md b/docs/interfaces/_api_types_.imagingcapabilities.md index 4804ed4..a82ac68 100644 --- a/docs/interfaces/_api_types_.imagingcapabilities.md +++ b/docs/interfaces/_api_types_.imagingcapabilities.md @@ -24,7 +24,7 @@ Imaging service URI. **● XAddr**: *`string`* -*Defined in [api/types.ts:1667](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1667)* +*Defined in [api/types.ts:1667](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1667)* ___ diff --git a/docs/interfaces/_api_types_.imagingoptions.md b/docs/interfaces/_api_types_.imagingoptions.md index 6cdbb20..ab4d270 100644 --- a/docs/interfaces/_api_types_.imagingoptions.md +++ b/docs/interfaces/_api_types_.imagingoptions.md @@ -31,7 +31,7 @@ **● BacklightCompensation**: *[BacklightCompensationOptions](_api_types_.backlightcompensationoptions.md)* -*Defined in [api/types.ts:2518](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2518)* +*Defined in [api/types.ts:2518](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2518)* ___ @@ -40,7 +40,7 @@ ___ **● Brightness**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2519](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2519)* +*Defined in [api/types.ts:2519](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2519)* ___ @@ -49,7 +49,7 @@ ___ **● ColorSaturation**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2520](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2520)* +*Defined in [api/types.ts:2520](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2520)* ___ @@ -58,7 +58,7 @@ ___ **● Contrast**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2521](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2521)* +*Defined in [api/types.ts:2521](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2521)* ___ @@ -67,7 +67,7 @@ ___ **● Exposure**: *[ExposureOptions](_api_types_.exposureoptions.md)* -*Defined in [api/types.ts:2522](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2522)* +*Defined in [api/types.ts:2522](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2522)* ___ @@ -76,7 +76,7 @@ ___ **● Focus**: *[FocusOptions](_api_types_.focusoptions.md)* -*Defined in [api/types.ts:2523](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2523)* +*Defined in [api/types.ts:2523](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2523)* ___ @@ -85,7 +85,7 @@ ___ **● IrCutFilterModes**: *[IrCutFilterMode](../enums/_api_types_.ircutfiltermode.md)* -*Defined in [api/types.ts:2524](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2524)* +*Defined in [api/types.ts:2524](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2524)* ___ @@ -94,7 +94,7 @@ ___ **● Sharpness**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2525](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2525)* +*Defined in [api/types.ts:2525](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2525)* ___ @@ -103,7 +103,7 @@ ___ **● WhiteBalance**: *[WhiteBalanceOptions](_api_types_.whitebalanceoptions.md)* -*Defined in [api/types.ts:2527](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2527)* +*Defined in [api/types.ts:2527](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2527)* ___ @@ -112,7 +112,7 @@ ___ **● WideDynamicRange**: *[WideDynamicRangeOptions](_api_types_.widedynamicrangeoptions.md)* -*Defined in [api/types.ts:2526](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2526)* +*Defined in [api/types.ts:2526](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2526)* ___ diff --git a/docs/interfaces/_api_types_.imagingoptions20.md b/docs/interfaces/_api_types_.imagingoptions20.md index bede960..0163ef0 100644 --- a/docs/interfaces/_api_types_.imagingoptions20.md +++ b/docs/interfaces/_api_types_.imagingoptions20.md @@ -32,101 +32,101 @@ -### BacklightCompensation +### `` BacklightCompensation **● BacklightCompensation**: *[BacklightCompensationOptions20](_api_types_.backlightcompensationoptions20.md)* -*Defined in [api/types.ts:2860](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2860)* +*Defined in [api/types.ts:2860](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2860)* ___ -### Brightness +### `` Brightness **● Brightness**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2861](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2861)* +*Defined in [api/types.ts:2861](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2861)* ___ -### ColorSaturation +### `` ColorSaturation **● ColorSaturation**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2862](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2862)* +*Defined in [api/types.ts:2862](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2862)* ___ -### Contrast +### `` Contrast **● Contrast**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2863](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2863)* +*Defined in [api/types.ts:2863](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2863)* ___ -### Exposure +### `` Exposure **● Exposure**: *[ExposureOptions20](_api_types_.exposureoptions20.md)* -*Defined in [api/types.ts:2864](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2864)* +*Defined in [api/types.ts:2864](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2864)* ___ -### Extension +### `` Extension **● Extension**: *[ImagingOptions20Extension](_api_types_.imagingoptions20extension.md)* -*Defined in [api/types.ts:2870](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2870)* +*Defined in [api/types.ts:2870](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2870)* ___ -### Focus +### `` Focus **● Focus**: *[FocusOptions20](_api_types_.focusoptions20.md)* -*Defined in [api/types.ts:2865](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2865)* +*Defined in [api/types.ts:2865](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2865)* ___ -### IrCutFilterModes +### `` IrCutFilterModes **● IrCutFilterModes**: *[IrCutFilterMode](../enums/_api_types_.ircutfiltermode.md)* -*Defined in [api/types.ts:2866](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2866)* +*Defined in [api/types.ts:2866](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2866)* ___ -### Sharpness +### `` Sharpness **● Sharpness**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2867](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2867)* +*Defined in [api/types.ts:2867](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2867)* ___ -### WhiteBalance +### `` WhiteBalance **● WhiteBalance**: *[WhiteBalanceOptions20](_api_types_.whitebalanceoptions20.md)* -*Defined in [api/types.ts:2869](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2869)* +*Defined in [api/types.ts:2869](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2869)* ___ -### WideDynamicRange +### `` WideDynamicRange **● WideDynamicRange**: *[WideDynamicRangeOptions20](_api_types_.widedynamicrangeoptions20.md)* -*Defined in [api/types.ts:2868](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2868)* +*Defined in [api/types.ts:2868](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2868)* ___ diff --git a/docs/interfaces/_api_types_.imagingoptions20extension.md b/docs/interfaces/_api_types_.imagingoptions20extension.md index 69ce7fb..ba73d5a 100644 --- a/docs/interfaces/_api_types_.imagingoptions20extension.md +++ b/docs/interfaces/_api_types_.imagingoptions20extension.md @@ -21,20 +21,20 @@ Options of parameters for Image Stabilization feature. -### Extension +### `` Extension **● Extension**: *[ImagingOptions20Extension2](_api_types_.imagingoptions20extension2.md)* -*Defined in [api/types.ts:2878](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2878)* +*Defined in [api/types.ts:2878](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2878)* ___ -### ImageStabilization +### `` ImageStabilization **● ImageStabilization**: *[ImageStabilizationOptions](_api_types_.imagestabilizationoptions.md)* -*Defined in [api/types.ts:2877](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2877)* +*Defined in [api/types.ts:2877](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2877)* ___ diff --git a/docs/interfaces/_api_types_.imagingoptions20extension2.md b/docs/interfaces/_api_types_.imagingoptions20extension2.md index e18e3c6..e699956 100644 --- a/docs/interfaces/_api_types_.imagingoptions20extension2.md +++ b/docs/interfaces/_api_types_.imagingoptions20extension2.md @@ -21,20 +21,20 @@ Options of parameters for adjustment of Ir cut filter auto mode. -### Extension +### `` Extension **● Extension**: *[ImagingOptions20Extension3](_api_types_.imagingoptions20extension3.md)* -*Defined in [api/types.ts:2886](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2886)* +*Defined in [api/types.ts:2886](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2886)* ___ -### IrCutFilterAutoAdjustment +### `` IrCutFilterAutoAdjustment **● IrCutFilterAutoAdjustment**: *[IrCutFilterAutoAdjustmentOptions](_api_types_.ircutfilterautoadjustmentoptions.md)* -*Defined in [api/types.ts:2885](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2885)* +*Defined in [api/types.ts:2885](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2885)* ___ diff --git a/docs/interfaces/_api_types_.imagingoptions20extension3.md b/docs/interfaces/_api_types_.imagingoptions20extension3.md index 83a2c93..df6200d 100644 --- a/docs/interfaces/_api_types_.imagingoptions20extension3.md +++ b/docs/interfaces/_api_types_.imagingoptions20extension3.md @@ -23,38 +23,38 @@ Options of parameters for Tone Compensation feature. -### DefoggingOptions +### `` DefoggingOptions -**● DefoggingOptions**: *[DefoggingOptions](_api_types_.defoggingoptions.md)* +**● DefoggingOptions**: *[DefoggingOptions](_api_types_.imagingoptions20extension3.md#defoggingoptions)* -*Defined in [api/types.ts:2894](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2894)* +*Defined in [api/types.ts:2894](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2894)* ___ -### Extension +### `` Extension **● Extension**: *[ImagingOptions20Extension4](_api_types_.imagingoptions20extension4.md)* -*Defined in [api/types.ts:2896](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2896)* +*Defined in [api/types.ts:2896](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2896)* ___ -### NoiseReductionOptions +### `` NoiseReductionOptions -**● NoiseReductionOptions**: *[NoiseReductionOptions](_api_types_.noisereductionoptions.md)* +**● NoiseReductionOptions**: *[NoiseReductionOptions](_api_types_.imagingoptions20extension3.md#noisereductionoptions)* -*Defined in [api/types.ts:2895](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2895)* +*Defined in [api/types.ts:2895](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2895)* ___ -### ToneCompensationOptions +### `` ToneCompensationOptions -**● ToneCompensationOptions**: *[ToneCompensationOptions](_api_types_.tonecompensationoptions.md)* +**● ToneCompensationOptions**: *[ToneCompensationOptions](_api_types_.imagingoptions20extension3.md#tonecompensationoptions)* -*Defined in [api/types.ts:2893](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2893)* +*Defined in [api/types.ts:2893](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2893)* ___ diff --git a/docs/interfaces/_api_types_.imagingsettings.md b/docs/interfaces/_api_types_.imagingsettings.md index 0c4cccb..42a9b5a 100644 --- a/docs/interfaces/_api_types_.imagingsettings.md +++ b/docs/interfaces/_api_types_.imagingsettings.md @@ -30,101 +30,101 @@ Enabled/disabled BLC mode (on/off). -### BacklightCompensation +### `` BacklightCompensation -**● BacklightCompensation**: *[BacklightCompensation](_api_types_.backlightcompensation.md)* +**● BacklightCompensation**: *[BacklightCompensation](_api_types_.imagingsettings.md#backlightcompensation)* -*Defined in [api/types.ts:2453](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2453)* +*Defined in [api/types.ts:2453](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2453)* ___ -### Brightness +### `` Brightness -**● Brightness**: *`number`* +**● Brightness**: *`undefined` \| `number`* -*Defined in [api/types.ts:2454](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2454)* +*Defined in [api/types.ts:2454](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2454)* ___ -### ColorSaturation +### `` ColorSaturation -**● ColorSaturation**: *`number`* +**● ColorSaturation**: *`undefined` \| `number`* -*Defined in [api/types.ts:2455](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2455)* +*Defined in [api/types.ts:2455](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2455)* ___ -### Contrast +### `` Contrast -**● Contrast**: *`number`* +**● Contrast**: *`undefined` \| `number`* -*Defined in [api/types.ts:2456](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2456)* +*Defined in [api/types.ts:2456](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2456)* ___ -### Exposure +### `` Exposure -**● Exposure**: *[Exposure](_api_types_.exposure.md)* +**● Exposure**: *[Exposure](_api_types_.imagingsettings.md#exposure)* -*Defined in [api/types.ts:2457](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2457)* +*Defined in [api/types.ts:2457](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2457)* ___ -### Extension +### `` Extension **● Extension**: *[ImagingSettingsExtension](_api_types_.imagingsettingsextension.md)* -*Defined in [api/types.ts:2463](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2463)* +*Defined in [api/types.ts:2463](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2463)* ___ -### Focus +### `` Focus **● Focus**: *[FocusConfiguration](_api_types_.focusconfiguration.md)* -*Defined in [api/types.ts:2458](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2458)* +*Defined in [api/types.ts:2458](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2458)* ___ -### IrCutFilter +### `` IrCutFilter **● IrCutFilter**: *[IrCutFilterMode](../enums/_api_types_.ircutfiltermode.md)* -*Defined in [api/types.ts:2459](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2459)* +*Defined in [api/types.ts:2459](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2459)* ___ -### Sharpness +### `` Sharpness -**● Sharpness**: *`number`* +**● Sharpness**: *`undefined` \| `number`* -*Defined in [api/types.ts:2460](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2460)* +*Defined in [api/types.ts:2460](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2460)* ___ -### WhiteBalance +### `` WhiteBalance -**● WhiteBalance**: *[WhiteBalance](_api_types_.whitebalance.md)* +**● WhiteBalance**: *[WhiteBalance](_api_types_.imagingsettings.md#whitebalance)* -*Defined in [api/types.ts:2462](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2462)* +*Defined in [api/types.ts:2462](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2462)* ___ -### WideDynamicRange +### `` WideDynamicRange -**● WideDynamicRange**: *[WideDynamicRange](_api_types_.widedynamicrange.md)* +**● WideDynamicRange**: *[WideDynamicRange](_api_types_.imagingsettings.md#widedynamicrange)* -*Defined in [api/types.ts:2461](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2461)* +*Defined in [api/types.ts:2461](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2461)* ___ diff --git a/docs/interfaces/_api_types_.imagingsettings20.md b/docs/interfaces/_api_types_.imagingsettings20.md index 214da65..f529808 100644 --- a/docs/interfaces/_api_types_.imagingsettings20.md +++ b/docs/interfaces/_api_types_.imagingsettings20.md @@ -30,101 +30,101 @@ Type describing the ImagingSettings of a VideoSource. The supported options and -### BacklightCompensation +### `` BacklightCompensation **● BacklightCompensation**: *[BacklightCompensation20](_api_types_.backlightcompensation20.md)* -*Defined in [api/types.ts:2707](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2707)* +*Defined in [api/types.ts:2707](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2707)* ___ -### Brightness +### `` Brightness -**● Brightness**: *`number`* +**● Brightness**: *`undefined` \| `number`* -*Defined in [api/types.ts:2708](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2708)* +*Defined in [api/types.ts:2708](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2708)* ___ -### ColorSaturation +### `` ColorSaturation -**● ColorSaturation**: *`number`* +**● ColorSaturation**: *`undefined` \| `number`* -*Defined in [api/types.ts:2709](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2709)* +*Defined in [api/types.ts:2709](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2709)* ___ -### Contrast +### `` Contrast -**● Contrast**: *`number`* +**● Contrast**: *`undefined` \| `number`* -*Defined in [api/types.ts:2710](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2710)* +*Defined in [api/types.ts:2710](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2710)* ___ -### Exposure +### `` Exposure **● Exposure**: *[Exposure20](_api_types_.exposure20.md)* -*Defined in [api/types.ts:2711](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2711)* +*Defined in [api/types.ts:2711](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2711)* ___ -### Extension +### `` Extension **● Extension**: *[ImagingSettingsExtension20](_api_types_.imagingsettingsextension20.md)* -*Defined in [api/types.ts:2717](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2717)* +*Defined in [api/types.ts:2717](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2717)* ___ -### Focus +### `` Focus **● Focus**: *[FocusConfiguration20](_api_types_.focusconfiguration20.md)* -*Defined in [api/types.ts:2712](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2712)* +*Defined in [api/types.ts:2712](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2712)* ___ -### IrCutFilter +### `` IrCutFilter **● IrCutFilter**: *[IrCutFilterMode](../enums/_api_types_.ircutfiltermode.md)* -*Defined in [api/types.ts:2713](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2713)* +*Defined in [api/types.ts:2713](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2713)* ___ -### Sharpness +### `` Sharpness -**● Sharpness**: *`number`* +**● Sharpness**: *`undefined` \| `number`* -*Defined in [api/types.ts:2714](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2714)* +*Defined in [api/types.ts:2714](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2714)* ___ -### WhiteBalance +### `` WhiteBalance **● WhiteBalance**: *[WhiteBalance20](_api_types_.whitebalance20.md)* -*Defined in [api/types.ts:2716](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2716)* +*Defined in [api/types.ts:2716](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2716)* ___ -### WideDynamicRange +### `` WideDynamicRange **● WideDynamicRange**: *[WideDynamicRange20](_api_types_.widedynamicrange20.md)* -*Defined in [api/types.ts:2715](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2715)* +*Defined in [api/types.ts:2715](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2715)* ___ diff --git a/docs/interfaces/_api_types_.imagingsettingsextension20.md b/docs/interfaces/_api_types_.imagingsettingsextension20.md index 6ef35c2..8ff0b68 100644 --- a/docs/interfaces/_api_types_.imagingsettingsextension20.md +++ b/docs/interfaces/_api_types_.imagingsettingsextension20.md @@ -21,20 +21,20 @@ Optional element to configure Image Stabilization feature. -### Extension +### `` Extension **● Extension**: *[ImagingSettingsExtension202](_api_types_.imagingsettingsextension202.md)* -*Defined in [api/types.ts:2725](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2725)* +*Defined in [api/types.ts:2725](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2725)* ___ -### ImageStabilization +### `` ImageStabilization -**● ImageStabilization**: *[ImageStabilization](_api_types_.imagestabilization.md)* +**● ImageStabilization**: *[ImageStabilization](_api_types_.imagingsettingsextension20.md#imagestabilization)* -*Defined in [api/types.ts:2724](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2724)* +*Defined in [api/types.ts:2724](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2724)* ___ diff --git a/docs/interfaces/_api_types_.imagingsettingsextension202.md b/docs/interfaces/_api_types_.imagingsettingsextension202.md index 5fa6b6c..8debc0b 100644 --- a/docs/interfaces/_api_types_.imagingsettingsextension202.md +++ b/docs/interfaces/_api_types_.imagingsettingsextension202.md @@ -21,20 +21,20 @@ An optional parameter applied to only auto mode to adjust timing of toggling Ir -### Extension +### `` Extension **● Extension**: *[ImagingSettingsExtension203](_api_types_.imagingsettingsextension203.md)* -*Defined in [api/types.ts:2733](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2733)* +*Defined in [api/types.ts:2733](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2733)* ___ -### IrCutFilterAutoAdjustment +### `` IrCutFilterAutoAdjustment -**● IrCutFilterAutoAdjustment**: *[IrCutFilterAutoAdjustment](_api_types_.ircutfilterautoadjustment.md)* +**● IrCutFilterAutoAdjustment**: *[IrCutFilterAutoAdjustment](_api_types_.imagingsettingsextension202.md#ircutfilterautoadjustment)* -*Defined in [api/types.ts:2732](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2732)* +*Defined in [api/types.ts:2732](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2732)* ___ diff --git a/docs/interfaces/_api_types_.imagingsettingsextension203.md b/docs/interfaces/_api_types_.imagingsettingsextension203.md index 4408c68..6082589 100644 --- a/docs/interfaces/_api_types_.imagingsettingsextension203.md +++ b/docs/interfaces/_api_types_.imagingsettingsextension203.md @@ -23,38 +23,38 @@ Optional element to configure Image Contrast Compensation. -### Defogging +### `` Defogging -**● Defogging**: *[Defogging](_api_types_.defogging.md)* +**● Defogging**: *[Defogging](_api_types_.imagingsettingsextension203.md#defogging)* -*Defined in [api/types.ts:2741](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2741)* +*Defined in [api/types.ts:2741](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2741)* ___ -### Extension +### `` Extension **● Extension**: *[ImagingSettingsExtension204](_api_types_.imagingsettingsextension204.md)* -*Defined in [api/types.ts:2743](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2743)* +*Defined in [api/types.ts:2743](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2743)* ___ -### NoiseReduction +### `` NoiseReduction -**● NoiseReduction**: *[NoiseReduction](_api_types_.noisereduction.md)* +**● NoiseReduction**: *[NoiseReduction](_api_types_.imagingsettingsextension203.md#noisereduction)* -*Defined in [api/types.ts:2742](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2742)* +*Defined in [api/types.ts:2742](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2742)* ___ -### ToneCompensation +### `` ToneCompensation -**● ToneCompensation**: *[ToneCompensation](_api_types_.tonecompensation.md)* +**● ToneCompensation**: *[ToneCompensation](_api_types_.imagingsettingsextension203.md#tonecompensation)* -*Defined in [api/types.ts:2740](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2740)* +*Defined in [api/types.ts:2740](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2740)* ___ diff --git a/docs/interfaces/_api_types_.imagingstatus.md b/docs/interfaces/_api_types_.imagingstatus.md index 13a89e2..3947069 100644 --- a/docs/interfaces/_api_types_.imagingstatus.md +++ b/docs/interfaces/_api_types_.imagingstatus.md @@ -22,7 +22,7 @@ **● FocusStatus**: *[FocusStatus](_api_types_.focusstatus.md)* -*Defined in [api/types.ts:2425](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2425)* +*Defined in [api/types.ts:2425](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2425)* ___ diff --git a/docs/interfaces/_api_types_.imagingstatus20.md b/docs/interfaces/_api_types_.imagingstatus20.md index d51a855..8f65a86 100644 --- a/docs/interfaces/_api_types_.imagingstatus20.md +++ b/docs/interfaces/_api_types_.imagingstatus20.md @@ -23,20 +23,20 @@ -### Extension +### `` Extension **● Extension**: *[ImagingStatus20Extension](_api_types_.imagingstatus20extension.md)* -*Defined in [api/types.ts:2676](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2676)* +*Defined in [api/types.ts:2676](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2676)* ___ -### FocusStatus20 +### `` FocusStatus20 -**● FocusStatus20**: *[FocusStatus20](_api_types_.focusstatus20.md)* +**● FocusStatus20**: *[FocusStatus20](_api_types_.imagingstatus20.md#focusstatus20)* -*Defined in [api/types.ts:2675](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2675)* +*Defined in [api/types.ts:2675](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2675)* ___ diff --git a/docs/interfaces/_api_types_.intlist.md b/docs/interfaces/_api_types_.intlist.md index 88d3313..a32f2b7 100644 --- a/docs/interfaces/_api_types_.intlist.md +++ b/docs/interfaces/_api_types_.intlist.md @@ -20,11 +20,11 @@ List of values. -### Items +### `` Items -**● Items**: *`number`* +**● Items**: *`undefined` \| `number`* -*Defined in [api/types.ts:306](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L306)* +*Defined in [api/types.ts:306](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L306)* ___ diff --git a/docs/interfaces/_api_types_.intrange.md b/docs/interfaces/_api_types_.intrange.md index 9bd0080..4286548 100644 --- a/docs/interfaces/_api_types_.intrange.md +++ b/docs/interfaces/_api_types_.intrange.md @@ -25,7 +25,7 @@ Range of values greater equal Min value and less equal Max value. **● Max**: *`number`* -*Defined in [api/types.ts:283](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L283)* +*Defined in [api/types.ts:283](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L283)* ___ @@ -34,7 +34,7 @@ ___ **● Min**: *`number`* -*Defined in [api/types.ts:282](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L282)* +*Defined in [api/types.ts:282](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L282)* ___ diff --git a/docs/interfaces/_api_types_.intrectanglerange.md b/docs/interfaces/_api_types_.intrectanglerange.md index 85c7050..5bd758e 100644 --- a/docs/interfaces/_api_types_.intrectanglerange.md +++ b/docs/interfaces/_api_types_.intrectanglerange.md @@ -27,7 +27,7 @@ Range of a rectangle. The rectangle itself is defined by lower left corner posit **● HeightRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:275](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L275)* +*Defined in [api/types.ts:275](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L275)* ___ @@ -36,7 +36,7 @@ ___ **● WidthRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:274](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L274)* +*Defined in [api/types.ts:274](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L274)* ___ @@ -45,7 +45,7 @@ ___ **● XRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:272](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L272)* +*Defined in [api/types.ts:272](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L272)* ___ @@ -54,7 +54,7 @@ ___ **● YRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:273](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L273)* +*Defined in [api/types.ts:273](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L273)* ___ diff --git a/docs/interfaces/_api_types_.iocapabilities.md b/docs/interfaces/_api_types_.iocapabilities.md index 2fd04b9..66d696c 100644 --- a/docs/interfaces/_api_types_.iocapabilities.md +++ b/docs/interfaces/_api_types_.iocapabilities.md @@ -22,29 +22,29 @@ Number of input connectors. -### Extension +### `` Extension **● Extension**: *[IOCapabilitiesExtension](_api_types_.iocapabilitiesextension.md)* -*Defined in [api/types.ts:1510](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1510)* +*Defined in [api/types.ts:1510](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1510)* ___ -### InputConnectors +### `` InputConnectors -**● InputConnectors**: *`number`* +**● InputConnectors**: *`undefined` \| `number`* -*Defined in [api/types.ts:1508](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1508)* +*Defined in [api/types.ts:1508](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1508)* ___ -### RelayOutputs +### `` RelayOutputs -**● RelayOutputs**: *`number`* +**● RelayOutputs**: *`undefined` \| `number`* -*Defined in [api/types.ts:1509](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1509)* +*Defined in [api/types.ts:1509](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1509)* ___ diff --git a/docs/interfaces/_api_types_.iocapabilitiesextension.md b/docs/interfaces/_api_types_.iocapabilitiesextension.md index a67cc75..1a8f6aa 100644 --- a/docs/interfaces/_api_types_.iocapabilitiesextension.md +++ b/docs/interfaces/_api_types_.iocapabilitiesextension.md @@ -20,20 +20,20 @@ -### Auxiliary +### `` Auxiliary -**● Auxiliary**: *`boolean`* +**● Auxiliary**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1517](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1517)* +*Defined in [api/types.ts:1517](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1517)* ___ -### AuxiliaryCommands +### `` AuxiliaryCommands **● AuxiliaryCommands**: *[AuxiliaryData](../modules/_api_types_.md#auxiliarydata)* -*Defined in [api/types.ts:1518](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1518)* +*Defined in [api/types.ts:1518](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1518)* ___ @@ -42,7 +42,7 @@ ___ **● Extension**: *[IOCapabilitiesExtension2](_api_types_.iocapabilitiesextension2.md)* -*Defined in [api/types.ts:1519](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1519)* +*Defined in [api/types.ts:1519](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1519)* ___ diff --git a/docs/interfaces/_api_types_.ipaddress.md b/docs/interfaces/_api_types_.ipaddress.md index 663f792..d264c78 100644 --- a/docs/interfaces/_api_types_.ipaddress.md +++ b/docs/interfaces/_api_types_.ipaddress.md @@ -22,20 +22,20 @@ Indicates if the address is an IPv4 or IPv6 address. -### IPv4Address +### `` IPv4Address **● IPv4Address**: *[IPv4Address](_api_types_.ipaddress.md#ipv4address)* -*Defined in [api/types.ts:1168](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1168)* +*Defined in [api/types.ts:1168](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1168)* ___ -### IPv6Address +### `` IPv6Address **● IPv6Address**: *[IPv6Address](_api_types_.ipaddress.md#ipv6address)* -*Defined in [api/types.ts:1169](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1169)* +*Defined in [api/types.ts:1169](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1169)* ___ @@ -44,7 +44,7 @@ ___ **● Type**: *[IPType](../enums/_api_types_.iptype.md)* -*Defined in [api/types.ts:1167](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1167)* +*Defined in [api/types.ts:1167](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1167)* ___ diff --git a/docs/interfaces/_api_types_.ipaddressfilter.md b/docs/interfaces/_api_types_.ipaddressfilter.md index 8d4bb76..fdf9aae 100644 --- a/docs/interfaces/_api_types_.ipaddressfilter.md +++ b/docs/interfaces/_api_types_.ipaddressfilter.md @@ -21,29 +21,29 @@ -### Extension +### `` Extension **● Extension**: *[IPAddressFilterExtension](_api_types_.ipaddressfilterextension.md)* -*Defined in [api/types.ts:1331](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1331)* +*Defined in [api/types.ts:1331](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1331)* ___ -### IPv4Address +### `` IPv4Address **● IPv4Address**: *[PrefixedIPv4Address](_api_types_.prefixedipv4address.md)* -*Defined in [api/types.ts:1329](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1329)* +*Defined in [api/types.ts:1329](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1329)* ___ -### IPv6Address +### `` IPv6Address **● IPv6Address**: *[PrefixedIPv6Address](_api_types_.prefixedipv6address.md)* -*Defined in [api/types.ts:1330](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1330)* +*Defined in [api/types.ts:1330](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1330)* ___ @@ -52,7 +52,7 @@ ___ **● Type**: *[IPAddressFilterType](../enums/_api_types_.ipaddressfiltertype.md)* -*Defined in [api/types.ts:1328](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1328)* +*Defined in [api/types.ts:1328](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1328)* ___ diff --git a/docs/interfaces/_api_types_.ipv4configuration.md b/docs/interfaces/_api_types_.ipv4configuration.md index 6504f69..172637f 100644 --- a/docs/interfaces/_api_types_.ipv4configuration.md +++ b/docs/interfaces/_api_types_.ipv4configuration.md @@ -27,34 +27,34 @@ List of manually added IPv4 addresses. **● DHCP**: *`boolean`* -*Defined in [api/types.ts:1108](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1108)* +*Defined in [api/types.ts:1108](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1108)* ___ -### FromDHCP +### `` FromDHCP **● FromDHCP**: *[PrefixedIPv4Address](_api_types_.prefixedipv4address.md)* -*Defined in [api/types.ts:1107](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1107)* +*Defined in [api/types.ts:1107](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1107)* ___ -### LinkLocal +### `` LinkLocal **● LinkLocal**: *[PrefixedIPv4Address](_api_types_.prefixedipv4address.md)* -*Defined in [api/types.ts:1106](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1106)* +*Defined in [api/types.ts:1106](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1106)* ___ -### Manual +### `` Manual **● Manual**: *[PrefixedIPv4Address](_api_types_.prefixedipv4address.md)* -*Defined in [api/types.ts:1105](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1105)* +*Defined in [api/types.ts:1105](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1105)* ___ diff --git a/docs/interfaces/_api_types_.ipv4networkinterface.md b/docs/interfaces/_api_types_.ipv4networkinterface.md index cb6f0fe..602bebf 100644 --- a/docs/interfaces/_api_types_.ipv4networkinterface.md +++ b/docs/interfaces/_api_types_.ipv4networkinterface.md @@ -25,7 +25,7 @@ Indicates whether or not IPv4 is enabled. **● Config**: *[IPv4Configuration](_api_types_.ipv4configuration.md)* -*Defined in [api/types.ts:1098](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1098)* +*Defined in [api/types.ts:1098](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1098)* ___ @@ -34,7 +34,7 @@ ___ **● Enabled**: *`boolean`* -*Defined in [api/types.ts:1097](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1097)* +*Defined in [api/types.ts:1097](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1097)* ___ diff --git a/docs/interfaces/_api_types_.ipv4networkinterfacesetconfiguration.md b/docs/interfaces/_api_types_.ipv4networkinterfacesetconfiguration.md index a093d59..9892a96 100644 --- a/docs/interfaces/_api_types_.ipv4networkinterfacesetconfiguration.md +++ b/docs/interfaces/_api_types_.ipv4networkinterfacesetconfiguration.md @@ -22,29 +22,29 @@ Indicates whether or not IPv4 is enabled. -### DHCP +### `` DHCP -**● DHCP**: *`boolean`* +**● DHCP**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1289](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1289)* +*Defined in [api/types.ts:1289](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1289)* ___ -### Enabled +### `` Enabled -**● Enabled**: *`boolean`* +**● Enabled**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1287](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1287)* +*Defined in [api/types.ts:1287](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1287)* ___ -### Manual +### `` Manual **● Manual**: *[PrefixedIPv4Address](_api_types_.prefixedipv4address.md)* -*Defined in [api/types.ts:1288](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1288)* +*Defined in [api/types.ts:1288](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1288)* ___ diff --git a/docs/interfaces/_api_types_.ipv6configuration.md b/docs/interfaces/_api_types_.ipv6configuration.md index c70eaf7..030597d 100644 --- a/docs/interfaces/_api_types_.ipv6configuration.md +++ b/docs/interfaces/_api_types_.ipv6configuration.md @@ -26,11 +26,11 @@ Indicates whether router advertisment is used. -### AcceptRouterAdvert +### `` AcceptRouterAdvert -**● AcceptRouterAdvert**: *`boolean`* +**● AcceptRouterAdvert**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1115](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1115)* +*Defined in [api/types.ts:1115](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1115)* ___ @@ -39,52 +39,52 @@ ___ **● DHCP**: *[IPv6DHCPConfiguration](../enums/_api_types_.ipv6dhcpconfiguration.md)* -*Defined in [api/types.ts:1116](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1116)* +*Defined in [api/types.ts:1116](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1116)* ___ -### Extension +### `` Extension **● Extension**: *[IPv6ConfigurationExtension](_api_types_.ipv6configurationextension.md)* -*Defined in [api/types.ts:1121](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1121)* +*Defined in [api/types.ts:1121](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1121)* ___ -### FromDHCP +### `` FromDHCP **● FromDHCP**: *[PrefixedIPv6Address](_api_types_.prefixedipv6address.md)* -*Defined in [api/types.ts:1119](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1119)* +*Defined in [api/types.ts:1119](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1119)* ___ -### FromRA +### `` FromRA **● FromRA**: *[PrefixedIPv6Address](_api_types_.prefixedipv6address.md)* -*Defined in [api/types.ts:1120](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1120)* +*Defined in [api/types.ts:1120](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1120)* ___ -### LinkLocal +### `` LinkLocal **● LinkLocal**: *[PrefixedIPv6Address](_api_types_.prefixedipv6address.md)* -*Defined in [api/types.ts:1118](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1118)* +*Defined in [api/types.ts:1118](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1118)* ___ -### Manual +### `` Manual **● Manual**: *[PrefixedIPv6Address](_api_types_.prefixedipv6address.md)* -*Defined in [api/types.ts:1117](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1117)* +*Defined in [api/types.ts:1117](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1117)* ___ diff --git a/docs/interfaces/_api_types_.ipv6networkinterface.md b/docs/interfaces/_api_types_.ipv6networkinterface.md index fb89a92..a132321 100644 --- a/docs/interfaces/_api_types_.ipv6networkinterface.md +++ b/docs/interfaces/_api_types_.ipv6networkinterface.md @@ -21,11 +21,11 @@ Indicates whether or not IPv6 is enabled. -### Config +### `` Config **● Config**: *[IPv6Configuration](_api_types_.ipv6configuration.md)* -*Defined in [api/types.ts:1090](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1090)* +*Defined in [api/types.ts:1090](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1090)* ___ @@ -34,7 +34,7 @@ ___ **● Enabled**: *`boolean`* -*Defined in [api/types.ts:1089](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1089)* +*Defined in [api/types.ts:1089](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1089)* ___ diff --git a/docs/interfaces/_api_types_.ipv6networkinterfacesetconfiguration.md b/docs/interfaces/_api_types_.ipv6networkinterfacesetconfiguration.md index 5b6f679..0d995b3 100644 --- a/docs/interfaces/_api_types_.ipv6networkinterfacesetconfiguration.md +++ b/docs/interfaces/_api_types_.ipv6networkinterfacesetconfiguration.md @@ -23,38 +23,38 @@ Indicates whether or not IPv6 is enabled. -### AcceptRouterAdvert +### `` AcceptRouterAdvert -**● AcceptRouterAdvert**: *`boolean`* +**● AcceptRouterAdvert**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1278](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1278)* +*Defined in [api/types.ts:1278](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1278)* ___ -### DHCP +### `` DHCP **● DHCP**: *[IPv6DHCPConfiguration](../enums/_api_types_.ipv6dhcpconfiguration.md)* -*Defined in [api/types.ts:1280](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1280)* +*Defined in [api/types.ts:1280](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1280)* ___ -### Enabled +### `` Enabled -**● Enabled**: *`boolean`* +**● Enabled**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1277](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1277)* +*Defined in [api/types.ts:1277](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1277)* ___ -### Manual +### `` Manual **● Manual**: *[PrefixedIPv6Address](_api_types_.prefixedipv6address.md)* -*Defined in [api/types.ts:1279](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1279)* +*Defined in [api/types.ts:1279](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1279)* ___ diff --git a/docs/interfaces/_api_types_.ircutfilterautoadjustment.md b/docs/interfaces/_api_types_.ircutfilterautoadjustment.md index a4f8338..ab05100 100644 --- a/docs/interfaces/_api_types_.ircutfilterautoadjustment.md +++ b/docs/interfaces/_api_types_.ircutfilterautoadjustment.md @@ -23,11 +23,11 @@ Specifies which boundaries to automatically toggle Ir cut filter following param -### BoundaryOffset +### `` BoundaryOffset -**● BoundaryOffset**: *`number`* +**● BoundaryOffset**: *`undefined` \| `number`* -*Defined in [api/types.ts:2772](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2772)* +*Defined in [api/types.ts:2772](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2772)* ___ @@ -36,25 +36,25 @@ ___ **● BoundaryType**: *`string`* -*Defined in [api/types.ts:2771](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2771)* +*Defined in [api/types.ts:2771](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2771)* ___ -### Extension +### `` Extension **● Extension**: *[IrCutFilterAutoAdjustmentExtension](_api_types_.ircutfilterautoadjustmentextension.md)* -*Defined in [api/types.ts:2774](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2774)* +*Defined in [api/types.ts:2774](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2774)* ___ -### ResponseTime +### `` ResponseTime -**● ResponseTime**: *`string`* +**● ResponseTime**: *`undefined` \| `string`* -*Defined in [api/types.ts:2773](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2773)* +*Defined in [api/types.ts:2773](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2773)* ___ diff --git a/docs/interfaces/_api_types_.ircutfilterautoadjustmentoptions.md b/docs/interfaces/_api_types_.ircutfilterautoadjustmentoptions.md index 28fe19d..9ee9a97 100644 --- a/docs/interfaces/_api_types_.ircutfilterautoadjustmentoptions.md +++ b/docs/interfaces/_api_types_.ircutfilterautoadjustmentoptions.md @@ -23,11 +23,11 @@ Supported options of boundary types for adjustment of Ir cut filter auto mode. T -### BoundaryOffset +### `` BoundaryOffset -**● BoundaryOffset**: *`boolean`* +**● BoundaryOffset**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:2925](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2925)* +*Defined in [api/types.ts:2925](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2925)* ___ @@ -36,25 +36,25 @@ ___ **● BoundaryType**: *`string`* -*Defined in [api/types.ts:2924](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2924)* +*Defined in [api/types.ts:2924](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2924)* ___ -### Extension +### `` Extension **● Extension**: *[IrCutFilterAutoAdjustmentOptionsExtension](_api_types_.ircutfilterautoadjustmentoptionsextension.md)* -*Defined in [api/types.ts:2927](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2927)* +*Defined in [api/types.ts:2927](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2927)* ___ -### ResponseTimeRange +### `` ResponseTimeRange **● ResponseTimeRange**: *[DurationRange](_api_types_.durationrange.md)* -*Defined in [api/types.ts:2926](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2926)* +*Defined in [api/types.ts:2926](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2926)* ___ diff --git a/docs/interfaces/_api_types_.itemlist.md b/docs/interfaces/_api_types_.itemlist.md index 98c36fb..59bc23b 100644 --- a/docs/interfaces/_api_types_.itemlist.md +++ b/docs/interfaces/_api_types_.itemlist.md @@ -25,29 +25,29 @@ -### ElementItem +### `` ElementItem **● ElementItem**: *`any`* -*Defined in [api/types.ts:3122](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3122)* +*Defined in [api/types.ts:3122](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3122)* ___ -### Extension +### `` Extension **● Extension**: *[ItemListExtension](_api_types_.itemlistextension.md)* -*Defined in [api/types.ts:3123](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3123)* +*Defined in [api/types.ts:3123](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3123)* ___ -### SimpleItem +### `` SimpleItem **● SimpleItem**: *`any`* -*Defined in [api/types.ts:3121](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3121)* +*Defined in [api/types.ts:3121](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3121)* ___ diff --git a/docs/interfaces/_api_types_.itemlistdescription.md b/docs/interfaces/_api_types_.itemlistdescription.md index 0561057..770ac5b 100644 --- a/docs/interfaces/_api_types_.itemlistdescription.md +++ b/docs/interfaces/_api_types_.itemlistdescription.md @@ -26,29 +26,29 @@ -### ElementItemDescription +### `` ElementItemDescription **● ElementItemDescription**: *`any`* -*Defined in [api/types.ts:3161](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3161)* +*Defined in [api/types.ts:3161](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3161)* ___ -### Extension +### `` Extension **● Extension**: *[ItemListDescriptionExtension](_api_types_.itemlistdescriptionextension.md)* -*Defined in [api/types.ts:3162](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3162)* +*Defined in [api/types.ts:3162](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3162)* ___ -### SimpleItemDescription +### `` SimpleItemDescription **● SimpleItemDescription**: *`any`* -*Defined in [api/types.ts:3160](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3160)* +*Defined in [api/types.ts:3160](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3160)* ___ diff --git a/docs/interfaces/_api_types_.jpegdecoptions.md b/docs/interfaces/_api_types_.jpegdecoptions.md index 84c3b6c..501279e 100644 --- a/docs/interfaces/_api_types_.jpegdecoptions.md +++ b/docs/interfaces/_api_types_.jpegdecoptions.md @@ -26,7 +26,7 @@ List of supported Jpeg Video Resolutions **● ResolutionsAvailable**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:888](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L888)* +*Defined in [api/types.ts:888](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L888)* ___ @@ -35,7 +35,7 @@ ___ **● SupportedFrameRate**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:890](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L890)* +*Defined in [api/types.ts:890](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L890)* ___ @@ -44,7 +44,7 @@ ___ **● SupportedInputBitrate**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:889](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L889)* +*Defined in [api/types.ts:889](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L889)* ___ diff --git a/docs/interfaces/_api_types_.jpegoptions.md b/docs/interfaces/_api_types_.jpegoptions.md index 4e4da79..7b0517e 100644 --- a/docs/interfaces/_api_types_.jpegoptions.md +++ b/docs/interfaces/_api_types_.jpegoptions.md @@ -26,7 +26,7 @@ List of supported image sizes. **● EncodingIntervalRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:602](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L602)* +*Defined in [api/types.ts:602](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L602)* ___ @@ -35,7 +35,7 @@ ___ **● FrameRateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:601](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L601)* +*Defined in [api/types.ts:601](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L601)* ___ @@ -44,7 +44,7 @@ ___ **● ResolutionsAvailable**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:600](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L600)* +*Defined in [api/types.ts:600](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L600)* ___ diff --git a/docs/interfaces/_api_types_.jpegoptions2.md b/docs/interfaces/_api_types_.jpegoptions2.md index 2c40dc9..2bfcb6b 100644 --- a/docs/interfaces/_api_types_.jpegoptions2.md +++ b/docs/interfaces/_api_types_.jpegoptions2.md @@ -24,7 +24,7 @@ Supported range of encoded bitrate in kbps. **● BitrateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:609](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L609)* +*Defined in [api/types.ts:609](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L609)* ___ diff --git a/docs/interfaces/_api_types_.layout.md b/docs/interfaces/_api_types_.layout.md index 573c11e..2a1cd7c 100644 --- a/docs/interfaces/_api_types_.layout.md +++ b/docs/interfaces/_api_types_.layout.md @@ -21,11 +21,11 @@ A layout describes a set of Video windows that are displayed simultaniously on a -### Extension +### `` Extension **● Extension**: *[LayoutExtension](_api_types_.layoutextension.md)* -*Defined in [api/types.ts:3340](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3340)* +*Defined in [api/types.ts:3340](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3340)* ___ @@ -34,7 +34,7 @@ ___ **● PaneLayout**: *[PaneLayout](_api_types_.panelayout.md)* -*Defined in [api/types.ts:3339](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3339)* +*Defined in [api/types.ts:3339](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3339)* ___ diff --git a/docs/interfaces/_api_types_.layoutoptions.md b/docs/interfaces/_api_types_.layoutoptions.md index 64a5da5..27530a9 100644 --- a/docs/interfaces/_api_types_.layoutoptions.md +++ b/docs/interfaces/_api_types_.layoutoptions.md @@ -21,11 +21,11 @@ The options supported for a display layout. -### Extension +### `` Extension **● Extension**: *[LayoutOptionsExtension](_api_types_.layoutoptionsextension.md)* -*Defined in [api/types.ts:3363](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3363)* +*Defined in [api/types.ts:3363](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3363)* ___ @@ -34,7 +34,7 @@ ___ **● PaneLayoutOptions**: *[PaneLayoutOptions](_api_types_.panelayoutoptions.md)* -*Defined in [api/types.ts:3362](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3362)* +*Defined in [api/types.ts:3362](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3362)* ___ diff --git a/docs/interfaces/_api_types_.lensdescription.md b/docs/interfaces/_api_types_.lensdescription.md index e0a2ba2..97325fa 100644 --- a/docs/interfaces/_api_types_.lensdescription.md +++ b/docs/interfaces/_api_types_.lensdescription.md @@ -26,7 +26,7 @@ Offset of the lens center to the imager center in normalized coordinates. **● Offset**: *[LensOffset](_api_types_.lensoffset.md)* -*Defined in [api/types.ts:464](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L464)* +*Defined in [api/types.ts:464](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L464)* ___ @@ -35,7 +35,7 @@ ___ **● Projection**: *[LensProjection](_api_types_.lensprojection.md)* -*Defined in [api/types.ts:465](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L465)* +*Defined in [api/types.ts:465](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L465)* ___ @@ -44,7 +44,7 @@ ___ **● XFactor**: *`number`* -*Defined in [api/types.ts:466](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L466)* +*Defined in [api/types.ts:466](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L466)* ___ diff --git a/docs/interfaces/_api_types_.lensprojection.md b/docs/interfaces/_api_types_.lensprojection.md index 4fd937e..cd9fc6e 100644 --- a/docs/interfaces/_api_types_.lensprojection.md +++ b/docs/interfaces/_api_types_.lensprojection.md @@ -26,7 +26,7 @@ Angle of incidence. **● Angle**: *`number`* -*Defined in [api/types.ts:449](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L449)* +*Defined in [api/types.ts:449](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L449)* ___ @@ -35,16 +35,16 @@ ___ **● Radius**: *`number`* -*Defined in [api/types.ts:450](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L450)* +*Defined in [api/types.ts:450](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L450)* ___ -### Transmittance +### `` Transmittance -**● Transmittance**: *`number`* +**● Transmittance**: *`undefined` \| `number`* -*Defined in [api/types.ts:451](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L451)* +*Defined in [api/types.ts:451](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L451)* ___ diff --git a/docs/interfaces/_api_types_.locationentity.md b/docs/interfaces/_api_types_.locationentity.md index eb53545..4c353f5 100644 --- a/docs/interfaces/_api_types_.locationentity.md +++ b/docs/interfaces/_api_types_.locationentity.md @@ -23,38 +23,38 @@ Location on earth. -### GeoLocation +### `` GeoLocation -**● GeoLocation**: *[GeoLocation](_api_types_.geolocation.md)* +**● GeoLocation**: *[GeoLocation](_api_types_.locationentity.md#geolocation)* -*Defined in [api/types.ts:250](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L250)* +*Defined in [api/types.ts:250](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L250)* ___ -### GeoOrientation +### `` GeoOrientation -**● GeoOrientation**: *[GeoOrientation](_api_types_.geoorientation.md)* +**● GeoOrientation**: *[GeoOrientation](_api_types_.locationentity.md#geoorientation)* -*Defined in [api/types.ts:251](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L251)* +*Defined in [api/types.ts:251](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L251)* ___ -### LocalLocation +### `` LocalLocation -**● LocalLocation**: *[LocalLocation](_api_types_.locallocation.md)* +**● LocalLocation**: *[LocalLocation](_api_types_.locationentity.md#locallocation)* -*Defined in [api/types.ts:252](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L252)* +*Defined in [api/types.ts:252](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L252)* ___ -### LocalOrientation +### `` LocalOrientation -**● LocalOrientation**: *[LocalOrientation](_api_types_.localorientation.md)* +**● LocalOrientation**: *[LocalOrientation](_api_types_.locationentity.md#localorientation)* -*Defined in [api/types.ts:253](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L253)* +*Defined in [api/types.ts:253](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L253)* ___ diff --git a/docs/interfaces/_api_types_.mediaattributes.md b/docs/interfaces/_api_types_.mediaattributes.md index cc2aaeb..871219d 100644 --- a/docs/interfaces/_api_types_.mediaattributes.md +++ b/docs/interfaces/_api_types_.mediaattributes.md @@ -27,7 +27,7 @@ A set of media attributes valid for a recording at a point in time or for a time **● From**: *`string`* -*Defined in [api/types.ts:3589](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3589)* +*Defined in [api/types.ts:3589](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3589)* ___ @@ -36,16 +36,16 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3587](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3587)* +*Defined in [api/types.ts:3587](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3587)* ___ -### TrackAttributes +### `` TrackAttributes -**● TrackAttributes**: *[TrackAttributes](_api_types_.trackattributes.md)* +**● TrackAttributes**: *[TrackAttributes](_api_types_.mediaattributes.md#trackattributes)* -*Defined in [api/types.ts:3588](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3588)* +*Defined in [api/types.ts:3588](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3588)* ___ @@ -54,7 +54,7 @@ ___ **● Until**: *`string`* -*Defined in [api/types.ts:3590](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3590)* +*Defined in [api/types.ts:3590](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3590)* ___ diff --git a/docs/interfaces/_api_types_.mediacapabilities.md b/docs/interfaces/_api_types_.mediacapabilities.md index ed7f6e1..f8957f1 100644 --- a/docs/interfaces/_api_types_.mediacapabilities.md +++ b/docs/interfaces/_api_types_.mediacapabilities.md @@ -22,11 +22,11 @@ Media service URI. -### Extension +### `` Extension **● Extension**: *[MediaCapabilitiesExtension](_api_types_.mediacapabilitiesextension.md)* -*Defined in [api/types.ts:1534](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1534)* +*Defined in [api/types.ts:1534](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1534)* ___ @@ -35,7 +35,7 @@ ___ **● StreamingCapabilities**: *[RealTimeStreamingCapabilities](_api_types_.realtimestreamingcapabilities.md)* -*Defined in [api/types.ts:1533](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1533)* +*Defined in [api/types.ts:1533](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1533)* ___ @@ -44,7 +44,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1532](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1532)* +*Defined in [api/types.ts:1532](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1532)* ___ diff --git a/docs/interfaces/_api_types_.mediacapabilitiesextension.md b/docs/interfaces/_api_types_.mediacapabilitiesextension.md index f20187b..71519aa 100644 --- a/docs/interfaces/_api_types_.mediacapabilitiesextension.md +++ b/docs/interfaces/_api_types_.mediacapabilitiesextension.md @@ -22,7 +22,7 @@ **● ProfileCapabilities**: *[ProfileCapabilities](_api_types_.profilecapabilities.md)* -*Defined in [api/types.ts:1541](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1541)* +*Defined in [api/types.ts:1541](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1541)* ___ diff --git a/docs/interfaces/_api_types_.mediauri.md b/docs/interfaces/_api_types_.mediauri.md index 29c9083..a628ba7 100644 --- a/docs/interfaces/_api_types_.mediauri.md +++ b/docs/interfaces/_api_types_.mediauri.md @@ -27,7 +27,7 @@ Stable Uri to be used for requesting the media stream **● InvalidAfterConnect**: *`boolean`* -*Defined in [api/types.ts:1011](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1011)* +*Defined in [api/types.ts:1011](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1011)* ___ @@ -36,7 +36,7 @@ ___ **● InvalidAfterReboot**: *`boolean`* -*Defined in [api/types.ts:1012](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1012)* +*Defined in [api/types.ts:1012](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1012)* ___ @@ -45,7 +45,7 @@ ___ **● Timeout**: *`string`* -*Defined in [api/types.ts:1013](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1013)* +*Defined in [api/types.ts:1013](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1013)* ___ @@ -54,7 +54,7 @@ ___ **● Uri**: *`string`* -*Defined in [api/types.ts:1010](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1010)* +*Defined in [api/types.ts:1010](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1010)* ___ diff --git a/docs/interfaces/_api_types_.messagedescription.md b/docs/interfaces/_api_types_.messagedescription.md index 672bdd6..af74187 100644 --- a/docs/interfaces/_api_types_.messagedescription.md +++ b/docs/interfaces/_api_types_.messagedescription.md @@ -23,38 +23,38 @@ Set of tokens producing this message. The list may only contain SimpleItemDescri -### Data +### `` Data **● Data**: *[ItemListDescription](_api_types_.itemlistdescription.md)* -*Defined in [api/types.ts:3142](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3142)* +*Defined in [api/types.ts:3142](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3142)* ___ -### Extension +### `` Extension **● Extension**: *[MessageDescriptionExtension](_api_types_.messagedescriptionextension.md)* -*Defined in [api/types.ts:3143](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3143)* +*Defined in [api/types.ts:3143](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3143)* ___ -### Key +### `` Key **● Key**: *[ItemListDescription](_api_types_.itemlistdescription.md)* -*Defined in [api/types.ts:3141](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3141)* +*Defined in [api/types.ts:3141](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3141)* ___ -### Source +### `` Source **● Source**: *[ItemListDescription](_api_types_.itemlistdescription.md)* -*Defined in [api/types.ts:3140](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3140)* +*Defined in [api/types.ts:3140](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3140)* ___ diff --git a/docs/interfaces/_api_types_.metadataattributes.md b/docs/interfaces/_api_types_.metadataattributes.md index 952b124..6ad1c43 100644 --- a/docs/interfaces/_api_types_.metadataattributes.md +++ b/docs/interfaces/_api_types_.metadataattributes.md @@ -26,7 +26,7 @@ Indicates that there can be PTZ data in the metadata track in the specified time **● CanContainAnalytics**: *`boolean`* -*Defined in [api/types.ts:3635](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3635)* +*Defined in [api/types.ts:3635](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3635)* ___ @@ -35,7 +35,7 @@ ___ **● CanContainNotifications**: *`boolean`* -*Defined in [api/types.ts:3636](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3636)* +*Defined in [api/types.ts:3636](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3636)* ___ @@ -44,7 +44,7 @@ ___ **● CanContainPTZ**: *`boolean`* -*Defined in [api/types.ts:3634](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3634)* +*Defined in [api/types.ts:3634](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3634)* ___ diff --git a/docs/interfaces/_api_types_.metadataconfiguration.md b/docs/interfaces/_api_types_.metadataconfiguration.md index 092c75b..069fd42 100644 --- a/docs/interfaces/_api_types_.metadataconfiguration.md +++ b/docs/interfaces/_api_types_.metadataconfiguration.md @@ -26,38 +26,38 @@ optional element to configure which PTZ related data is to include in the metada -### Analytics +### `` Analytics -**● Analytics**: *`boolean`* +**● Analytics**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:766](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L766)* +*Defined in [api/types.ts:766](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L766)* ___ -### AnalyticsEngineConfiguration +### `` AnalyticsEngineConfiguration -**● AnalyticsEngineConfiguration**: *[AnalyticsEngineConfiguration](_api_types_.analyticsengineconfiguration.md)* +**● AnalyticsEngineConfiguration**: *[AnalyticsEngineConfiguration](_api_types_.metadataconfiguration.md#analyticsengineconfiguration)* -*Defined in [api/types.ts:769](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L769)* +*Defined in [api/types.ts:769](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L769)* ___ -### Events +### `` Events **● Events**: *[EventSubscription](_api_types_.eventsubscription.md)* -*Defined in [api/types.ts:765](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L765)* +*Defined in [api/types.ts:765](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L765)* ___ -### Extension +### `` Extension **● Extension**: *[MetadataConfigurationExtension](_api_types_.metadataconfigurationextension.md)* -*Defined in [api/types.ts:770](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L770)* +*Defined in [api/types.ts:770](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L770)* ___ @@ -66,16 +66,16 @@ ___ **● Multicast**: *[MulticastConfiguration](_api_types_.multicastconfiguration.md)* -*Defined in [api/types.ts:767](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L767)* +*Defined in [api/types.ts:767](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L767)* ___ -### PTZStatus +### `` PTZStatus **● PTZStatus**: *[PTZFilter](_api_types_.ptzfilter.md)* -*Defined in [api/types.ts:764](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L764)* +*Defined in [api/types.ts:764](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L764)* ___ @@ -84,7 +84,7 @@ ___ **● SessionTimeout**: *`string`* -*Defined in [api/types.ts:768](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L768)* +*Defined in [api/types.ts:768](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L768)* ___ diff --git a/docs/interfaces/_api_types_.metadataconfigurationoptions.md b/docs/interfaces/_api_types_.metadataconfigurationoptions.md index 98cea52..0814b88 100644 --- a/docs/interfaces/_api_types_.metadataconfigurationoptions.md +++ b/docs/interfaces/_api_types_.metadataconfigurationoptions.md @@ -21,11 +21,11 @@ True if the device is able to stream the Geo Located positions of each target. -### Extension +### `` Extension **● Extension**: *[MetadataConfigurationOptionsExtension](_api_types_.metadataconfigurationoptionsextension.md)* -*Defined in [api/types.ts:800](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L800)* +*Defined in [api/types.ts:800](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L800)* ___ @@ -34,7 +34,7 @@ ___ **● PTZStatusFilterOptions**: *[PTZStatusFilterOptions](_api_types_.ptzstatusfilteroptions.md)* -*Defined in [api/types.ts:799](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L799)* +*Defined in [api/types.ts:799](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L799)* ___ diff --git a/docs/interfaces/_api_types_.metadataconfigurationoptionsextension.md b/docs/interfaces/_api_types_.metadataconfigurationoptionsextension.md index ddb82f7..b393aaf 100644 --- a/docs/interfaces/_api_types_.metadataconfigurationoptionsextension.md +++ b/docs/interfaces/_api_types_.metadataconfigurationoptionsextension.md @@ -21,20 +21,20 @@ List of supported metadata compression type. Its options shall be chosen from tt -### CompressionType +### `` CompressionType -**● CompressionType**: *`string`* +**● CompressionType**: *`undefined` \| `string`* -*Defined in [api/types.ts:807](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L807)* +*Defined in [api/types.ts:807](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L807)* ___ -### Extension +### `` Extension **● Extension**: *[MetadataConfigurationOptionsExtension2](_api_types_.metadataconfigurationoptionsextension2.md)* -*Defined in [api/types.ts:808](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L808)* +*Defined in [api/types.ts:808](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L808)* ___ diff --git a/docs/interfaces/_api_types_.metadatafilter.md b/docs/interfaces/_api_types_.metadatafilter.md index 96d8425..6e9ddbf 100644 --- a/docs/interfaces/_api_types_.metadatafilter.md +++ b/docs/interfaces/_api_types_.metadatafilter.md @@ -22,7 +22,7 @@ **● MetadataStreamFilter**: *[XPathExpression](../modules/_api_types_.md#xpathexpression)* -*Defined in [api/types.ts:3476](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3476)* +*Defined in [api/types.ts:3476](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3476)* ___ diff --git a/docs/interfaces/_api_types_.metadatainput.md b/docs/interfaces/_api_types_.metadatainput.md index c3797b2..f514a3e 100644 --- a/docs/interfaces/_api_types_.metadatainput.md +++ b/docs/interfaces/_api_types_.metadatainput.md @@ -19,20 +19,20 @@ -### Extension +### `` Extension **● Extension**: *[MetadataInputExtension](_api_types_.metadatainputextension.md)* -*Defined in [api/types.ts:3859](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3859)* +*Defined in [api/types.ts:3859](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3859)* ___ -### MetadataConfig +### `` MetadataConfig **● MetadataConfig**: *[Config](_api_types_.config.md)* -*Defined in [api/types.ts:3858](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3858)* +*Defined in [api/types.ts:3858](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3858)* ___ diff --git a/docs/interfaces/_api_types_.motionexpression.md b/docs/interfaces/_api_types_.motionexpression.md index f5a4ea7..1ca5a1c 100644 --- a/docs/interfaces/_api_types_.motionexpression.md +++ b/docs/interfaces/_api_types_.motionexpression.md @@ -24,7 +24,7 @@ Motion Expression data structure contains motion expression which is based on Sc **● Expression**: *`string`* -*Defined in [api/types.ts:3298](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3298)* +*Defined in [api/types.ts:3298](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3298)* ___ diff --git a/docs/interfaces/_api_types_.motionexpressionconfiguration.md b/docs/interfaces/_api_types_.motionexpressionconfiguration.md index 32bfbd6..1460ea4 100644 --- a/docs/interfaces/_api_types_.motionexpressionconfiguration.md +++ b/docs/interfaces/_api_types_.motionexpressionconfiguration.md @@ -24,7 +24,7 @@ Contains Rule MotionExpression configuration **● MotionExpression**: *[MotionExpression](_api_types_.motionexpression.md)* -*Defined in [api/types.ts:3305](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3305)* +*Defined in [api/types.ts:3305](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3305)* ___ diff --git a/docs/interfaces/_api_types_.moveoptions.md b/docs/interfaces/_api_types_.moveoptions.md index 561707b..1558f2d 100644 --- a/docs/interfaces/_api_types_.moveoptions.md +++ b/docs/interfaces/_api_types_.moveoptions.md @@ -20,29 +20,29 @@ -### Absolute +### `` Absolute **● Absolute**: *[AbsoluteFocusOptions](_api_types_.absolutefocusoptions.md)* -*Defined in [api/types.ts:2626](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2626)* +*Defined in [api/types.ts:2626](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2626)* ___ -### Continuous +### `` Continuous **● Continuous**: *[ContinuousFocusOptions](_api_types_.continuousfocusoptions.md)* -*Defined in [api/types.ts:2628](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2628)* +*Defined in [api/types.ts:2628](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2628)* ___ -### Relative +### `` Relative **● Relative**: *[RelativeFocusOptions](_api_types_.relativefocusoptions.md)* -*Defined in [api/types.ts:2627](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2627)* +*Defined in [api/types.ts:2627](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2627)* ___ diff --git a/docs/interfaces/_api_types_.moveoptions20.md b/docs/interfaces/_api_types_.moveoptions20.md index db0e19f..05b774b 100644 --- a/docs/interfaces/_api_types_.moveoptions20.md +++ b/docs/interfaces/_api_types_.moveoptions20.md @@ -24,29 +24,29 @@ -### Absolute +### `` Absolute **● Absolute**: *[AbsoluteFocusOptions](_api_types_.absolutefocusoptions.md)* -*Defined in [api/types.ts:2983](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2983)* +*Defined in [api/types.ts:2983](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2983)* ___ -### Continuous +### `` Continuous **● Continuous**: *[ContinuousFocusOptions](_api_types_.continuousfocusoptions.md)* -*Defined in [api/types.ts:2985](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2985)* +*Defined in [api/types.ts:2985](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2985)* ___ -### Relative +### `` Relative **● Relative**: *[RelativeFocusOptions20](_api_types_.relativefocusoptions20.md)* -*Defined in [api/types.ts:2984](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2984)* +*Defined in [api/types.ts:2984](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2984)* ___ diff --git a/docs/interfaces/_api_types_.mpeg4configuration.md b/docs/interfaces/_api_types_.mpeg4configuration.md index a041f5a..56f9d4b 100644 --- a/docs/interfaces/_api_types_.mpeg4configuration.md +++ b/docs/interfaces/_api_types_.mpeg4configuration.md @@ -25,7 +25,7 @@ Determines the interval in which the I-Frames will be coded. An entry of 1 indic **● GovLength**: *`number`* -*Defined in [api/types.ts:557](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L557)* +*Defined in [api/types.ts:557](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L557)* ___ @@ -34,7 +34,7 @@ ___ **● Mpeg4Profile**: *[Mpeg4Profile](../enums/_api_types_.mpeg4profile.md)* -*Defined in [api/types.ts:558](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L558)* +*Defined in [api/types.ts:558](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L558)* ___ diff --git a/docs/interfaces/_api_types_.mpeg4decoptions.md b/docs/interfaces/_api_types_.mpeg4decoptions.md index 880d553..8782ecd 100644 --- a/docs/interfaces/_api_types_.mpeg4decoptions.md +++ b/docs/interfaces/_api_types_.mpeg4decoptions.md @@ -27,7 +27,7 @@ List of supported Mpeg4 Video Resolutions **● ResolutionsAvailable**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:897](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L897)* +*Defined in [api/types.ts:897](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L897)* ___ @@ -36,7 +36,7 @@ ___ **● SupportedFrameRate**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:900](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L900)* +*Defined in [api/types.ts:900](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L900)* ___ @@ -45,7 +45,7 @@ ___ **● SupportedInputBitrate**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:899](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L899)* +*Defined in [api/types.ts:899](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L899)* ___ @@ -54,7 +54,7 @@ ___ **● SupportedMpeg4Profiles**: *[Mpeg4Profile](../enums/_api_types_.mpeg4profile.md)* -*Defined in [api/types.ts:898](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L898)* +*Defined in [api/types.ts:898](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L898)* ___ diff --git a/docs/interfaces/_api_types_.mpeg4options.md b/docs/interfaces/_api_types_.mpeg4options.md index 07f5230..a03dd58 100644 --- a/docs/interfaces/_api_types_.mpeg4options.md +++ b/docs/interfaces/_api_types_.mpeg4options.md @@ -28,7 +28,7 @@ List of supported image sizes. **● EncodingIntervalRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:619](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L619)* +*Defined in [api/types.ts:619](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L619)* ___ @@ -37,7 +37,7 @@ ___ **● FrameRateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:618](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L618)* +*Defined in [api/types.ts:618](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L618)* ___ @@ -46,7 +46,7 @@ ___ **● GovLengthRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:617](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L617)* +*Defined in [api/types.ts:617](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L617)* ___ @@ -55,7 +55,7 @@ ___ **● Mpeg4ProfilesSupported**: *[Mpeg4Profile](../enums/_api_types_.mpeg4profile.md)* -*Defined in [api/types.ts:620](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L620)* +*Defined in [api/types.ts:620](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L620)* ___ @@ -64,7 +64,7 @@ ___ **● ResolutionsAvailable**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:616](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L616)* +*Defined in [api/types.ts:616](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L616)* ___ diff --git a/docs/interfaces/_api_types_.mpeg4options2.md b/docs/interfaces/_api_types_.mpeg4options2.md index 237e7a4..4a32df0 100644 --- a/docs/interfaces/_api_types_.mpeg4options2.md +++ b/docs/interfaces/_api_types_.mpeg4options2.md @@ -24,7 +24,7 @@ Supported range of encoded bitrate in kbps. **● BitrateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:627](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L627)* +*Defined in [api/types.ts:627](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L627)* ___ diff --git a/docs/interfaces/_api_types_.multicastconfiguration.md b/docs/interfaces/_api_types_.multicastconfiguration.md index 9f0af22..d3e70c2 100644 --- a/docs/interfaces/_api_types_.multicastconfiguration.md +++ b/docs/interfaces/_api_types_.multicastconfiguration.md @@ -27,7 +27,7 @@ The multicast address (if this address is set to 0 no multicast streaming is ena **● Address**: *[IPAddress](_api_types_.ipaddress.md)* -*Defined in [api/types.ts:984](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L984)* +*Defined in [api/types.ts:984](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L984)* ___ @@ -36,7 +36,7 @@ ___ **● AutoStart**: *`boolean`* -*Defined in [api/types.ts:987](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L987)* +*Defined in [api/types.ts:987](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L987)* ___ @@ -45,7 +45,7 @@ ___ **● Port**: *`number`* -*Defined in [api/types.ts:985](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L985)* +*Defined in [api/types.ts:985](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L985)* ___ @@ -54,7 +54,7 @@ ___ **● TTL**: *`number`* -*Defined in [api/types.ts:986](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L986)* +*Defined in [api/types.ts:986](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L986)* ___ diff --git a/docs/interfaces/_api_types_.networkcapabilities.md b/docs/interfaces/_api_types_.networkcapabilities.md index 206a974..49ee698 100644 --- a/docs/interfaces/_api_types_.networkcapabilities.md +++ b/docs/interfaces/_api_types_.networkcapabilities.md @@ -24,47 +24,47 @@ Indicates whether or not IP filtering is supported. -### DynDNS +### `` DynDNS -**● DynDNS**: *`boolean`* +**● DynDNS**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1574](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1574)* +*Defined in [api/types.ts:1574](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1574)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkCapabilitiesExtension](_api_types_.networkcapabilitiesextension.md)* -*Defined in [api/types.ts:1575](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1575)* +*Defined in [api/types.ts:1575](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1575)* ___ -### IPFilter +### `` IPFilter -**● IPFilter**: *`boolean`* +**● IPFilter**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1571](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1571)* +*Defined in [api/types.ts:1571](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1571)* ___ -### IPVersion6 +### `` IPVersion6 -**● IPVersion6**: *`boolean`* +**● IPVersion6**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1573](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1573)* +*Defined in [api/types.ts:1573](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1573)* ___ -### ZeroConfiguration +### `` ZeroConfiguration -**● ZeroConfiguration**: *`boolean`* +**● ZeroConfiguration**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1572](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1572)* +*Defined in [api/types.ts:1572](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1572)* ___ diff --git a/docs/interfaces/_api_types_.networkcapabilitiesextension.md b/docs/interfaces/_api_types_.networkcapabilitiesextension.md index 1c38c4f..a794e5e 100644 --- a/docs/interfaces/_api_types_.networkcapabilitiesextension.md +++ b/docs/interfaces/_api_types_.networkcapabilitiesextension.md @@ -19,20 +19,20 @@ -### Dot11Configuration +### `` Dot11Configuration -**● Dot11Configuration**: *`boolean`* +**● Dot11Configuration**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1582](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1582)* +*Defined in [api/types.ts:1582](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1582)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkCapabilitiesExtension2](_api_types_.networkcapabilitiesextension2.md)* -*Defined in [api/types.ts:1583](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1583)* +*Defined in [api/types.ts:1583](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1583)* ___ diff --git a/docs/interfaces/_api_types_.networkgateway.md b/docs/interfaces/_api_types_.networkgateway.md index 2d7cb5b..a7cf061 100644 --- a/docs/interfaces/_api_types_.networkgateway.md +++ b/docs/interfaces/_api_types_.networkgateway.md @@ -21,20 +21,20 @@ IPv4 address string. -### IPv4Address +### `` IPv4Address **● IPv4Address**: *[IPv4Address](_api_types_.networkgateway.md#ipv4address)* -*Defined in [api/types.ts:1296](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1296)* +*Defined in [api/types.ts:1296](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1296)* ___ -### IPv6Address +### `` IPv6Address **● IPv6Address**: *[IPv6Address](_api_types_.networkgateway.md#ipv6address)* -*Defined in [api/types.ts:1297](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1297)* +*Defined in [api/types.ts:1297](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1297)* ___ diff --git a/docs/interfaces/_api_types_.networkhost.md b/docs/interfaces/_api_types_.networkhost.md index 9114007..c4e9093 100644 --- a/docs/interfaces/_api_types_.networkhost.md +++ b/docs/interfaces/_api_types_.networkhost.md @@ -24,38 +24,38 @@ Network host type: IPv4, IPv6 or DNS. -### DNSname +### `` DNSname **● DNSname**: *[DNSName](../modules/_api_types_.md#dnsname)* -*Defined in [api/types.ts:1153](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1153)* +*Defined in [api/types.ts:1153](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1153)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkHostExtension](_api_types_.networkhostextension.md)* -*Defined in [api/types.ts:1154](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1154)* +*Defined in [api/types.ts:1154](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1154)* ___ -### IPv4Address +### `` IPv4Address **● IPv4Address**: *[IPv4Address](_api_types_.networkhost.md#ipv4address)* -*Defined in [api/types.ts:1151](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1151)* +*Defined in [api/types.ts:1151](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1151)* ___ -### IPv6Address +### `` IPv6Address **● IPv6Address**: *[IPv6Address](_api_types_.networkhost.md#ipv6address)* -*Defined in [api/types.ts:1152](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1152)* +*Defined in [api/types.ts:1152](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1152)* ___ @@ -64,7 +64,7 @@ ___ **● Type**: *[NetworkHostType](../enums/_api_types_.networkhosttype.md)* -*Defined in [api/types.ts:1150](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1150)* +*Defined in [api/types.ts:1150](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1150)* ___ diff --git a/docs/interfaces/_api_types_.networkinterface.md b/docs/interfaces/_api_types_.networkinterface.md index 9bc0231..d17c3aa 100644 --- a/docs/interfaces/_api_types_.networkinterface.md +++ b/docs/interfaces/_api_types_.networkinterface.md @@ -29,52 +29,52 @@ Indicates whether or not an interface is enabled. **● Enabled**: *`boolean`* -*Defined in [api/types.ts:1028](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1028)* +*Defined in [api/types.ts:1028](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1028)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkInterfaceExtension](_api_types_.networkinterfaceextension.md)* -*Defined in [api/types.ts:1033](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1033)* +*Defined in [api/types.ts:1033](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1033)* ___ -### IPv4 +### `` IPv4 **● IPv4**: *[IPv4NetworkInterface](_api_types_.ipv4networkinterface.md)* -*Defined in [api/types.ts:1031](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1031)* +*Defined in [api/types.ts:1031](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1031)* ___ -### IPv6 +### `` IPv6 **● IPv6**: *[IPv6NetworkInterface](_api_types_.ipv6networkinterface.md)* -*Defined in [api/types.ts:1032](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1032)* +*Defined in [api/types.ts:1032](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1032)* ___ -### Info +### `` Info **● Info**: *[NetworkInterfaceInfo](_api_types_.networkinterfaceinfo.md)* -*Defined in [api/types.ts:1029](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1029)* +*Defined in [api/types.ts:1029](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1029)* ___ -### Link +### `` Link **● Link**: *[NetworkInterfaceLink](_api_types_.networkinterfacelink.md)* -*Defined in [api/types.ts:1030](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1030)* +*Defined in [api/types.ts:1030](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1030)* ___ diff --git a/docs/interfaces/_api_types_.networkinterfaceconnectionsetting.md b/docs/interfaces/_api_types_.networkinterfaceconnectionsetting.md index 13cee36..feb0fcb 100644 --- a/docs/interfaces/_api_types_.networkinterfaceconnectionsetting.md +++ b/docs/interfaces/_api_types_.networkinterfaceconnectionsetting.md @@ -26,7 +26,7 @@ Auto negotiation on/off. **● AutoNegotiation**: *`boolean`* -*Defined in [api/types.ts:1071](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1071)* +*Defined in [api/types.ts:1071](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1071)* ___ @@ -35,7 +35,7 @@ ___ **● Duplex**: *[Duplex](../enums/_api_types_.duplex.md)* -*Defined in [api/types.ts:1073](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1073)* +*Defined in [api/types.ts:1073](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1073)* ___ @@ -44,7 +44,7 @@ ___ **● Speed**: *`number`* -*Defined in [api/types.ts:1072](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1072)* +*Defined in [api/types.ts:1072](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1072)* ___ diff --git a/docs/interfaces/_api_types_.networkinterfaceextension.md b/docs/interfaces/_api_types_.networkinterfaceextension.md index 0670867..2defd9b 100644 --- a/docs/interfaces/_api_types_.networkinterfaceextension.md +++ b/docs/interfaces/_api_types_.networkinterfaceextension.md @@ -23,29 +23,29 @@ Extension point prepared for future 802.3 configuration. -### Dot11 +### `` Dot11 **● Dot11**: *[Dot11Configuration](_api_types_.dot11configuration.md)* -*Defined in [api/types.ts:1042](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1042)* +*Defined in [api/types.ts:1042](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1042)* ___ -### Dot3 +### `` Dot3 **● Dot3**: *[Dot3Configuration](_api_types_.dot3configuration.md)* -*Defined in [api/types.ts:1041](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1041)* +*Defined in [api/types.ts:1041](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1041)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkInterfaceExtension2](_api_types_.networkinterfaceextension2.md)* -*Defined in [api/types.ts:1043](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1043)* +*Defined in [api/types.ts:1043](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1043)* ___ @@ -54,7 +54,7 @@ ___ **● InterfaceType**: *`any`* -*Defined in [api/types.ts:1040](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1040)* +*Defined in [api/types.ts:1040](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1040)* ___ diff --git a/docs/interfaces/_api_types_.networkinterfaceinfo.md b/docs/interfaces/_api_types_.networkinterfaceinfo.md index 16760c6..ff6f338 100644 --- a/docs/interfaces/_api_types_.networkinterfaceinfo.md +++ b/docs/interfaces/_api_types_.networkinterfaceinfo.md @@ -26,25 +26,25 @@ Network interface name, for example eth0. **● HwAddress**: *[HwAddress](_api_types_.networkinterfaceinfo.md#hwaddress)* -*Defined in [api/types.ts:1081](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1081)* +*Defined in [api/types.ts:1081](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1081)* ___ -### MTU +### `` MTU -**● MTU**: *`number`* +**● MTU**: *`undefined` \| `number`* -*Defined in [api/types.ts:1082](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1082)* +*Defined in [api/types.ts:1082](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1082)* ___ -### Name +### `` Name -**● Name**: *`string`* +**● Name**: *`undefined` \| `string`* -*Defined in [api/types.ts:1080](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1080)* +*Defined in [api/types.ts:1080](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1080)* ___ diff --git a/docs/interfaces/_api_types_.networkinterfacelink.md b/docs/interfaces/_api_types_.networkinterfacelink.md index 9ecfc64..26d70c4 100644 --- a/docs/interfaces/_api_types_.networkinterfacelink.md +++ b/docs/interfaces/_api_types_.networkinterfacelink.md @@ -26,7 +26,7 @@ Configured link settings. **● AdminSettings**: *[NetworkInterfaceConnectionSetting](_api_types_.networkinterfaceconnectionsetting.md)* -*Defined in [api/types.ts:1062](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1062)* +*Defined in [api/types.ts:1062](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1062)* ___ @@ -35,7 +35,7 @@ ___ **● InterfaceType**: *`any`* -*Defined in [api/types.ts:1064](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1064)* +*Defined in [api/types.ts:1064](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1064)* ___ @@ -44,7 +44,7 @@ ___ **● OperSettings**: *[NetworkInterfaceConnectionSetting](_api_types_.networkinterfaceconnectionsetting.md)* -*Defined in [api/types.ts:1063](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1063)* +*Defined in [api/types.ts:1063](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1063)* ___ diff --git a/docs/interfaces/_api_types_.networkinterfacesetconfiguration.md b/docs/interfaces/_api_types_.networkinterfacesetconfiguration.md index bb641d4..03d4f08 100644 --- a/docs/interfaces/_api_types_.networkinterfacesetconfiguration.md +++ b/docs/interfaces/_api_types_.networkinterfacesetconfiguration.md @@ -25,56 +25,56 @@ Indicates whether or not an interface is enabled. -### Enabled +### `` Enabled -**● Enabled**: *`boolean`* +**● Enabled**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1256](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1256)* +*Defined in [api/types.ts:1256](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1256)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkInterfaceSetConfigurationExtension](_api_types_.networkinterfacesetconfigurationextension.md)* -*Defined in [api/types.ts:1261](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1261)* +*Defined in [api/types.ts:1261](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1261)* ___ -### IPv4 +### `` IPv4 **● IPv4**: *[IPv4NetworkInterfaceSetConfiguration](_api_types_.ipv4networkinterfacesetconfiguration.md)* -*Defined in [api/types.ts:1259](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1259)* +*Defined in [api/types.ts:1259](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1259)* ___ -### IPv6 +### `` IPv6 **● IPv6**: *[IPv6NetworkInterfaceSetConfiguration](_api_types_.ipv6networkinterfacesetconfiguration.md)* -*Defined in [api/types.ts:1260](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1260)* +*Defined in [api/types.ts:1260](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1260)* ___ -### Link +### `` Link **● Link**: *[NetworkInterfaceConnectionSetting](_api_types_.networkinterfaceconnectionsetting.md)* -*Defined in [api/types.ts:1257](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1257)* +*Defined in [api/types.ts:1257](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1257)* ___ -### MTU +### `` MTU -**● MTU**: *`number`* +**● MTU**: *`undefined` \| `number`* -*Defined in [api/types.ts:1258](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1258)* +*Defined in [api/types.ts:1258](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1258)* ___ diff --git a/docs/interfaces/_api_types_.networkinterfacesetconfigurationextension.md b/docs/interfaces/_api_types_.networkinterfacesetconfigurationextension.md index d6f43fb..84204ff 100644 --- a/docs/interfaces/_api_types_.networkinterfacesetconfigurationextension.md +++ b/docs/interfaces/_api_types_.networkinterfacesetconfigurationextension.md @@ -20,29 +20,29 @@ -### Dot11 +### `` Dot11 **● Dot11**: *[Dot11Configuration](_api_types_.dot11configuration.md)* -*Defined in [api/types.ts:1269](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1269)* +*Defined in [api/types.ts:1269](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1269)* ___ -### Dot3 +### `` Dot3 **● Dot3**: *[Dot3Configuration](_api_types_.dot3configuration.md)* -*Defined in [api/types.ts:1268](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1268)* +*Defined in [api/types.ts:1268](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1268)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkInterfaceSetConfigurationExtension2](_api_types_.networkinterfacesetconfigurationextension2.md)* -*Defined in [api/types.ts:1270](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1270)* +*Defined in [api/types.ts:1270](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1270)* ___ diff --git a/docs/interfaces/_api_types_.networkprotocol.md b/docs/interfaces/_api_types_.networkprotocol.md index 23a3a23..8072d93 100644 --- a/docs/interfaces/_api_types_.networkprotocol.md +++ b/docs/interfaces/_api_types_.networkprotocol.md @@ -27,16 +27,16 @@ Network protocol type string. **● Enabled**: *`boolean`* -*Defined in [api/types.ts:1135](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1135)* +*Defined in [api/types.ts:1135](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1135)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkProtocolExtension](_api_types_.networkprotocolextension.md)* -*Defined in [api/types.ts:1137](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1137)* +*Defined in [api/types.ts:1137](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1137)* ___ @@ -45,7 +45,7 @@ ___ **● Name**: *[NetworkProtocolType](../enums/_api_types_.networkprotocoltype.md)* -*Defined in [api/types.ts:1134](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1134)* +*Defined in [api/types.ts:1134](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1134)* ___ @@ -54,7 +54,7 @@ ___ **● Port**: *`number`* -*Defined in [api/types.ts:1136](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1136)* +*Defined in [api/types.ts:1136](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1136)* ___ diff --git a/docs/interfaces/_api_types_.networkzeroconfiguration.md b/docs/interfaces/_api_types_.networkzeroconfiguration.md index b9771ec..5dd19b9 100644 --- a/docs/interfaces/_api_types_.networkzeroconfiguration.md +++ b/docs/interfaces/_api_types_.networkzeroconfiguration.md @@ -23,11 +23,11 @@ Unique identifier of network interface. -### Addresses +### `` Addresses **● Addresses**: *[IPv4Address](../modules/_api_types_.md#ipv4address)* -*Defined in [api/types.ts:1306](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1306)* +*Defined in [api/types.ts:1306](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1306)* ___ @@ -36,16 +36,16 @@ ___ **● Enabled**: *`boolean`* -*Defined in [api/types.ts:1305](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1305)* +*Defined in [api/types.ts:1305](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1305)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkZeroConfigurationExtension](_api_types_.networkzeroconfigurationextension.md)* -*Defined in [api/types.ts:1307](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1307)* +*Defined in [api/types.ts:1307](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1307)* ___ @@ -54,7 +54,7 @@ ___ **● InterfaceToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:1304](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1304)* +*Defined in [api/types.ts:1304](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1304)* ___ diff --git a/docs/interfaces/_api_types_.networkzeroconfigurationextension.md b/docs/interfaces/_api_types_.networkzeroconfigurationextension.md index d4a31dc..77569e1 100644 --- a/docs/interfaces/_api_types_.networkzeroconfigurationextension.md +++ b/docs/interfaces/_api_types_.networkzeroconfigurationextension.md @@ -21,20 +21,20 @@ Optional array holding the configuration for the second and possibly further int -### Additional +### `` Additional **● Additional**: *[NetworkZeroConfiguration](_api_types_.networkzeroconfiguration.md)* -*Defined in [api/types.ts:1314](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1314)* +*Defined in [api/types.ts:1314](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1314)* ___ -### Extension +### `` Extension **● Extension**: *[NetworkZeroConfigurationExtension2](_api_types_.networkzeroconfigurationextension2.md)* -*Defined in [api/types.ts:1315](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1315)* +*Defined in [api/types.ts:1315](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1315)* ___ diff --git a/docs/interfaces/_api_types_.noisereduction.md b/docs/interfaces/_api_types_.noisereduction.md index 7717e91..55bc7d0 100644 --- a/docs/interfaces/_api_types_.noisereduction.md +++ b/docs/interfaces/_api_types_.noisereduction.md @@ -24,7 +24,7 @@ Level parameter specified with unitless normalized value from 0.0 to +1.0. Level **● Level**: *`number`* -*Defined in [api/types.ts:2851](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2851)* +*Defined in [api/types.ts:2851](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2851)* ___ diff --git a/docs/interfaces/_api_types_.noisereductionoptions.md b/docs/interfaces/_api_types_.noisereductionoptions.md index a6b3bb6..c3451d7 100644 --- a/docs/interfaces/_api_types_.noisereductionoptions.md +++ b/docs/interfaces/_api_types_.noisereductionoptions.md @@ -24,7 +24,7 @@ Indicates whether or not support Level parameter for NoiseReduction. **● Level**: *`boolean`* -*Defined in [api/types.ts:3105](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3105)* +*Defined in [api/types.ts:3105](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3105)* ___ diff --git a/docs/interfaces/_api_types_.ntpinformation.md b/docs/interfaces/_api_types_.ntpinformation.md index 9b97b2c..e3cf943 100644 --- a/docs/interfaces/_api_types_.ntpinformation.md +++ b/docs/interfaces/_api_types_.ntpinformation.md @@ -23,11 +23,11 @@ Indicates if NTP information is to be retrieved by using DHCP. -### Extension +### `` Extension **● Extension**: *[NTPInformationExtension](_api_types_.ntpinformationextension.md)* -*Defined in [api/types.ts:1227](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1227)* +*Defined in [api/types.ts:1227](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1227)* ___ @@ -36,25 +36,25 @@ ___ **● FromDHCP**: *`boolean`* -*Defined in [api/types.ts:1224](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1224)* +*Defined in [api/types.ts:1224](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1224)* ___ -### NTPFromDHCP +### `` NTPFromDHCP **● NTPFromDHCP**: *[NetworkHost](_api_types_.networkhost.md)* -*Defined in [api/types.ts:1225](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1225)* +*Defined in [api/types.ts:1225](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1225)* ___ -### NTPManual +### `` NTPManual **● NTPManual**: *[NetworkHost](_api_types_.networkhost.md)* -*Defined in [api/types.ts:1226](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1226)* +*Defined in [api/types.ts:1226](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1226)* ___ diff --git a/docs/interfaces/_api_types_.onvifversion.md b/docs/interfaces/_api_types_.onvifversion.md index 22ec8f6..244d512 100644 --- a/docs/interfaces/_api_types_.onvifversion.md +++ b/docs/interfaces/_api_types_.onvifversion.md @@ -25,7 +25,7 @@ Major version number. **● Major**: *`number`* -*Defined in [api/types.ts:1659](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1659)* +*Defined in [api/types.ts:1659](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1659)* ___ @@ -34,7 +34,7 @@ ___ **● Minor**: *`number`* -*Defined in [api/types.ts:1660](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1660)* +*Defined in [api/types.ts:1660](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1660)* ___ diff --git a/docs/interfaces/_api_types_.osdcolor.md b/docs/interfaces/_api_types_.osdcolor.md index f27c8a1..882a830 100644 --- a/docs/interfaces/_api_types_.osdcolor.md +++ b/docs/interfaces/_api_types_.osdcolor.md @@ -24,7 +24,7 @@ The value range of "Transparent" could be defined by vendors only should follow **● Color**: *[Color](_api_types_.color.md)* -*Defined in [api/types.ts:3987](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3987)* +*Defined in [api/types.ts:3987](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3987)* ___ diff --git a/docs/interfaces/_api_types_.osdcoloroptions.md b/docs/interfaces/_api_types_.osdcoloroptions.md index 8f81c8a..b4cc5d5 100644 --- a/docs/interfaces/_api_types_.osdcoloroptions.md +++ b/docs/interfaces/_api_types_.osdcoloroptions.md @@ -22,29 +22,29 @@ Describe the option of the color and its transparency. -### Color +### `` Color **● Color**: *[ColorOptions](_api_types_.coloroptions.md)* -*Defined in [api/types.ts:4057](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4057)* +*Defined in [api/types.ts:4057](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4057)* ___ -### Extension +### `` Extension **● Extension**: *[OSDColorOptionsExtension](_api_types_.osdcoloroptionsextension.md)* -*Defined in [api/types.ts:4059](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4059)* +*Defined in [api/types.ts:4059](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4059)* ___ -### Transparent +### `` Transparent **● Transparent**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:4058](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4058)* +*Defined in [api/types.ts:4058](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4058)* ___ diff --git a/docs/interfaces/_api_types_.osdconfiguration.md b/docs/interfaces/_api_types_.osdconfiguration.md index 80d958d..78d840a 100644 --- a/docs/interfaces/_api_types_.osdconfiguration.md +++ b/docs/interfaces/_api_types_.osdconfiguration.md @@ -25,20 +25,20 @@ Reference to the video source configuration. -### Extension +### `` Extension **● Extension**: *[OSDConfigurationExtension](_api_types_.osdconfigurationextension.md)* -*Defined in [api/types.ts:4110](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4110)* +*Defined in [api/types.ts:4110](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4110)* ___ -### Image +### `` Image **● Image**: *[OSDImgConfiguration](_api_types_.osdimgconfiguration.md)* -*Defined in [api/types.ts:4109](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4109)* +*Defined in [api/types.ts:4109](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4109)* ___ @@ -47,16 +47,16 @@ ___ **● Position**: *[OSDPosConfiguration](_api_types_.osdposconfiguration.md)* -*Defined in [api/types.ts:4107](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4107)* +*Defined in [api/types.ts:4107](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4107)* ___ -### TextString +### `` TextString **● TextString**: *[OSDTextConfiguration](_api_types_.osdtextconfiguration.md)* -*Defined in [api/types.ts:4108](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4108)* +*Defined in [api/types.ts:4108](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4108)* ___ @@ -65,7 +65,7 @@ ___ **● Type**: *[OSDType](../enums/_api_types_.osdtype.md)* -*Defined in [api/types.ts:4106](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4106)* +*Defined in [api/types.ts:4106](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4106)* ___ @@ -74,7 +74,7 @@ ___ **● VideoSourceConfigurationToken**: *[OSDReference](_api_types_.osdreference.md)* -*Defined in [api/types.ts:4105](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4105)* +*Defined in [api/types.ts:4105](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4105)* ___ diff --git a/docs/interfaces/_api_types_.osdconfigurationoptions.md b/docs/interfaces/_api_types_.osdconfigurationoptions.md index 80f6756..dcd52c5 100644 --- a/docs/interfaces/_api_types_.osdconfigurationoptions.md +++ b/docs/interfaces/_api_types_.osdconfigurationoptions.md @@ -25,20 +25,20 @@ The maximum number of OSD configurations supported for the specified video sourc -### Extension +### `` Extension **● Extension**: *[OSDConfigurationOptionsExtension](_api_types_.osdconfigurationoptionsextension.md)* -*Defined in [api/types.ts:4134](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4134)* +*Defined in [api/types.ts:4134](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4134)* ___ -### ImageOption +### `` ImageOption **● ImageOption**: *[OSDImgOptions](_api_types_.osdimgoptions.md)* -*Defined in [api/types.ts:4133](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4133)* +*Defined in [api/types.ts:4133](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4133)* ___ @@ -47,7 +47,7 @@ ___ **● MaximumNumberOfOSDs**: *[MaximumNumberOfOSDs](_api_types_.maximumnumberofosds.md)* -*Defined in [api/types.ts:4129](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4129)* +*Defined in [api/types.ts:4129](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4129)* ___ @@ -56,16 +56,16 @@ ___ **● PositionOption**: *`string`* -*Defined in [api/types.ts:4131](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4131)* +*Defined in [api/types.ts:4131](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4131)* ___ -### TextOption +### `` TextOption **● TextOption**: *[OSDTextOptions](_api_types_.osdtextoptions.md)* -*Defined in [api/types.ts:4132](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4132)* +*Defined in [api/types.ts:4132](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4132)* ___ @@ -74,7 +74,7 @@ ___ **● Type**: *[OSDType](../enums/_api_types_.osdtype.md)* -*Defined in [api/types.ts:4130](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4130)* +*Defined in [api/types.ts:4130](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4130)* ___ diff --git a/docs/interfaces/_api_types_.osdimgconfiguration.md b/docs/interfaces/_api_types_.osdimgconfiguration.md index 655d9ee..eea451c 100644 --- a/docs/interfaces/_api_types_.osdimgconfiguration.md +++ b/docs/interfaces/_api_types_.osdimgconfiguration.md @@ -21,11 +21,11 @@ The URI of the image which to be displayed. -### Extension +### `` Extension **● Extension**: *[OSDImgConfigurationExtension](_api_types_.osdimgconfigurationextension.md)* -*Defined in [api/types.ts:4022](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4022)* +*Defined in [api/types.ts:4022](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4022)* ___ @@ -34,7 +34,7 @@ ___ **● ImgPath**: *`string`* -*Defined in [api/types.ts:4021](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4021)* +*Defined in [api/types.ts:4021](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4021)* ___ diff --git a/docs/interfaces/_api_types_.osdimgoptions.md b/docs/interfaces/_api_types_.osdimgoptions.md index 1478757..a6f2199 100644 --- a/docs/interfaces/_api_types_.osdimgoptions.md +++ b/docs/interfaces/_api_types_.osdimgoptions.md @@ -21,11 +21,11 @@ List of available image URIs. -### Extension +### `` Extension **● Extension**: *[OSDImgOptionsExtension](_api_types_.osdimgoptionsextension.md)* -*Defined in [api/types.ts:4092](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4092)* +*Defined in [api/types.ts:4092](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4092)* ___ @@ -34,7 +34,7 @@ ___ **● ImagePath**: *`string`* -*Defined in [api/types.ts:4091](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4091)* +*Defined in [api/types.ts:4091](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4091)* ___ diff --git a/docs/interfaces/_api_types_.osdposconfiguration.md b/docs/interfaces/_api_types_.osdposconfiguration.md index 6888a7f..f6ba1c2 100644 --- a/docs/interfaces/_api_types_.osdposconfiguration.md +++ b/docs/interfaces/_api_types_.osdposconfiguration.md @@ -22,20 +22,20 @@ For OSD position type, following are the pre-defined: UpperLeft UpperRight Lower -### Extension +### `` Extension **● Extension**: *[OSDPosConfigurationExtension](_api_types_.osdposconfigurationextension.md)* -*Defined in [api/types.ts:3974](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3974)* +*Defined in [api/types.ts:3974](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3974)* ___ -### Pos +### `` Pos **● Pos**: *[Vector](_api_types_.vector.md)* -*Defined in [api/types.ts:3973](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3973)* +*Defined in [api/types.ts:3973](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3973)* ___ @@ -44,7 +44,7 @@ ___ **● Type**: *`string`* -*Defined in [api/types.ts:3972](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3972)* +*Defined in [api/types.ts:3972](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3972)* ___ diff --git a/docs/interfaces/_api_types_.osdtextconfiguration.md b/docs/interfaces/_api_types_.osdtextconfiguration.md index cf16e00..8e37683 100644 --- a/docs/interfaces/_api_types_.osdtextconfiguration.md +++ b/docs/interfaces/_api_types_.osdtextconfiguration.md @@ -33,65 +33,65 @@ -### BackgroundColor +### `` BackgroundColor **● BackgroundColor**: *[OSDColor](_api_types_.osdcolor.md)* -*Defined in [api/types.ts:4006](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4006)* +*Defined in [api/types.ts:4006](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4006)* ___ -### DateFormat +### `` DateFormat -**● DateFormat**: *`string`* +**● DateFormat**: *`undefined` \| `string`* -*Defined in [api/types.ts:4002](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4002)* +*Defined in [api/types.ts:4002](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4002)* ___ -### Extension +### `` Extension **● Extension**: *[OSDTextConfigurationExtension](_api_types_.osdtextconfigurationextension.md)* -*Defined in [api/types.ts:4008](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4008)* +*Defined in [api/types.ts:4008](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4008)* ___ -### FontColor +### `` FontColor **● FontColor**: *[OSDColor](_api_types_.osdcolor.md)* -*Defined in [api/types.ts:4005](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4005)* +*Defined in [api/types.ts:4005](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4005)* ___ -### FontSize +### `` FontSize -**● FontSize**: *`number`* +**● FontSize**: *`undefined` \| `number`* -*Defined in [api/types.ts:4004](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4004)* +*Defined in [api/types.ts:4004](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4004)* ___ -### PlainText +### `` PlainText -**● PlainText**: *`string`* +**● PlainText**: *`undefined` \| `string`* -*Defined in [api/types.ts:4007](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4007)* +*Defined in [api/types.ts:4007](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4007)* ___ -### TimeFormat +### `` TimeFormat -**● TimeFormat**: *`string`* +**● TimeFormat**: *`undefined` \| `string`* -*Defined in [api/types.ts:4003](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4003)* +*Defined in [api/types.ts:4003](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4003)* ___ @@ -100,7 +100,7 @@ ___ **● Type**: *`string`* -*Defined in [api/types.ts:4001](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4001)* +*Defined in [api/types.ts:4001](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4001)* ___ diff --git a/docs/interfaces/_api_types_.osdtextoptions.md b/docs/interfaces/_api_types_.osdtextoptions.md index a0e0cf2..f4b671f 100644 --- a/docs/interfaces/_api_types_.osdtextoptions.md +++ b/docs/interfaces/_api_types_.osdtextoptions.md @@ -26,56 +26,56 @@ List of supported OSD text type. When a device indicates the supported number re -### BackgroundColor +### `` BackgroundColor **● BackgroundColor**: *[OSDColorOptions](_api_types_.osdcoloroptions.md)* -*Defined in [api/types.ts:4077](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4077)* +*Defined in [api/types.ts:4077](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4077)* ___ -### DateFormat +### `` DateFormat -**● DateFormat**: *`string`* +**● DateFormat**: *`undefined` \| `string`* -*Defined in [api/types.ts:4074](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4074)* +*Defined in [api/types.ts:4074](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4074)* ___ -### Extension +### `` Extension **● Extension**: *[OSDTextOptionsExtension](_api_types_.osdtextoptionsextension.md)* -*Defined in [api/types.ts:4078](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4078)* +*Defined in [api/types.ts:4078](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4078)* ___ -### FontColor +### `` FontColor **● FontColor**: *[OSDColorOptions](_api_types_.osdcoloroptions.md)* -*Defined in [api/types.ts:4076](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4076)* +*Defined in [api/types.ts:4076](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4076)* ___ -### FontSizeRange +### `` FontSizeRange **● FontSizeRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:4073](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4073)* +*Defined in [api/types.ts:4073](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4073)* ___ -### TimeFormat +### `` TimeFormat -**● TimeFormat**: *`string`* +**● TimeFormat**: *`undefined` \| `string`* -*Defined in [api/types.ts:4075](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4075)* +*Defined in [api/types.ts:4075](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4075)* ___ @@ -84,7 +84,7 @@ ___ **● Type**: *`string`* -*Defined in [api/types.ts:4072](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4072)* +*Defined in [api/types.ts:4072](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4072)* ___ diff --git a/docs/interfaces/_api_types_.paneconfiguration.md b/docs/interfaces/_api_types_.paneconfiguration.md index 2dfe8fd..70e040d 100644 --- a/docs/interfaces/_api_types_.paneconfiguration.md +++ b/docs/interfaces/_api_types_.paneconfiguration.md @@ -25,47 +25,47 @@ Configuration of the streaming and coding settings of a Video window. -### AudioEncoderConfiguration +### `` AudioEncoderConfiguration -**● AudioEncoderConfiguration**: *[AudioEncoderConfiguration](_api_types_.audioencoderconfiguration.md)* +**● AudioEncoderConfiguration**: *[AudioEncoderConfiguration](_api_types_.paneconfiguration.md#audioencoderconfiguration)* -*Defined in [api/types.ts:3322](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3322)* +*Defined in [api/types.ts:3322](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3322)* ___ -### AudioOutputToken +### `` AudioOutputToken **● AudioOutputToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3320](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3320)* +*Defined in [api/types.ts:3320](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3320)* ___ -### AudioSourceToken +### `` AudioSourceToken **● AudioSourceToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3321](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3321)* +*Defined in [api/types.ts:3321](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3321)* ___ -### PaneName +### `` PaneName -**● PaneName**: *`string`* +**● PaneName**: *`undefined` \| `string`* -*Defined in [api/types.ts:3319](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3319)* +*Defined in [api/types.ts:3319](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3319)* ___ -### ReceiverToken +### `` ReceiverToken **● ReceiverToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3323](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3323)* +*Defined in [api/types.ts:3323](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3323)* ___ @@ -74,7 +74,7 @@ ___ **● Token**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3324](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3324)* +*Defined in [api/types.ts:3324](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3324)* ___ diff --git a/docs/interfaces/_api_types_.panelayout.md b/docs/interfaces/_api_types_.panelayout.md index 11c11b8..ca98e22 100644 --- a/docs/interfaces/_api_types_.panelayout.md +++ b/docs/interfaces/_api_types_.panelayout.md @@ -25,7 +25,7 @@ A pane layout describes one Video window of a display. It links a pane configura **● Area**: *[Rectangle](_api_types_.rectangle.md)* -*Defined in [api/types.ts:3332](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3332)* +*Defined in [api/types.ts:3332](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3332)* ___ @@ -34,7 +34,7 @@ ___ **● Pane**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3331](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3331)* +*Defined in [api/types.ts:3331](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3331)* ___ diff --git a/docs/interfaces/_api_types_.panelayoutoptions.md b/docs/interfaces/_api_types_.panelayoutoptions.md index 957900b..5fe2aaa 100644 --- a/docs/interfaces/_api_types_.panelayoutoptions.md +++ b/docs/interfaces/_api_types_.panelayoutoptions.md @@ -25,16 +25,16 @@ Description of a pane layout describing a complete display layout. **● Area**: *[Rectangle](_api_types_.rectangle.md)* -*Defined in [api/types.ts:3376](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3376)* +*Defined in [api/types.ts:3376](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3376)* ___ -### Extension +### `` Extension **● Extension**: *[PaneOptionExtension](_api_types_.paneoptionextension.md)* -*Defined in [api/types.ts:3377](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3377)* +*Defined in [api/types.ts:3377](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3377)* ___ diff --git a/docs/interfaces/_api_types_.pantiltlimits.md b/docs/interfaces/_api_types_.pantiltlimits.md index 682510e..a180ff1 100644 --- a/docs/interfaces/_api_types_.pantiltlimits.md +++ b/docs/interfaces/_api_types_.pantiltlimits.md @@ -26,7 +26,7 @@ **● Range**: *[Space2DDescription](_api_types_.space2ddescription.md)* -*Defined in [api/types.ts:2215](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2215)* +*Defined in [api/types.ts:2215](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2215)* ___ diff --git a/docs/interfaces/_api_types_.polygon.md b/docs/interfaces/_api_types_.polygon.md index 5ad0a07..49b4e78 100644 --- a/docs/interfaces/_api_types_.polygon.md +++ b/docs/interfaces/_api_types_.polygon.md @@ -22,7 +22,7 @@ **● Point**: *[Vector](_api_types_.vector.md)* -*Defined in [api/types.ts:192](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L192)* +*Defined in [api/types.ts:192](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L192)* ___ diff --git a/docs/interfaces/_api_types_.polygonconfiguration.md b/docs/interfaces/_api_types_.polygonconfiguration.md index 60d3065..6be2e35 100644 --- a/docs/interfaces/_api_types_.polygonconfiguration.md +++ b/docs/interfaces/_api_types_.polygonconfiguration.md @@ -24,7 +24,7 @@ Contains Polygon configuration for rule parameters **● Polygon**: *[Polygon](_api_types_.polygon.md)* -*Defined in [api/types.ts:3270](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3270)* +*Defined in [api/types.ts:3270](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3270)* ___ diff --git a/docs/interfaces/_api_types_.polyline.md b/docs/interfaces/_api_types_.polyline.md index 85769d0..45b0214 100644 --- a/docs/interfaces/_api_types_.polyline.md +++ b/docs/interfaces/_api_types_.polyline.md @@ -22,7 +22,7 @@ **● Point**: *[Vector](_api_types_.vector.md)* -*Defined in [api/types.ts:3175](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3175)* +*Defined in [api/types.ts:3175](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3175)* ___ diff --git a/docs/interfaces/_api_types_.polylinearray.md b/docs/interfaces/_api_types_.polylinearray.md index b27471f..4708b9f 100644 --- a/docs/interfaces/_api_types_.polylinearray.md +++ b/docs/interfaces/_api_types_.polylinearray.md @@ -21,11 +21,11 @@ Contains array of Polyline -### Extension +### `` Extension **● Extension**: *[PolylineArrayExtension](_api_types_.polylinearrayextension.md)* -*Defined in [api/types.ts:3278](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3278)* +*Defined in [api/types.ts:3278](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3278)* ___ @@ -34,7 +34,7 @@ ___ **● Segment**: *[Polyline](_api_types_.polyline.md)* -*Defined in [api/types.ts:3277](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3277)* +*Defined in [api/types.ts:3277](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3277)* ___ diff --git a/docs/interfaces/_api_types_.polylinearrayconfiguration.md b/docs/interfaces/_api_types_.polylinearrayconfiguration.md index 9ca38c6..f641d62 100644 --- a/docs/interfaces/_api_types_.polylinearrayconfiguration.md +++ b/docs/interfaces/_api_types_.polylinearrayconfiguration.md @@ -24,7 +24,7 @@ Contains PolylineArray configuration data **● PolylineArray**: *[PolylineArray](_api_types_.polylinearray.md)* -*Defined in [api/types.ts:3291](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3291)* +*Defined in [api/types.ts:3291](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3291)* ___ diff --git a/docs/interfaces/_api_types_.prefixedipv4address.md b/docs/interfaces/_api_types_.prefixedipv4address.md index 6a423be..bf145d9 100644 --- a/docs/interfaces/_api_types_.prefixedipv4address.md +++ b/docs/interfaces/_api_types_.prefixedipv4address.md @@ -25,7 +25,7 @@ IPv4 address **● Address**: *[IPv4Address](../modules/_api_types_.md#ipv4address)* -*Defined in [api/types.ts:1176](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1176)* +*Defined in [api/types.ts:1176](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1176)* ___ @@ -34,7 +34,7 @@ ___ **● PrefixLength**: *`number`* -*Defined in [api/types.ts:1177](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1177)* +*Defined in [api/types.ts:1177](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1177)* ___ diff --git a/docs/interfaces/_api_types_.prefixedipv6address.md b/docs/interfaces/_api_types_.prefixedipv6address.md index f9d6242..941efd9 100644 --- a/docs/interfaces/_api_types_.prefixedipv6address.md +++ b/docs/interfaces/_api_types_.prefixedipv6address.md @@ -25,7 +25,7 @@ IPv6 address **● Address**: *[IPv6Address](../modules/_api_types_.md#ipv6address)* -*Defined in [api/types.ts:1184](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1184)* +*Defined in [api/types.ts:1184](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1184)* ___ @@ -34,7 +34,7 @@ ___ **● PrefixLength**: *`number`* -*Defined in [api/types.ts:1185](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1185)* +*Defined in [api/types.ts:1185](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1185)* ___ diff --git a/docs/interfaces/_api_types_.presettour.md b/docs/interfaces/_api_types_.presettour.md index efe460d..da25428 100644 --- a/docs/interfaces/_api_types_.presettour.md +++ b/docs/interfaces/_api_types_.presettour.md @@ -29,25 +29,25 @@ Readable name of the preset tour. **● AutoStart**: *`boolean`* -*Defined in [api/types.ts:2296](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2296)* +*Defined in [api/types.ts:2296](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2296)* ___ -### Extension +### `` Extension **● Extension**: *[PTZPresetTourExtension](_api_types_.ptzpresettourextension.md)* -*Defined in [api/types.ts:2299](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2299)* +*Defined in [api/types.ts:2299](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2299)* ___ -### Name +### `` Name **● Name**: *[Name](_api_types_.presettour.md#name)* -*Defined in [api/types.ts:2294](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2294)* +*Defined in [api/types.ts:2294](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2294)* ___ @@ -56,7 +56,7 @@ ___ **● StartingCondition**: *[PTZPresetTourStartingCondition](_api_types_.ptzpresettourstartingcondition.md)* -*Defined in [api/types.ts:2297](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2297)* +*Defined in [api/types.ts:2297](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2297)* ___ @@ -65,16 +65,16 @@ ___ **● Status**: *[PTZPresetTourStatus](_api_types_.ptzpresettourstatus.md)* -*Defined in [api/types.ts:2295](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2295)* +*Defined in [api/types.ts:2295](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2295)* ___ -### TourSpot +### `` TourSpot **● TourSpot**: *[PTZPresetTourSpot](_api_types_.ptzpresettourspot.md)* -*Defined in [api/types.ts:2298](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2298)* +*Defined in [api/types.ts:2298](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2298)* ___ diff --git a/docs/interfaces/_api_types_.profile.md b/docs/interfaces/_api_types_.profile.md index 25147d8..2a84185 100644 --- a/docs/interfaces/_api_types_.profile.md +++ b/docs/interfaces/_api_types_.profile.md @@ -37,38 +37,38 @@ -### AudioEncoderConfiguration +### `` AudioEncoderConfiguration -**● AudioEncoderConfiguration**: *[AudioEncoderConfiguration](_api_types_.audioencoderconfiguration.md)* +**● AudioEncoderConfiguration**: *[AudioEncoderConfiguration](_api_types_.profile.md#audioencoderconfiguration)* -*Defined in [api/types.ts:370](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L370)* +*Defined in [api/types.ts:370](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L370)* ___ -### AudioSourceConfiguration +### `` AudioSourceConfiguration -**● AudioSourceConfiguration**: *[AudioSourceConfiguration](_api_types_.audiosourceconfiguration.md)* +**● AudioSourceConfiguration**: *[AudioSourceConfiguration](_api_types_.profile.md#audiosourceconfiguration)* -*Defined in [api/types.ts:368](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L368)* +*Defined in [api/types.ts:368](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L368)* ___ -### Extension +### `` Extension **● Extension**: *[ProfileExtension](_api_types_.profileextension.md)* -*Defined in [api/types.ts:374](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L374)* +*Defined in [api/types.ts:374](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L374)* ___ -### MetadataConfiguration +### `` MetadataConfiguration -**● MetadataConfiguration**: *[MetadataConfiguration](_api_types_.metadataconfiguration.md)* +**● MetadataConfiguration**: *[MetadataConfiguration](_api_types_.profile.md#metadataconfiguration)* -*Defined in [api/types.ts:373](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L373)* +*Defined in [api/types.ts:373](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L373)* ___ @@ -77,43 +77,43 @@ ___ **● Name**: *[Name](_api_types_.profile.md#name)* -*Defined in [api/types.ts:366](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L366)* +*Defined in [api/types.ts:366](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L366)* ___ -### PTZConfiguration +### `` PTZConfiguration -**● PTZConfiguration**: *[PTZConfiguration](_api_types_.ptzconfiguration.md)* +**● PTZConfiguration**: *[PTZConfiguration](_api_types_.profile.md#ptzconfiguration)* -*Defined in [api/types.ts:372](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L372)* +*Defined in [api/types.ts:372](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L372)* ___ -### VideoAnalyticsConfiguration +### `` VideoAnalyticsConfiguration -**● VideoAnalyticsConfiguration**: *[VideoAnalyticsConfiguration](_api_types_.videoanalyticsconfiguration.md)* +**● VideoAnalyticsConfiguration**: *[VideoAnalyticsConfiguration](_api_types_.profile.md#videoanalyticsconfiguration)* -*Defined in [api/types.ts:371](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L371)* +*Defined in [api/types.ts:371](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L371)* ___ -### VideoEncoderConfiguration +### `` VideoEncoderConfiguration -**● VideoEncoderConfiguration**: *[VideoEncoderConfiguration](_api_types_.videoencoderconfiguration.md)* +**● VideoEncoderConfiguration**: *[VideoEncoderConfiguration](_api_types_.profile.md#videoencoderconfiguration)* -*Defined in [api/types.ts:369](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L369)* +*Defined in [api/types.ts:369](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L369)* ___ -### VideoSourceConfiguration +### `` VideoSourceConfiguration -**● VideoSourceConfiguration**: *[VideoSourceConfiguration](_api_types_.videosourceconfiguration.md)* +**● VideoSourceConfiguration**: *[VideoSourceConfiguration](_api_types_.profile.md#videosourceconfiguration)* -*Defined in [api/types.ts:367](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L367)* +*Defined in [api/types.ts:367](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L367)* ___ diff --git a/docs/interfaces/_api_types_.profilecapabilities.md b/docs/interfaces/_api_types_.profilecapabilities.md index aa70361..34e1ad5 100644 --- a/docs/interfaces/_api_types_.profilecapabilities.md +++ b/docs/interfaces/_api_types_.profilecapabilities.md @@ -24,7 +24,7 @@ Maximum number of profiles. **● MaximumNumberOfProfiles**: *`number`* -*Defined in [api/types.ts:1564](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1564)* +*Defined in [api/types.ts:1564](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1564)* ___ diff --git a/docs/interfaces/_api_types_.profileextension.md b/docs/interfaces/_api_types_.profileextension.md index d3bef28..934b535 100644 --- a/docs/interfaces/_api_types_.profileextension.md +++ b/docs/interfaces/_api_types_.profileextension.md @@ -22,29 +22,29 @@ Optional configuration of the Audio output. -### AudioDecoderConfiguration +### `` AudioDecoderConfiguration -**● AudioDecoderConfiguration**: *[AudioDecoderConfiguration](_api_types_.audiodecoderconfiguration.md)* +**● AudioDecoderConfiguration**: *[AudioDecoderConfiguration](_api_types_.profileextension.md#audiodecoderconfiguration)* -*Defined in [api/types.ts:382](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L382)* +*Defined in [api/types.ts:382](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L382)* ___ -### AudioOutputConfiguration +### `` AudioOutputConfiguration -**● AudioOutputConfiguration**: *[AudioOutputConfiguration](_api_types_.audiooutputconfiguration.md)* +**● AudioOutputConfiguration**: *[AudioOutputConfiguration](_api_types_.profileextension.md#audiooutputconfiguration)* -*Defined in [api/types.ts:381](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L381)* +*Defined in [api/types.ts:381](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L381)* ___ -### Extension +### `` Extension **● Extension**: *[ProfileExtension2](_api_types_.profileextension2.md)* -*Defined in [api/types.ts:383](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L383)* +*Defined in [api/types.ts:383](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L383)* ___ diff --git a/docs/interfaces/_api_types_.profilestatus.md b/docs/interfaces/_api_types_.profilestatus.md index aa3307e..4da45d8 100644 --- a/docs/interfaces/_api_types_.profilestatus.md +++ b/docs/interfaces/_api_types_.profilestatus.md @@ -19,20 +19,20 @@ -### ActiveConnections +### `` ActiveConnections **● ActiveConnections**: *[ActiveConnection](_api_types_.activeconnection.md)* -*Defined in [api/types.ts:3947](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3947)* +*Defined in [api/types.ts:3947](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3947)* ___ -### Extension +### `` Extension **● Extension**: *[ProfileStatusExtension](_api_types_.profilestatusextension.md)* -*Defined in [api/types.ts:3948](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3948)* +*Defined in [api/types.ts:3948](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3948)* ___ diff --git a/docs/interfaces/_api_types_.ptcontroldirection.md b/docs/interfaces/_api_types_.ptcontroldirection.md index 5a517ec..5d0bc3f 100644 --- a/docs/interfaces/_api_types_.ptcontroldirection.md +++ b/docs/interfaces/_api_types_.ptcontroldirection.md @@ -22,29 +22,29 @@ Optional element to configure related parameters for E-Flip. -### EFlip +### `` EFlip -**● EFlip**: *[EFlip](_api_types_.eflip.md)* +**● EFlip**: *[EFlip](_api_types_.ptcontroldirection.md#eflip)* -*Defined in [api/types.ts:2123](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2123)* +*Defined in [api/types.ts:2123](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2123)* ___ -### Extension +### `` Extension **● Extension**: *[PTControlDirectionExtension](_api_types_.ptcontroldirectionextension.md)* -*Defined in [api/types.ts:2125](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2125)* +*Defined in [api/types.ts:2125](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2125)* ___ -### Reverse +### `` Reverse -**● Reverse**: *[Reverse](_api_types_.reverse.md)* +**● Reverse**: *[Reverse](_api_types_.ptcontroldirection.md#reverse)* -*Defined in [api/types.ts:2124](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2124)* +*Defined in [api/types.ts:2124](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2124)* ___ diff --git a/docs/interfaces/_api_types_.ptcontroldirectionoptions.md b/docs/interfaces/_api_types_.ptcontroldirectionoptions.md index e34f60f..dbf938d 100644 --- a/docs/interfaces/_api_types_.ptcontroldirectionoptions.md +++ b/docs/interfaces/_api_types_.ptcontroldirectionoptions.md @@ -22,29 +22,29 @@ Supported options for EFlip feature. -### EFlip +### `` EFlip **● EFlip**: *[EFlipOptions](_api_types_.eflipoptions.md)* -*Defined in [api/types.ts:2170](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2170)* +*Defined in [api/types.ts:2170](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2170)* ___ -### Extension +### `` Extension **● Extension**: *[PTControlDirectionOptionsExtension](_api_types_.ptcontroldirectionoptionsextension.md)* -*Defined in [api/types.ts:2172](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2172)* +*Defined in [api/types.ts:2172](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2172)* ___ -### Reverse +### `` Reverse **● Reverse**: *[ReverseOptions](_api_types_.reverseoptions.md)* -*Defined in [api/types.ts:2171](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2171)* +*Defined in [api/types.ts:2171](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2171)* ___ diff --git a/docs/interfaces/_api_types_.ptzcapabilities.md b/docs/interfaces/_api_types_.ptzcapabilities.md index 7ef189d..d574d05 100644 --- a/docs/interfaces/_api_types_.ptzcapabilities.md +++ b/docs/interfaces/_api_types_.ptzcapabilities.md @@ -24,7 +24,7 @@ PTZ service URI. **● XAddr**: *`string`* -*Defined in [api/types.ts:1674](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1674)* +*Defined in [api/types.ts:1674](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1674)* ___ diff --git a/docs/interfaces/_api_types_.ptzconfiguration.md b/docs/interfaces/_api_types_.ptzconfiguration.md index 460df2a..8678422 100644 --- a/docs/interfaces/_api_types_.ptzconfiguration.md +++ b/docs/interfaces/_api_types_.ptzconfiguration.md @@ -33,83 +33,83 @@ -### DefaultAbsolutePantTiltPositionSpace +### `` DefaultAbsolutePantTiltPositionSpace -**● DefaultAbsolutePantTiltPositionSpace**: *`string`* +**● DefaultAbsolutePantTiltPositionSpace**: *`undefined` \| `string`* -*Defined in [api/types.ts:2092](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2092)* +*Defined in [api/types.ts:2092](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2092)* ___ -### DefaultAbsoluteZoomPositionSpace +### `` DefaultAbsoluteZoomPositionSpace -**● DefaultAbsoluteZoomPositionSpace**: *`string`* +**● DefaultAbsoluteZoomPositionSpace**: *`undefined` \| `string`* -*Defined in [api/types.ts:2093](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2093)* +*Defined in [api/types.ts:2093](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2093)* ___ -### DefaultContinuousPanTiltVelocitySpace +### `` DefaultContinuousPanTiltVelocitySpace -**● DefaultContinuousPanTiltVelocitySpace**: *`string`* +**● DefaultContinuousPanTiltVelocitySpace**: *`undefined` \| `string`* -*Defined in [api/types.ts:2096](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2096)* +*Defined in [api/types.ts:2096](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2096)* ___ -### DefaultContinuousZoomVelocitySpace +### `` DefaultContinuousZoomVelocitySpace -**● DefaultContinuousZoomVelocitySpace**: *`string`* +**● DefaultContinuousZoomVelocitySpace**: *`undefined` \| `string`* -*Defined in [api/types.ts:2097](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2097)* +*Defined in [api/types.ts:2097](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2097)* ___ -### DefaultPTZSpeed +### `` DefaultPTZSpeed **● DefaultPTZSpeed**: *[PTZSpeed](_api_types_.ptzspeed.md)* -*Defined in [api/types.ts:2098](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2098)* +*Defined in [api/types.ts:2098](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2098)* ___ -### DefaultPTZTimeout +### `` DefaultPTZTimeout -**● DefaultPTZTimeout**: *`string`* +**● DefaultPTZTimeout**: *`undefined` \| `string`* -*Defined in [api/types.ts:2099](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2099)* +*Defined in [api/types.ts:2099](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2099)* ___ -### DefaultRelativePanTiltTranslationSpace +### `` DefaultRelativePanTiltTranslationSpace -**● DefaultRelativePanTiltTranslationSpace**: *`string`* +**● DefaultRelativePanTiltTranslationSpace**: *`undefined` \| `string`* -*Defined in [api/types.ts:2094](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2094)* +*Defined in [api/types.ts:2094](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2094)* ___ -### DefaultRelativeZoomTranslationSpace +### `` DefaultRelativeZoomTranslationSpace -**● DefaultRelativeZoomTranslationSpace**: *`string`* +**● DefaultRelativeZoomTranslationSpace**: *`undefined` \| `string`* -*Defined in [api/types.ts:2095](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2095)* +*Defined in [api/types.ts:2095](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2095)* ___ -### Extension +### `` Extension **● Extension**: *[PTZConfigurationExtension](_api_types_.ptzconfigurationextension.md)* -*Defined in [api/types.ts:2102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2102)* +*Defined in [api/types.ts:2102](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2102)* ___ @@ -118,25 +118,25 @@ ___ **● NodeToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:2091](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2091)* +*Defined in [api/types.ts:2091](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2091)* ___ -### PanTiltLimits +### `` PanTiltLimits -**● PanTiltLimits**: *[PanTiltLimits](_api_types_.pantiltlimits.md)* +**● PanTiltLimits**: *[PanTiltLimits](_api_types_.ptzconfiguration.md#pantiltlimits)* -*Defined in [api/types.ts:2100](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2100)* +*Defined in [api/types.ts:2100](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2100)* ___ -### ZoomLimits +### `` ZoomLimits -**● ZoomLimits**: *[ZoomLimits](_api_types_.zoomlimits.md)* +**● ZoomLimits**: *[ZoomLimits](_api_types_.ptzconfiguration.md#zoomlimits)* -*Defined in [api/types.ts:2101](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2101)* +*Defined in [api/types.ts:2101](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2101)* ___ diff --git a/docs/interfaces/_api_types_.ptzconfigurationextension.md b/docs/interfaces/_api_types_.ptzconfigurationextension.md index 461e2d2..24f7736 100644 --- a/docs/interfaces/_api_types_.ptzconfigurationextension.md +++ b/docs/interfaces/_api_types_.ptzconfigurationextension.md @@ -21,20 +21,20 @@ Optional element to configure PT Control Direction related features. -### Extension +### `` Extension **● Extension**: *[PTZConfigurationExtension2](_api_types_.ptzconfigurationextension2.md)* -*Defined in [api/types.ts:2110](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2110)* +*Defined in [api/types.ts:2110](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2110)* ___ -### PTControlDirection +### `` PTControlDirection -**● PTControlDirection**: *[PTControlDirection](_api_types_.ptcontroldirection.md)* +**● PTControlDirection**: *[PTControlDirection](_api_types_.ptzconfigurationextension.md#ptcontroldirection)* -*Defined in [api/types.ts:2109](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2109)* +*Defined in [api/types.ts:2109](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2109)* ___ diff --git a/docs/interfaces/_api_types_.ptzconfigurationoptions.md b/docs/interfaces/_api_types_.ptzconfigurationoptions.md index 1c51a34..2b450ff 100644 --- a/docs/interfaces/_api_types_.ptzconfigurationoptions.md +++ b/docs/interfaces/_api_types_.ptzconfigurationoptions.md @@ -25,20 +25,20 @@ -### Extension +### `` Extension **● Extension**: *[PTZConfigurationOptions2](_api_types_.ptzconfigurationoptions2.md)* -*Defined in [api/types.ts:2157](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2157)* +*Defined in [api/types.ts:2157](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2157)* ___ -### PTControlDirection +### `` PTControlDirection **● PTControlDirection**: *[PTControlDirectionOptions](_api_types_.ptcontroldirectionoptions.md)* -*Defined in [api/types.ts:2156](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2156)* +*Defined in [api/types.ts:2156](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2156)* ___ @@ -47,7 +47,7 @@ ___ **● PTZTimeout**: *[DurationRange](_api_types_.durationrange.md)* -*Defined in [api/types.ts:2155](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2155)* +*Defined in [api/types.ts:2155](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2155)* ___ @@ -56,7 +56,7 @@ ___ **● Spaces**: *[PTZSpaces](_api_types_.ptzspaces.md)* -*Defined in [api/types.ts:2154](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2154)* +*Defined in [api/types.ts:2154](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2154)* ___ diff --git a/docs/interfaces/_api_types_.ptzfilter.md b/docs/interfaces/_api_types_.ptzfilter.md index d8ebc92..88ab9eb 100644 --- a/docs/interfaces/_api_types_.ptzfilter.md +++ b/docs/interfaces/_api_types_.ptzfilter.md @@ -25,7 +25,7 @@ True if the metadata stream shall contain the PTZ status (IDLE, MOVING or UNKNOW **● Position**: *`boolean`* -*Defined in [api/types.ts:784](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L784)* +*Defined in [api/types.ts:784](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L784)* ___ @@ -34,7 +34,7 @@ ___ **● Status**: *`boolean`* -*Defined in [api/types.ts:783](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L783)* +*Defined in [api/types.ts:783](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L783)* ___ diff --git a/docs/interfaces/_api_types_.ptzmovestatus.md b/docs/interfaces/_api_types_.ptzmovestatus.md index 1cb33cb..8bc83fd 100644 --- a/docs/interfaces/_api_types_.ptzmovestatus.md +++ b/docs/interfaces/_api_types_.ptzmovestatus.md @@ -19,20 +19,20 @@ -### PanTilt +### `` PanTilt **● PanTilt**: *[MoveStatus](../enums/_api_types_.movestatus.md)* -*Defined in [api/types.ts:172](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L172)* +*Defined in [api/types.ts:172](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L172)* ___ -### Zoom +### `` Zoom **● Zoom**: *[MoveStatus](../enums/_api_types_.movestatus.md)* -*Defined in [api/types.ts:173](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L173)* +*Defined in [api/types.ts:173](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L173)* ___ diff --git a/docs/interfaces/_api_types_.ptznode.md b/docs/interfaces/_api_types_.ptznode.md index 91cb52d..4782277 100644 --- a/docs/interfaces/_api_types_.ptznode.md +++ b/docs/interfaces/_api_types_.ptznode.md @@ -27,20 +27,20 @@ -### AuxiliaryCommands +### `` AuxiliaryCommands **● AuxiliaryCommands**: *[AuxiliaryData](../modules/_api_types_.md#auxiliarydata)* -*Defined in [api/types.ts:2050](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2050)* +*Defined in [api/types.ts:2050](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2050)* ___ -### Extension +### `` Extension **● Extension**: *[PTZNodeExtension](_api_types_.ptznodeextension.md)* -*Defined in [api/types.ts:2051](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2051)* +*Defined in [api/types.ts:2051](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2051)* ___ @@ -49,7 +49,7 @@ ___ **● HomeSupported**: *`boolean`* -*Defined in [api/types.ts:2049](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2049)* +*Defined in [api/types.ts:2049](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2049)* ___ @@ -58,16 +58,16 @@ ___ **● MaximumNumberOfPresets**: *`number`* -*Defined in [api/types.ts:2048](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2048)* +*Defined in [api/types.ts:2048](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2048)* ___ -### Name +### `` Name **● Name**: *[Name](_api_types_.ptznode.md#name)* -*Defined in [api/types.ts:2046](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2046)* +*Defined in [api/types.ts:2046](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2046)* ___ @@ -76,7 +76,7 @@ ___ **● SupportedPTZSpaces**: *[PTZSpaces](_api_types_.ptzspaces.md)* -*Defined in [api/types.ts:2047](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2047)* +*Defined in [api/types.ts:2047](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2047)* ___ diff --git a/docs/interfaces/_api_types_.ptznodeextension.md b/docs/interfaces/_api_types_.ptznodeextension.md index a09c109..3a42d84 100644 --- a/docs/interfaces/_api_types_.ptznodeextension.md +++ b/docs/interfaces/_api_types_.ptznodeextension.md @@ -23,20 +23,20 @@ -### Extension +### `` Extension **● Extension**: *[PTZNodeExtension2](_api_types_.ptznodeextension2.md)* -*Defined in [api/types.ts:2061](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2061)* +*Defined in [api/types.ts:2061](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2061)* ___ -### SupportedPresetTour +### `` SupportedPresetTour **● SupportedPresetTour**: *[PTZPresetTourSupported](_api_types_.ptzpresettoursupported.md)* -*Defined in [api/types.ts:2060](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2060)* +*Defined in [api/types.ts:2060](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2060)* ___ diff --git a/docs/interfaces/_api_types_.ptzpositionfilter.md b/docs/interfaces/_api_types_.ptzpositionfilter.md index 983d618..0be61d7 100644 --- a/docs/interfaces/_api_types_.ptzpositionfilter.md +++ b/docs/interfaces/_api_types_.ptzpositionfilter.md @@ -26,7 +26,7 @@ The lower boundary of the PTZ volume to look for. **● EnterOrExit**: *`boolean`* -*Defined in [api/types.ts:3469](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3469)* +*Defined in [api/types.ts:3469](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3469)* ___ @@ -35,7 +35,7 @@ ___ **● MaxPosition**: *[PTZVector](_api_types_.ptzvector.md)* -*Defined in [api/types.ts:3468](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3468)* +*Defined in [api/types.ts:3468](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3468)* ___ @@ -44,7 +44,7 @@ ___ **● MinPosition**: *[PTZVector](_api_types_.ptzvector.md)* -*Defined in [api/types.ts:3467](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3467)* +*Defined in [api/types.ts:3467](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3467)* ___ diff --git a/docs/interfaces/_api_types_.ptzpreset.md b/docs/interfaces/_api_types_.ptzpreset.md index 297a4d0..237ddf3 100644 --- a/docs/interfaces/_api_types_.ptzpreset.md +++ b/docs/interfaces/_api_types_.ptzpreset.md @@ -23,20 +23,20 @@ -### Name +### `` Name **● Name**: *[Name](_api_types_.ptzpreset.md#name)* -*Defined in [api/types.ts:2286](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2286)* +*Defined in [api/types.ts:2286](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2286)* ___ -### PTZPosition +### `` PTZPosition **● PTZPosition**: *[PTZVector](_api_types_.ptzvector.md)* -*Defined in [api/types.ts:2287](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2287)* +*Defined in [api/types.ts:2287](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2287)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettouroptions.md b/docs/interfaces/_api_types_.ptzpresettouroptions.md index 0318c06..5b3c028 100644 --- a/docs/interfaces/_api_types_.ptzpresettouroptions.md +++ b/docs/interfaces/_api_types_.ptzpresettouroptions.md @@ -26,7 +26,7 @@ Indicates whether or not the AutoStart is supported. **● AutoStart**: *`boolean`* -*Defined in [api/types.ts:2375](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2375)* +*Defined in [api/types.ts:2375](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2375)* ___ @@ -35,7 +35,7 @@ ___ **● StartingCondition**: *[PTZPresetTourStartingConditionOptions](_api_types_.ptzpresettourstartingconditionoptions.md)* -*Defined in [api/types.ts:2376](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2376)* +*Defined in [api/types.ts:2376](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2376)* ___ @@ -44,7 +44,7 @@ ___ **● TourSpot**: *[PTZPresetTourSpotOptions](_api_types_.ptzpresettourspotoptions.md)* -*Defined in [api/types.ts:2377](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2377)* +*Defined in [api/types.ts:2377](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2377)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourpresetdetail.md b/docs/interfaces/_api_types_.ptzpresettourpresetdetail.md index c6048f1..f7d2e9b 100644 --- a/docs/interfaces/_api_types_.ptzpresettourpresetdetail.md +++ b/docs/interfaces/_api_types_.ptzpresettourpresetdetail.md @@ -27,7 +27,7 @@ Option to specify the preset position with Preset Token defined in advance. **● Home**: *`boolean`* -*Defined in [api/types.ts:2329](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2329)* +*Defined in [api/types.ts:2329](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2329)* ___ @@ -36,7 +36,7 @@ ___ **● PTZPosition**: *[PTZVector](_api_types_.ptzvector.md)* -*Defined in [api/types.ts:2330](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2330)* +*Defined in [api/types.ts:2330](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2330)* ___ @@ -45,7 +45,7 @@ ___ **● PresetToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:2328](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2328)* +*Defined in [api/types.ts:2328](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2328)* ___ @@ -54,7 +54,7 @@ ___ **● TypeExtension**: *[PTZPresetTourTypeExtension](_api_types_.ptzpresettourtypeextension.md)* -*Defined in [api/types.ts:2331](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2331)* +*Defined in [api/types.ts:2331](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2331)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourpresetdetailoptions.md b/docs/interfaces/_api_types_.ptzpresettourpresetdetailoptions.md index 5705c1c..9206895 100644 --- a/docs/interfaces/_api_types_.ptzpresettourpresetdetailoptions.md +++ b/docs/interfaces/_api_types_.ptzpresettourpresetdetailoptions.md @@ -24,47 +24,47 @@ A list of available Preset Tokens for tour spots. -### Extension +### `` Extension **● Extension**: *[PTZPresetTourPresetDetailOptionsExtension](_api_types_.ptzpresettourpresetdetailoptionsextension.md)* -*Defined in [api/types.ts:2396](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2396)* +*Defined in [api/types.ts:2396](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2396)* ___ -### Home +### `` Home -**● Home**: *`boolean`* +**● Home**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:2393](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2393)* +*Defined in [api/types.ts:2393](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2393)* ___ -### PanTiltPositionSpace +### `` PanTiltPositionSpace **● PanTiltPositionSpace**: *[Space2DDescription](_api_types_.space2ddescription.md)* -*Defined in [api/types.ts:2394](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2394)* +*Defined in [api/types.ts:2394](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2394)* ___ -### PresetToken +### `` PresetToken **● PresetToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:2392](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2392)* +*Defined in [api/types.ts:2392](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2392)* ___ -### ZoomPositionSpace +### `` ZoomPositionSpace **● ZoomPositionSpace**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2395](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2395)* +*Defined in [api/types.ts:2395](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2395)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourspot.md b/docs/interfaces/_api_types_.ptzpresettourspot.md index 21a69b7..7fc8ea9 100644 --- a/docs/interfaces/_api_types_.ptzpresettourspot.md +++ b/docs/interfaces/_api_types_.ptzpresettourspot.md @@ -23,11 +23,11 @@ Detail definition of preset position of the tour spot. -### Extension +### `` Extension **● Extension**: *[PTZPresetTourSpotExtension](_api_types_.ptzpresettourspotextension.md)* -*Defined in [api/types.ts:2315](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2315)* +*Defined in [api/types.ts:2315](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2315)* ___ @@ -36,25 +36,25 @@ ___ **● PresetDetail**: *[PTZPresetTourPresetDetail](_api_types_.ptzpresettourpresetdetail.md)* -*Defined in [api/types.ts:2312](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2312)* +*Defined in [api/types.ts:2312](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2312)* ___ -### Speed +### `` Speed **● Speed**: *[PTZSpeed](_api_types_.ptzspeed.md)* -*Defined in [api/types.ts:2313](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2313)* +*Defined in [api/types.ts:2313](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2313)* ___ -### StayTime +### `` StayTime -**● StayTime**: *`string`* +**● StayTime**: *`undefined` \| `string`* -*Defined in [api/types.ts:2314](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2314)* +*Defined in [api/types.ts:2314](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2314)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourspotoptions.md b/docs/interfaces/_api_types_.ptzpresettourspotoptions.md index 6fa18a1..f118fd7 100644 --- a/docs/interfaces/_api_types_.ptzpresettourspotoptions.md +++ b/docs/interfaces/_api_types_.ptzpresettourspotoptions.md @@ -25,7 +25,7 @@ Supported options for detail definition of preset position of the tour spot. **● PresetDetail**: *[PTZPresetTourPresetDetailOptions](_api_types_.ptzpresettourpresetdetailoptions.md)* -*Defined in [api/types.ts:2384](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2384)* +*Defined in [api/types.ts:2384](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2384)* ___ @@ -34,7 +34,7 @@ ___ **● StayTime**: *[DurationRange](_api_types_.durationrange.md)* -*Defined in [api/types.ts:2385](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2385)* +*Defined in [api/types.ts:2385](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2385)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourstartingcondition.md b/docs/interfaces/_api_types_.ptzpresettourstartingcondition.md index aff6208..efe492c 100644 --- a/docs/interfaces/_api_types_.ptzpresettourstartingcondition.md +++ b/docs/interfaces/_api_types_.ptzpresettourstartingcondition.md @@ -23,38 +23,38 @@ Optional parameter to specify how many times the preset tour is recurred. -### Direction +### `` Direction **● Direction**: *[PTZPresetTourDirection](../enums/_api_types_.ptzpresettourdirection.md)* -*Defined in [api/types.ts:2361](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2361)* +*Defined in [api/types.ts:2361](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2361)* ___ -### Extension +### `` Extension **● Extension**: *[PTZPresetTourStartingConditionExtension](_api_types_.ptzpresettourstartingconditionextension.md)* -*Defined in [api/types.ts:2362](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2362)* +*Defined in [api/types.ts:2362](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2362)* ___ -### RecurringDuration +### `` RecurringDuration -**● RecurringDuration**: *`string`* +**● RecurringDuration**: *`undefined` \| `string`* -*Defined in [api/types.ts:2360](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2360)* +*Defined in [api/types.ts:2360](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2360)* ___ -### RecurringTime +### `` RecurringTime -**● RecurringTime**: *`number`* +**● RecurringTime**: *`undefined` \| `number`* -*Defined in [api/types.ts:2359](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2359)* +*Defined in [api/types.ts:2359](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2359)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourstartingconditionoptions.md b/docs/interfaces/_api_types_.ptzpresettourstartingconditionoptions.md index 4965077..20f12e4 100644 --- a/docs/interfaces/_api_types_.ptzpresettourstartingconditionoptions.md +++ b/docs/interfaces/_api_types_.ptzpresettourstartingconditionoptions.md @@ -23,38 +23,38 @@ Supported range of Recurring Time. -### Direction +### `` Direction **● Direction**: *[PTZPresetTourDirection](../enums/_api_types_.ptzpresettourdirection.md)* -*Defined in [api/types.ts:2411](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2411)* +*Defined in [api/types.ts:2411](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2411)* ___ -### Extension +### `` Extension **● Extension**: *[PTZPresetTourStartingConditionOptionsExtension](_api_types_.ptzpresettourstartingconditionoptionsextension.md)* -*Defined in [api/types.ts:2412](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2412)* +*Defined in [api/types.ts:2412](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2412)* ___ -### RecurringDuration +### `` RecurringDuration **● RecurringDuration**: *[DurationRange](_api_types_.durationrange.md)* -*Defined in [api/types.ts:2410](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2410)* +*Defined in [api/types.ts:2410](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2410)* ___ -### RecurringTime +### `` RecurringTime **● RecurringTime**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:2409](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2409)* +*Defined in [api/types.ts:2409](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2409)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettourstatus.md b/docs/interfaces/_api_types_.ptzpresettourstatus.md index f3ee5f8..accceb0 100644 --- a/docs/interfaces/_api_types_.ptzpresettourstatus.md +++ b/docs/interfaces/_api_types_.ptzpresettourstatus.md @@ -22,20 +22,20 @@ Indicates state of this preset tour by Idle/Touring/Paused. -### CurrentTourSpot +### `` CurrentTourSpot **● CurrentTourSpot**: *[PTZPresetTourSpot](_api_types_.ptzpresettourspot.md)* -*Defined in [api/types.ts:2345](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2345)* +*Defined in [api/types.ts:2345](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2345)* ___ -### Extension +### `` Extension **● Extension**: *[PTZPresetTourStatusExtension](_api_types_.ptzpresettourstatusextension.md)* -*Defined in [api/types.ts:2346](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2346)* +*Defined in [api/types.ts:2346](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2346)* ___ @@ -44,7 +44,7 @@ ___ **● State**: *[PTZPresetTourState](../enums/_api_types_.ptzpresettourstate.md)* -*Defined in [api/types.ts:2344](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2344)* +*Defined in [api/types.ts:2344](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2344)* ___ diff --git a/docs/interfaces/_api_types_.ptzpresettoursupported.md b/docs/interfaces/_api_types_.ptzpresettoursupported.md index 5f0eaff..6a7cf8e 100644 --- a/docs/interfaces/_api_types_.ptzpresettoursupported.md +++ b/docs/interfaces/_api_types_.ptzpresettoursupported.md @@ -22,11 +22,11 @@ Indicates number of preset tours that can be created. Required preset tour opera -### Extension +### `` Extension **● Extension**: *[PTZPresetTourSupportedExtension](_api_types_.ptzpresettoursupportedextension.md)* -*Defined in [api/types.ts:2076](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2076)* +*Defined in [api/types.ts:2076](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2076)* ___ @@ -35,16 +35,16 @@ ___ **● MaximumNumberOfPresetTours**: *`number`* -*Defined in [api/types.ts:2074](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2074)* +*Defined in [api/types.ts:2074](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2074)* ___ -### PTZPresetTourOperation +### `` PTZPresetTourOperation -**● PTZPresetTourOperation**: *[PTZPresetTourOperation](../enums/_api_types_.ptzpresettouroperation.md)* +**● PTZPresetTourOperation**: *[PTZPresetTourOperation](_api_types_.ptzpresettoursupported.md#ptzpresettouroperation)* -*Defined in [api/types.ts:2075](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2075)* +*Defined in [api/types.ts:2075](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2075)* ___ diff --git a/docs/interfaces/_api_types_.ptzspaces.md b/docs/interfaces/_api_types_.ptzspaces.md index 3970b30..e91e110 100644 --- a/docs/interfaces/_api_types_.ptzspaces.md +++ b/docs/interfaces/_api_types_.ptzspaces.md @@ -31,83 +31,83 @@ -### AbsolutePanTiltPositionSpace +### `` AbsolutePanTiltPositionSpace **● AbsolutePanTiltPositionSpace**: *[Space2DDescription](_api_types_.space2ddescription.md)* -*Defined in [api/types.ts:2234](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2234)* +*Defined in [api/types.ts:2234](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2234)* ___ -### AbsoluteZoomPositionSpace +### `` AbsoluteZoomPositionSpace **● AbsoluteZoomPositionSpace**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2235](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2235)* +*Defined in [api/types.ts:2235](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2235)* ___ -### ContinuousPanTiltVelocitySpace +### `` ContinuousPanTiltVelocitySpace **● ContinuousPanTiltVelocitySpace**: *[Space2DDescription](_api_types_.space2ddescription.md)* -*Defined in [api/types.ts:2238](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2238)* +*Defined in [api/types.ts:2238](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2238)* ___ -### ContinuousZoomVelocitySpace +### `` ContinuousZoomVelocitySpace **● ContinuousZoomVelocitySpace**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2239](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2239)* +*Defined in [api/types.ts:2239](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2239)* ___ -### Extension +### `` Extension **● Extension**: *[PTZSpacesExtension](_api_types_.ptzspacesextension.md)* -*Defined in [api/types.ts:2242](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2242)* +*Defined in [api/types.ts:2242](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2242)* ___ -### PanTiltSpeedSpace +### `` PanTiltSpeedSpace **● PanTiltSpeedSpace**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2240](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2240)* +*Defined in [api/types.ts:2240](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2240)* ___ -### RelativePanTiltTranslationSpace +### `` RelativePanTiltTranslationSpace **● RelativePanTiltTranslationSpace**: *[Space2DDescription](_api_types_.space2ddescription.md)* -*Defined in [api/types.ts:2236](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2236)* +*Defined in [api/types.ts:2236](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2236)* ___ -### RelativeZoomTranslationSpace +### `` RelativeZoomTranslationSpace **● RelativeZoomTranslationSpace**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2237](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2237)* +*Defined in [api/types.ts:2237](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2237)* ___ -### ZoomSpeedSpace +### `` ZoomSpeedSpace **● ZoomSpeedSpace**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2241](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2241)* +*Defined in [api/types.ts:2241](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2241)* ___ diff --git a/docs/interfaces/_api_types_.ptzspeed.md b/docs/interfaces/_api_types_.ptzspeed.md index b668c8b..85dd7b2 100644 --- a/docs/interfaces/_api_types_.ptzspeed.md +++ b/docs/interfaces/_api_types_.ptzspeed.md @@ -21,20 +21,20 @@ Pan and tilt speed. The x component corresponds to pan and the y component to ti -### PanTilt +### `` PanTilt **● PanTilt**: *[Vector2D](_api_types_.vector2d.md)* -*Defined in [api/types.ts:2276](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2276)* +*Defined in [api/types.ts:2276](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2276)* ___ -### Zoom +### `` Zoom **● Zoom**: *[Vector1D](_api_types_.vector1d.md)* -*Defined in [api/types.ts:2277](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2277)* +*Defined in [api/types.ts:2277](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2277)* ___ diff --git a/docs/interfaces/_api_types_.ptzstatus.md b/docs/interfaces/_api_types_.ptzstatus.md index 9f211d7..0086f83 100644 --- a/docs/interfaces/_api_types_.ptzstatus.md +++ b/docs/interfaces/_api_types_.ptzstatus.md @@ -25,29 +25,29 @@ -### Error +### `` Error -**● Error**: *`string`* +**● Error**: *`undefined` \| `string`* -*Defined in [api/types.ts:163](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L163)* +*Defined in [api/types.ts:163](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L163)* ___ -### MoveStatus +### `` MoveStatus **● MoveStatus**: *[PTZMoveStatus](_api_types_.ptzmovestatus.md)* -*Defined in [api/types.ts:162](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L162)* +*Defined in [api/types.ts:162](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L162)* ___ -### Position +### `` Position **● Position**: *[PTZVector](_api_types_.ptzvector.md)* -*Defined in [api/types.ts:161](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L161)* +*Defined in [api/types.ts:161](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L161)* ___ @@ -56,7 +56,7 @@ ___ **● UtcTime**: *`string`* -*Defined in [api/types.ts:164](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L164)* +*Defined in [api/types.ts:164](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L164)* ___ diff --git a/docs/interfaces/_api_types_.ptzstatusfilteroptions.md b/docs/interfaces/_api_types_.ptzstatusfilteroptions.md index 4d720aa..77d3410 100644 --- a/docs/interfaces/_api_types_.ptzstatusfilteroptions.md +++ b/docs/interfaces/_api_types_.ptzstatusfilteroptions.md @@ -24,20 +24,20 @@ True if the device is able to stream pan or tilt status information. -### Extension +### `` Extension **● Extension**: *[PTZStatusFilterOptionsExtension](_api_types_.ptzstatusfilteroptionsextension.md)* -*Defined in [api/types.ts:825](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L825)* +*Defined in [api/types.ts:825](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L825)* ___ -### PanTiltPositionSupported +### `` PanTiltPositionSupported -**● PanTiltPositionSupported**: *`boolean`* +**● PanTiltPositionSupported**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:823](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L823)* +*Defined in [api/types.ts:823](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L823)* ___ @@ -46,16 +46,16 @@ ___ **● PanTiltStatusSupported**: *`boolean`* -*Defined in [api/types.ts:821](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L821)* +*Defined in [api/types.ts:821](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L821)* ___ -### ZoomPositionSupported +### `` ZoomPositionSupported -**● ZoomPositionSupported**: *`boolean`* +**● ZoomPositionSupported**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:824](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L824)* +*Defined in [api/types.ts:824](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L824)* ___ @@ -64,7 +64,7 @@ ___ **● ZoomStatusSupported**: *`boolean`* -*Defined in [api/types.ts:822](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L822)* +*Defined in [api/types.ts:822](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L822)* ___ diff --git a/docs/interfaces/_api_types_.ptzvector.md b/docs/interfaces/_api_types_.ptzvector.md index f20fd6e..e2f7ab2 100644 --- a/docs/interfaces/_api_types_.ptzvector.md +++ b/docs/interfaces/_api_types_.ptzvector.md @@ -21,20 +21,20 @@ Pan and tilt position. The x component corresponds to pan and the y component to -### PanTilt +### `` PanTilt **● PanTilt**: *[Vector2D](_api_types_.vector2d.md)* -*Defined in [api/types.ts:151](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L151)* +*Defined in [api/types.ts:151](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L151)* ___ -### Zoom +### `` Zoom **● Zoom**: *[Vector1D](_api_types_.vector1d.md)* -*Defined in [api/types.ts:152](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L152)* +*Defined in [api/types.ts:152](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L152)* ___ diff --git a/docs/interfaces/_api_types_.realtimestreamingcapabilities.md b/docs/interfaces/_api_types_.realtimestreamingcapabilities.md index 5e576e1..107ce23 100644 --- a/docs/interfaces/_api_types_.realtimestreamingcapabilities.md +++ b/docs/interfaces/_api_types_.realtimestreamingcapabilities.md @@ -23,38 +23,38 @@ Indicates whether or not RTP multicast is supported. -### Extension +### `` Extension **● Extension**: *[RealTimeStreamingCapabilitiesExtension](_api_types_.realtimestreamingcapabilitiesextension.md)* -*Defined in [api/types.ts:1551](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1551)* +*Defined in [api/types.ts:1551](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1551)* ___ -### RTPMulticast +### `` RTPMulticast -**● RTPMulticast**: *`boolean`* +**● RTPMulticast**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1548](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1548)* +*Defined in [api/types.ts:1548](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1548)* ___ -### RTP_RTSP_TCP +### `` RTP_RTSP_TCP -**● RTP_RTSP_TCP**: *`boolean`* +**● RTP_RTSP_TCP**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1550](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1550)* +*Defined in [api/types.ts:1550](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1550)* ___ -### RTP_TCP +### `` RTP_TCP -**● RTP_TCP**: *`boolean`* +**● RTP_TCP**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1549](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1549)* +*Defined in [api/types.ts:1549](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1549)* ___ diff --git a/docs/interfaces/_api_types_.receiver.md b/docs/interfaces/_api_types_.receiver.md index c77145a..33bfe8a 100644 --- a/docs/interfaces/_api_types_.receiver.md +++ b/docs/interfaces/_api_types_.receiver.md @@ -27,7 +27,7 @@ **● Configuration**: *[ReceiverConfiguration](_api_types_.receiverconfiguration.md)* -*Defined in [api/types.ts:3393](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3393)* +*Defined in [api/types.ts:3393](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3393)* ___ @@ -36,7 +36,7 @@ ___ **● Token**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3392](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3392)* +*Defined in [api/types.ts:3392](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3392)* ___ diff --git a/docs/interfaces/_api_types_.receivercapabilities.md b/docs/interfaces/_api_types_.receivercapabilities.md index 8c03bf8..a37ec9e 100644 --- a/docs/interfaces/_api_types_.receivercapabilities.md +++ b/docs/interfaces/_api_types_.receivercapabilities.md @@ -29,7 +29,7 @@ The address of the receiver service. **● MaximumRTSPURILength**: *`number`* -*Defined in [api/types.ts:1733](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1733)* +*Defined in [api/types.ts:1733](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1733)* ___ @@ -38,7 +38,7 @@ ___ **● RTP_Multicast**: *`boolean`* -*Defined in [api/types.ts:1729](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1729)* +*Defined in [api/types.ts:1729](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1729)* ___ @@ -47,7 +47,7 @@ ___ **● RTP_RTSP_TCP**: *`boolean`* -*Defined in [api/types.ts:1731](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1731)* +*Defined in [api/types.ts:1731](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1731)* ___ @@ -56,7 +56,7 @@ ___ **● RTP_TCP**: *`boolean`* -*Defined in [api/types.ts:1730](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1730)* +*Defined in [api/types.ts:1730](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1730)* ___ @@ -65,7 +65,7 @@ ___ **● SupportedReceivers**: *`number`* -*Defined in [api/types.ts:1732](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1732)* +*Defined in [api/types.ts:1732](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1732)* ___ @@ -74,7 +74,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1728](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1728)* +*Defined in [api/types.ts:1728](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1728)* ___ diff --git a/docs/interfaces/_api_types_.receiverconfiguration.md b/docs/interfaces/_api_types_.receiverconfiguration.md index 5ceadeb..6e427c5 100644 --- a/docs/interfaces/_api_types_.receiverconfiguration.md +++ b/docs/interfaces/_api_types_.receiverconfiguration.md @@ -28,7 +28,7 @@ **● MediaUri**: *`string`* -*Defined in [api/types.ts:3403](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3403)* +*Defined in [api/types.ts:3403](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3403)* ___ @@ -37,7 +37,7 @@ ___ **● Mode**: *[ReceiverMode](../enums/_api_types_.receivermode.md)* -*Defined in [api/types.ts:3402](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3402)* +*Defined in [api/types.ts:3402](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3402)* ___ @@ -46,7 +46,7 @@ ___ **● StreamSetup**: *[StreamSetup](_api_types_.streamsetup.md)* -*Defined in [api/types.ts:3404](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3404)* +*Defined in [api/types.ts:3404](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3404)* ___ diff --git a/docs/interfaces/_api_types_.receiverstateinformation.md b/docs/interfaces/_api_types_.receiverstateinformation.md index f1d1b72..6a65546 100644 --- a/docs/interfaces/_api_types_.receiverstateinformation.md +++ b/docs/interfaces/_api_types_.receiverstateinformation.md @@ -27,7 +27,7 @@ **● AutoCreated**: *`boolean`* -*Defined in [api/types.ts:3414](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3414)* +*Defined in [api/types.ts:3414](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3414)* ___ @@ -36,7 +36,7 @@ ___ **● State**: *[ReceiverState](../enums/_api_types_.receiverstate.md)* -*Defined in [api/types.ts:3413](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3413)* +*Defined in [api/types.ts:3413](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3413)* ___ diff --git a/docs/interfaces/_api_types_.recordingcapabilities.md b/docs/interfaces/_api_types_.recordingcapabilities.md index 4571d73..d005717 100644 --- a/docs/interfaces/_api_types_.recordingcapabilities.md +++ b/docs/interfaces/_api_types_.recordingcapabilities.md @@ -27,7 +27,7 @@ **● DynamicRecordings**: *`boolean`* -*Defined in [api/types.ts:1704](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1704)* +*Defined in [api/types.ts:1704](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1704)* ___ @@ -36,7 +36,7 @@ ___ **● DynamicTracks**: *`boolean`* -*Defined in [api/types.ts:1705](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1705)* +*Defined in [api/types.ts:1705](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1705)* ___ @@ -45,7 +45,7 @@ ___ **● MaxStringLength**: *`number`* -*Defined in [api/types.ts:1706](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1706)* +*Defined in [api/types.ts:1706](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1706)* ___ @@ -54,7 +54,7 @@ ___ **● MediaProfileSource**: *`boolean`* -*Defined in [api/types.ts:1703](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1703)* +*Defined in [api/types.ts:1703](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1703)* ___ @@ -63,7 +63,7 @@ ___ **● ReceiverSource**: *`boolean`* -*Defined in [api/types.ts:1702](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1702)* +*Defined in [api/types.ts:1702](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1702)* ___ @@ -72,7 +72,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1701](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1701)* +*Defined in [api/types.ts:1701](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1701)* ___ diff --git a/docs/interfaces/_api_types_.recordingconfiguration.md b/docs/interfaces/_api_types_.recordingconfiguration.md index 4ef1c5d..e0c9d36 100644 --- a/docs/interfaces/_api_types_.recordingconfiguration.md +++ b/docs/interfaces/_api_types_.recordingconfiguration.md @@ -26,7 +26,7 @@ Information about the source of the recording. **● Content**: *[Description](../modules/_api_types_.md#description)* -*Defined in [api/types.ts:3644](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3644)* +*Defined in [api/types.ts:3644](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3644)* ___ @@ -35,7 +35,7 @@ ___ **● MaximumRetentionTime**: *`string`* -*Defined in [api/types.ts:3645](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3645)* +*Defined in [api/types.ts:3645](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3645)* ___ @@ -44,7 +44,7 @@ ___ **● Source**: *[RecordingSourceInformation](_api_types_.recordingsourceinformation.md)* -*Defined in [api/types.ts:3643](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3643)* +*Defined in [api/types.ts:3643](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3643)* ___ diff --git a/docs/interfaces/_api_types_.recordinginformation.md b/docs/interfaces/_api_types_.recordinginformation.md index 6c92bc0..8e46fe3 100644 --- a/docs/interfaces/_api_types_.recordinginformation.md +++ b/docs/interfaces/_api_types_.recordinginformation.md @@ -34,25 +34,25 @@ **● Content**: *[Description](../modules/_api_types_.md#description)* -*Defined in [api/types.ts:3553](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3553)* +*Defined in [api/types.ts:3553](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3553)* ___ -### EarliestRecording +### `` EarliestRecording -**● EarliestRecording**: *`string`* +**● EarliestRecording**: *`undefined` \| `string`* -*Defined in [api/types.ts:3551](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3551)* +*Defined in [api/types.ts:3551](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3551)* ___ -### LatestRecording +### `` LatestRecording -**● LatestRecording**: *`string`* +**● LatestRecording**: *`undefined` \| `string`* -*Defined in [api/types.ts:3552](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3552)* +*Defined in [api/types.ts:3552](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3552)* ___ @@ -61,7 +61,7 @@ ___ **● RecordingStatus**: *[RecordingStatus](../enums/_api_types_.recordingstatus.md)* -*Defined in [api/types.ts:3555](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3555)* +*Defined in [api/types.ts:3555](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3555)* ___ @@ -70,7 +70,7 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3549](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3549)* +*Defined in [api/types.ts:3549](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3549)* ___ @@ -79,16 +79,16 @@ ___ **● Source**: *[RecordingSourceInformation](_api_types_.recordingsourceinformation.md)* -*Defined in [api/types.ts:3550](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3550)* +*Defined in [api/types.ts:3550](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3550)* ___ -### Track +### `` Track **● Track**: *[TrackInformation](_api_types_.trackinformation.md)* -*Defined in [api/types.ts:3554](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3554)* +*Defined in [api/types.ts:3554](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3554)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobconfiguration.md b/docs/interfaces/_api_types_.recordingjobconfiguration.md index faf0b94..bba267b 100644 --- a/docs/interfaces/_api_types_.recordingjobconfiguration.md +++ b/docs/interfaces/_api_types_.recordingjobconfiguration.md @@ -24,11 +24,11 @@ Identifies the recording to which this job shall store the received data. -### Extension +### `` Extension **● Extension**: *[RecordingJobConfigurationExtension](_api_types_.recordingjobconfigurationextension.md)* -*Defined in [api/types.ts:3689](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3689)* +*Defined in [api/types.ts:3689](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3689)* ___ @@ -37,7 +37,7 @@ ___ **● Mode**: *[RecordingJobMode](../modules/_api_types_.md#recordingjobmode)* -*Defined in [api/types.ts:3686](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3686)* +*Defined in [api/types.ts:3686](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3686)* ___ @@ -46,7 +46,7 @@ ___ **● Priority**: *`number`* -*Defined in [api/types.ts:3687](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3687)* +*Defined in [api/types.ts:3687](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3687)* ___ @@ -55,16 +55,16 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3685](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3685)* +*Defined in [api/types.ts:3685](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3685)* ___ -### Source +### `` Source **● Source**: *[RecordingJobSource](_api_types_.recordingjobsource.md)* -*Defined in [api/types.ts:3688](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3688)* +*Defined in [api/types.ts:3688](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3688)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobsource.md b/docs/interfaces/_api_types_.recordingjobsource.md index 8154d7f..d5cc81d 100644 --- a/docs/interfaces/_api_types_.recordingjobsource.md +++ b/docs/interfaces/_api_types_.recordingjobsource.md @@ -23,38 +23,38 @@ This field shall be a reference to the source of the data. The type of the sourc -### AutoCreateReceiver +### `` AutoCreateReceiver -**● AutoCreateReceiver**: *`boolean`* +**● AutoCreateReceiver**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:3708](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3708)* +*Defined in [api/types.ts:3708](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3708)* ___ -### Extension +### `` Extension **● Extension**: *[RecordingJobSourceExtension](_api_types_.recordingjobsourceextension.md)* -*Defined in [api/types.ts:3710](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3710)* +*Defined in [api/types.ts:3710](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3710)* ___ -### SourceToken +### `` SourceToken **● SourceToken**: *[SourceReference](_api_types_.sourcereference.md)* -*Defined in [api/types.ts:3707](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3707)* +*Defined in [api/types.ts:3707](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3707)* ___ -### Tracks +### `` Tracks **● Tracks**: *[RecordingJobTrack](_api_types_.recordingjobtrack.md)* -*Defined in [api/types.ts:3709](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3709)* +*Defined in [api/types.ts:3709](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3709)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobstateinformation.md b/docs/interfaces/_api_types_.recordingjobstateinformation.md index 34466dd..c87a6aa 100644 --- a/docs/interfaces/_api_types_.recordingjobstateinformation.md +++ b/docs/interfaces/_api_types_.recordingjobstateinformation.md @@ -23,11 +23,11 @@ Identification of the recording that the recording job records to. -### Extension +### `` Extension **● Extension**: *[RecordingJobStateInformationExtension](_api_types_.recordingjobstateinformationextension.md)* -*Defined in [api/types.ts:3735](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3735)* +*Defined in [api/types.ts:3735](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3735)* ___ @@ -36,16 +36,16 @@ ___ **● RecordingToken**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3732](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3732)* +*Defined in [api/types.ts:3732](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3732)* ___ -### Sources +### `` Sources **● Sources**: *[RecordingJobStateSource](_api_types_.recordingjobstatesource.md)* -*Defined in [api/types.ts:3734](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3734)* +*Defined in [api/types.ts:3734](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3734)* ___ @@ -54,7 +54,7 @@ ___ **● State**: *[RecordingJobState](../modules/_api_types_.md#recordingjobstate)* -*Defined in [api/types.ts:3733](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3733)* +*Defined in [api/types.ts:3733](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3733)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobstatesource.md b/docs/interfaces/_api_types_.recordingjobstatesource.md index 9fbc9f7..1c29e0a 100644 --- a/docs/interfaces/_api_types_.recordingjobstatesource.md +++ b/docs/interfaces/_api_types_.recordingjobstatesource.md @@ -26,7 +26,7 @@ Identifies the data source of the recording job. **● SourceToken**: *[SourceReference](_api_types_.sourcereference.md)* -*Defined in [api/types.ts:3748](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3748)* +*Defined in [api/types.ts:3748](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3748)* ___ @@ -35,7 +35,7 @@ ___ **● State**: *[RecordingJobState](../modules/_api_types_.md#recordingjobstate)* -*Defined in [api/types.ts:3749](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3749)* +*Defined in [api/types.ts:3749](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3749)* ___ @@ -44,7 +44,7 @@ ___ **● Tracks**: *[RecordingJobStateTracks](_api_types_.recordingjobstatetracks.md)* -*Defined in [api/types.ts:3750](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3750)* +*Defined in [api/types.ts:3750](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3750)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobstatetrack.md b/docs/interfaces/_api_types_.recordingjobstatetrack.md index 1bc59af..601c5c4 100644 --- a/docs/interfaces/_api_types_.recordingjobstatetrack.md +++ b/docs/interfaces/_api_types_.recordingjobstatetrack.md @@ -27,16 +27,16 @@ Identifies the track of the data source that provides the data. **● Destination**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3765](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3765)* +*Defined in [api/types.ts:3765](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3765)* ___ -### Error +### `` Error -**● Error**: *`string`* +**● Error**: *`undefined` \| `string`* -*Defined in [api/types.ts:3766](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3766)* +*Defined in [api/types.ts:3766](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3766)* ___ @@ -45,7 +45,7 @@ ___ **● SourceTag**: *`string`* -*Defined in [api/types.ts:3764](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3764)* +*Defined in [api/types.ts:3764](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3764)* ___ @@ -54,7 +54,7 @@ ___ **● State**: *[RecordingJobState](../modules/_api_types_.md#recordingjobstate)* -*Defined in [api/types.ts:3767](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3767)* +*Defined in [api/types.ts:3767](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3767)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobstatetracks.md b/docs/interfaces/_api_types_.recordingjobstatetracks.md index 87816b9..08bd5bd 100644 --- a/docs/interfaces/_api_types_.recordingjobstatetracks.md +++ b/docs/interfaces/_api_types_.recordingjobstatetracks.md @@ -18,11 +18,11 @@ -### Track +### `` Track **● Track**: *[RecordingJobStateTrack](_api_types_.recordingjobstatetrack.md)* -*Defined in [api/types.ts:3757](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3757)* +*Defined in [api/types.ts:3757](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3757)* ___ diff --git a/docs/interfaces/_api_types_.recordingjobtrack.md b/docs/interfaces/_api_types_.recordingjobtrack.md index 6c955e8..58ced61 100644 --- a/docs/interfaces/_api_types_.recordingjobtrack.md +++ b/docs/interfaces/_api_types_.recordingjobtrack.md @@ -25,7 +25,7 @@ If the received RTSP stream contains multiple tracks of the same type, the Sourc **● Destination**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3725](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3725)* +*Defined in [api/types.ts:3725](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3725)* ___ @@ -34,7 +34,7 @@ ___ **● SourceTag**: *`string`* -*Defined in [api/types.ts:3724](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3724)* +*Defined in [api/types.ts:3724](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3724)* ___ diff --git a/docs/interfaces/_api_types_.recordingsourceinformation.md b/docs/interfaces/_api_types_.recordingsourceinformation.md index 14c4a15..a8f2ed5 100644 --- a/docs/interfaces/_api_types_.recordingsourceinformation.md +++ b/docs/interfaces/_api_types_.recordingsourceinformation.md @@ -30,7 +30,7 @@ **● Address**: *`string`* -*Defined in [api/types.ts:3568](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3568)* +*Defined in [api/types.ts:3568](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3568)* ___ @@ -39,7 +39,7 @@ ___ **● Description**: *[Description](_api_types_.recordingsourceinformation.md#description)* -*Defined in [api/types.ts:3567](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3567)* +*Defined in [api/types.ts:3567](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3567)* ___ @@ -48,7 +48,7 @@ ___ **● Location**: *[Description](_api_types_.recordingsourceinformation.md#description)* -*Defined in [api/types.ts:3566](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3566)* +*Defined in [api/types.ts:3566](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3566)* ___ @@ -57,7 +57,7 @@ ___ **● Name**: *[Name](_api_types_.recordingsourceinformation.md#name)* -*Defined in [api/types.ts:3565](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3565)* +*Defined in [api/types.ts:3565](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3565)* ___ @@ -66,7 +66,7 @@ ___ **● SourceId**: *`string`* -*Defined in [api/types.ts:3564](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3564)* +*Defined in [api/types.ts:3564](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3564)* ___ diff --git a/docs/interfaces/_api_types_.recordingsummary.md b/docs/interfaces/_api_types_.recordingsummary.md index 429cd4f..215005e 100644 --- a/docs/interfaces/_api_types_.recordingsummary.md +++ b/docs/interfaces/_api_types_.recordingsummary.md @@ -26,7 +26,7 @@ The earliest point in time where there is recorded data on the device. **● DataFrom**: *`string`* -*Defined in [api/types.ts:3436](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3436)* +*Defined in [api/types.ts:3436](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3436)* ___ @@ -35,7 +35,7 @@ ___ **● DataUntil**: *`string`* -*Defined in [api/types.ts:3437](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3437)* +*Defined in [api/types.ts:3437](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3437)* ___ @@ -44,7 +44,7 @@ ___ **● NumberRecordings**: *`number`* -*Defined in [api/types.ts:3438](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3438)* +*Defined in [api/types.ts:3438](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3438)* ___ diff --git a/docs/interfaces/_api_types_.relativefocus.md b/docs/interfaces/_api_types_.relativefocus.md index 023e0bb..0bd7fe8 100644 --- a/docs/interfaces/_api_types_.relativefocus.md +++ b/docs/interfaces/_api_types_.relativefocus.md @@ -27,16 +27,16 @@ **● Distance**: *`number`* -*Defined in [api/types.ts:2609](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2609)* +*Defined in [api/types.ts:2609](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2609)* ___ -### Speed +### `` Speed -**● Speed**: *`number`* +**● Speed**: *`undefined` \| `number`* -*Defined in [api/types.ts:2610](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2610)* +*Defined in [api/types.ts:2610](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2610)* ___ diff --git a/docs/interfaces/_api_types_.relativefocusoptions.md b/docs/interfaces/_api_types_.relativefocusoptions.md index 077d84e..d76b39f 100644 --- a/docs/interfaces/_api_types_.relativefocusoptions.md +++ b/docs/interfaces/_api_types_.relativefocusoptions.md @@ -27,7 +27,7 @@ **● Distance**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2647](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2647)* +*Defined in [api/types.ts:2647](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2647)* ___ @@ -36,7 +36,7 @@ ___ **● Speed**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2648](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2648)* +*Defined in [api/types.ts:2648](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2648)* ___ diff --git a/docs/interfaces/_api_types_.relativefocusoptions20.md b/docs/interfaces/_api_types_.relativefocusoptions20.md index 250471a..1b635df 100644 --- a/docs/interfaces/_api_types_.relativefocusoptions20.md +++ b/docs/interfaces/_api_types_.relativefocusoptions20.md @@ -27,16 +27,16 @@ **● Distance**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2994](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2994)* +*Defined in [api/types.ts:2994](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2994)* ___ -### Speed +### `` Speed **● Speed**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2995](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2995)* +*Defined in [api/types.ts:2995](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2995)* ___ diff --git a/docs/interfaces/_api_types_.relayoutput.md b/docs/interfaces/_api_types_.relayoutput.md index 0ad9e6a..ccd8518 100644 --- a/docs/interfaces/_api_types_.relayoutput.md +++ b/docs/interfaces/_api_types_.relayoutput.md @@ -22,7 +22,7 @@ **● Properties**: *[RelayOutputSettings](_api_types_.relayoutputsettings.md)* -*Defined in [api/types.ts:2029](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2029)* +*Defined in [api/types.ts:2029](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2029)* ___ diff --git a/docs/interfaces/_api_types_.relayoutputsettings.md b/docs/interfaces/_api_types_.relayoutputsettings.md index 808ca2b..fd3649e 100644 --- a/docs/interfaces/_api_types_.relayoutputsettings.md +++ b/docs/interfaces/_api_types_.relayoutputsettings.md @@ -33,7 +33,7 @@ **● DelayTime**: *`string`* -*Defined in [api/types.ts:2021](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2021)* +*Defined in [api/types.ts:2021](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2021)* ___ @@ -42,7 +42,7 @@ ___ **● IdleState**: *[RelayIdleState](../enums/_api_types_.relayidlestate.md)* -*Defined in [api/types.ts:2022](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2022)* +*Defined in [api/types.ts:2022](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2022)* ___ @@ -51,7 +51,7 @@ ___ **● Mode**: *[RelayMode](../enums/_api_types_.relaymode.md)* -*Defined in [api/types.ts:2020](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2020)* +*Defined in [api/types.ts:2020](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2020)* ___ diff --git a/docs/interfaces/_api_types_.remoteuser.md b/docs/interfaces/_api_types_.remoteuser.md index 612b3ca..0ccdbbf 100644 --- a/docs/interfaces/_api_types_.remoteuser.md +++ b/docs/interfaces/_api_types_.remoteuser.md @@ -20,11 +20,11 @@ -### Password +### `` Password -**● Password**: *`string`* +**● Password**: *`undefined` \| `string`* -*Defined in [api/types.ts:1870](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1870)* +*Defined in [api/types.ts:1870](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1870)* ___ @@ -33,7 +33,7 @@ ___ **● UseDerivedPassword**: *`boolean`* -*Defined in [api/types.ts:1871](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1871)* +*Defined in [api/types.ts:1871](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1871)* ___ @@ -42,7 +42,7 @@ ___ **● Username**: *`string`* -*Defined in [api/types.ts:1869](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1869)* +*Defined in [api/types.ts:1869](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1869)* ___ diff --git a/docs/interfaces/_api_types_.replaycapabilities.md b/docs/interfaces/_api_types_.replaycapabilities.md index d72e3dd..2d02c50 100644 --- a/docs/interfaces/_api_types_.replaycapabilities.md +++ b/docs/interfaces/_api_types_.replaycapabilities.md @@ -24,7 +24,7 @@ The address of the replay service. **● XAddr**: *`string`* -*Defined in [api/types.ts:1721](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1721)* +*Defined in [api/types.ts:1721](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1721)* ___ diff --git a/docs/interfaces/_api_types_.replayconfiguration.md b/docs/interfaces/_api_types_.replayconfiguration.md index 9135885..6b0bda2 100644 --- a/docs/interfaces/_api_types_.replayconfiguration.md +++ b/docs/interfaces/_api_types_.replayconfiguration.md @@ -26,7 +26,7 @@ **● SessionTimeout**: *`string`* -*Defined in [api/types.ts:3784](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3784)* +*Defined in [api/types.ts:3784](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3784)* ___ diff --git a/docs/interfaces/_api_types_.reverse.md b/docs/interfaces/_api_types_.reverse.md index 4d4cbeb..5d22650 100644 --- a/docs/interfaces/_api_types_.reverse.md +++ b/docs/interfaces/_api_types_.reverse.md @@ -24,7 +24,7 @@ Parameter to enable/disable Reverse feature. **● Mode**: *[ReverseMode](../enums/_api_types_.reversemode.md)* -*Defined in [api/types.ts:2145](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2145)* +*Defined in [api/types.ts:2145](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2145)* ___ diff --git a/docs/interfaces/_api_types_.reverseoptions.md b/docs/interfaces/_api_types_.reverseoptions.md index 615ec50..f845c6c 100644 --- a/docs/interfaces/_api_types_.reverseoptions.md +++ b/docs/interfaces/_api_types_.reverseoptions.md @@ -21,20 +21,20 @@ Options of Reverse mode parameter. -### Extension +### `` Extension **● Extension**: *[ReverseOptionsExtension](_api_types_.reverseoptionsextension.md)* -*Defined in [api/types.ts:2200](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2200)* +*Defined in [api/types.ts:2200](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2200)* ___ -### Mode +### `` Mode **● Mode**: *[ReverseMode](../enums/_api_types_.reversemode.md)* -*Defined in [api/types.ts:2199](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2199)* +*Defined in [api/types.ts:2199](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2199)* ___ diff --git a/docs/interfaces/_api_types_.rotate.md b/docs/interfaces/_api_types_.rotate.md index e5e6b93..b1101f1 100644 --- a/docs/interfaces/_api_types_.rotate.md +++ b/docs/interfaces/_api_types_.rotate.md @@ -22,20 +22,20 @@ Parameter to enable/disable Rotation feature. -### Degree +### `` Degree -**● Degree**: *`number`* +**● Degree**: *`undefined` \| `number`* -*Defined in [api/types.ts:435](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L435)* +*Defined in [api/types.ts:435](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L435)* ___ -### Extension +### `` Extension **● Extension**: *[RotateExtension](_api_types_.rotateextension.md)* -*Defined in [api/types.ts:436](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L436)* +*Defined in [api/types.ts:436](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L436)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *[RotateMode](../enums/_api_types_.rotatemode.md)* -*Defined in [api/types.ts:434](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L434)* +*Defined in [api/types.ts:434](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L434)* ___ diff --git a/docs/interfaces/_api_types_.rotateoptions.md b/docs/interfaces/_api_types_.rotateoptions.md index b465a28..592d15a 100644 --- a/docs/interfaces/_api_types_.rotateoptions.md +++ b/docs/interfaces/_api_types_.rotateoptions.md @@ -22,20 +22,20 @@ Supported options of Rotate mode parameter. -### DegreeList +### `` DegreeList **● DegreeList**: *[IntList](_api_types_.intlist.md)* -*Defined in [api/types.ts:502](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L502)* +*Defined in [api/types.ts:502](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L502)* ___ -### Extension +### `` Extension **● Extension**: *[RotateOptionsExtension](_api_types_.rotateoptionsextension.md)* -*Defined in [api/types.ts:503](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L503)* +*Defined in [api/types.ts:503](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L503)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *[RotateMode](../enums/_api_types_.rotatemode.md)* -*Defined in [api/types.ts:501](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L501)* +*Defined in [api/types.ts:501](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L501)* ___ diff --git a/docs/interfaces/_api_types_.ruleengineconfiguration.md b/docs/interfaces/_api_types_.ruleengineconfiguration.md index 5773ccf..8bc9412 100644 --- a/docs/interfaces/_api_types_.ruleengineconfiguration.md +++ b/docs/interfaces/_api_types_.ruleengineconfiguration.md @@ -19,20 +19,20 @@ -### Extension +### `` Extension **● Extension**: *[RuleEngineConfigurationExtension](_api_types_.ruleengineconfigurationextension.md)* -*Defined in [api/types.ts:3197](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3197)* +*Defined in [api/types.ts:3197](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3197)* ___ -### Rule +### `` Rule **● Rule**: *[Config](_api_types_.config.md)* -*Defined in [api/types.ts:3196](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3196)* +*Defined in [api/types.ts:3196](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3196)* ___ diff --git a/docs/interfaces/_api_types_.sceneorientation.md b/docs/interfaces/_api_types_.sceneorientation.md index 3d5a4bb..84d22e5 100644 --- a/docs/interfaces/_api_types_.sceneorientation.md +++ b/docs/interfaces/_api_types_.sceneorientation.md @@ -27,16 +27,16 @@ **● Mode**: *[SceneOrientationMode](../enums/_api_types_.sceneorientationmode.md)* -*Defined in [api/types.ts:518](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L518)* +*Defined in [api/types.ts:518](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L518)* ___ -### Orientation +### `` Orientation -**● Orientation**: *`string`* +**● Orientation**: *`undefined` \| `string`* -*Defined in [api/types.ts:519](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L519)* +*Defined in [api/types.ts:519](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L519)* ___ diff --git a/docs/interfaces/_api_types_.scope.md b/docs/interfaces/_api_types_.scope.md index ac35939..730625b 100644 --- a/docs/interfaces/_api_types_.scope.md +++ b/docs/interfaces/_api_types_.scope.md @@ -25,7 +25,7 @@ Indicates if the scope is fixed or configurable. **● ScopeDef**: *[ScopeDefinition](../enums/_api_types_.scopedefinition.md)* -*Defined in [api/types.ts:1020](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1020)* +*Defined in [api/types.ts:1020](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1020)* ___ @@ -34,7 +34,7 @@ ___ **● ScopeItem**: *`string`* -*Defined in [api/types.ts:1021](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1021)* +*Defined in [api/types.ts:1021](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1021)* ___ diff --git a/docs/interfaces/_api_types_.searchcapabilities.md b/docs/interfaces/_api_types_.searchcapabilities.md index 78f628b..acb9b7c 100644 --- a/docs/interfaces/_api_types_.searchcapabilities.md +++ b/docs/interfaces/_api_types_.searchcapabilities.md @@ -23,7 +23,7 @@ **● MetadataSearch**: *`boolean`* -*Defined in [api/types.ts:1714](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1714)* +*Defined in [api/types.ts:1714](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1714)* ___ @@ -32,7 +32,7 @@ ___ **● XAddr**: *`string`* -*Defined in [api/types.ts:1713](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1713)* +*Defined in [api/types.ts:1713](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1713)* ___ diff --git a/docs/interfaces/_api_types_.searchscope.md b/docs/interfaces/_api_types_.searchscope.md index 3fcd417..08bd2e3 100644 --- a/docs/interfaces/_api_types_.searchscope.md +++ b/docs/interfaces/_api_types_.searchscope.md @@ -23,38 +23,38 @@ A structure for defining a limited scope when searching in recorded data. -### Extension +### `` Extension **● Extension**: *[SearchScopeExtension](_api_types_.searchscopeextension.md)* -*Defined in [api/types.ts:3448](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3448)* +*Defined in [api/types.ts:3448](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3448)* ___ -### IncludedRecordings +### `` IncludedRecordings **● IncludedRecordings**: *[RecordingReference](../modules/_api_types_.md#recordingreference)* -*Defined in [api/types.ts:3446](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3446)* +*Defined in [api/types.ts:3446](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3446)* ___ -### IncludedSources +### `` IncludedSources **● IncludedSources**: *[SourceReference](_api_types_.sourcereference.md)* -*Defined in [api/types.ts:3445](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3445)* +*Defined in [api/types.ts:3445](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3445)* ___ -### RecordingInformationFilter +### `` RecordingInformationFilter **● RecordingInformationFilter**: *[XPathExpression](../modules/_api_types_.md#xpathexpression)* -*Defined in [api/types.ts:3447](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3447)* +*Defined in [api/types.ts:3447](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3447)* ___ diff --git a/docs/interfaces/_api_types_.securitycapabilities.md b/docs/interfaces/_api_types_.securitycapabilities.md index 3145b88..9b8579d 100644 --- a/docs/interfaces/_api_types_.securitycapabilities.md +++ b/docs/interfaces/_api_types_.securitycapabilities.md @@ -32,16 +32,16 @@ Indicates whether or not TLS 1.1 is supported. **● AccessPolicyConfig**: *`boolean`* -*Defined in [api/types.ts:1599](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1599)* +*Defined in [api/types.ts:1599](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1599)* ___ -### Extension +### `` Extension **● Extension**: *[SecurityCapabilitiesExtension](_api_types_.securitycapabilitiesextension.md)* -*Defined in [api/types.ts:1604](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1604)* +*Defined in [api/types.ts:1604](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1604)* ___ @@ -50,7 +50,7 @@ ___ **● KerberosToken**: *`boolean`* -*Defined in [api/types.ts:1602](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1602)* +*Defined in [api/types.ts:1602](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1602)* ___ @@ -59,7 +59,7 @@ ___ **● OnboardKeyGeneration**: *`boolean`* -*Defined in [api/types.ts:1598](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1598)* +*Defined in [api/types.ts:1598](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1598)* ___ @@ -68,7 +68,7 @@ ___ **● RELToken**: *`boolean`* -*Defined in [api/types.ts:1603](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1603)* +*Defined in [api/types.ts:1603](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1603)* ___ @@ -77,7 +77,7 @@ ___ **● SAMLToken**: *`boolean`* -*Defined in [api/types.ts:1601](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1601)* +*Defined in [api/types.ts:1601](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1601)* ___ @@ -86,7 +86,7 @@ ___ **● TLS1.1**: *`boolean`* -*Defined in [api/types.ts:1596](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1596)* +*Defined in [api/types.ts:1596](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1596)* ___ @@ -95,7 +95,7 @@ ___ **● TLS1.2**: *`boolean`* -*Defined in [api/types.ts:1597](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1597)* +*Defined in [api/types.ts:1597](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1597)* ___ @@ -104,7 +104,7 @@ ___ **● X.509Token**: *`boolean`* -*Defined in [api/types.ts:1600](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1600)* +*Defined in [api/types.ts:1600](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1600)* ___ diff --git a/docs/interfaces/_api_types_.securitycapabilitiesextension.md b/docs/interfaces/_api_types_.securitycapabilitiesextension.md index 8f00805..42d05c3 100644 --- a/docs/interfaces/_api_types_.securitycapabilitiesextension.md +++ b/docs/interfaces/_api_types_.securitycapabilitiesextension.md @@ -19,11 +19,11 @@ -### Extension +### `` Extension **● Extension**: *[SecurityCapabilitiesExtension2](_api_types_.securitycapabilitiesextension2.md)* -*Defined in [api/types.ts:1612](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1612)* +*Defined in [api/types.ts:1612](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1612)* ___ @@ -32,7 +32,7 @@ ___ **● TLS1.0**: *`boolean`* -*Defined in [api/types.ts:1611](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1611)* +*Defined in [api/types.ts:1611](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1611)* ___ diff --git a/docs/interfaces/_api_types_.securitycapabilitiesextension2.md b/docs/interfaces/_api_types_.securitycapabilitiesextension2.md index 400323e..2fe8b94 100644 --- a/docs/interfaces/_api_types_.securitycapabilitiesextension2.md +++ b/docs/interfaces/_api_types_.securitycapabilitiesextension2.md @@ -26,7 +26,7 @@ EAP Methods supported by the device. The int values refer to the IANA EAP Regist **● Dot1X**: *`boolean`* -*Defined in [api/types.ts:1619](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1619)* +*Defined in [api/types.ts:1619](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1619)* ___ @@ -35,16 +35,16 @@ ___ **● RemoteUserHandling**: *`boolean`* -*Defined in [api/types.ts:1621](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1621)* +*Defined in [api/types.ts:1621](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1621)* ___ -### SupportedEAPMethod +### `` SupportedEAPMethod -**● SupportedEAPMethod**: *`number`* +**● SupportedEAPMethod**: *`undefined` \| `number`* -*Defined in [api/types.ts:1620](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1620)* +*Defined in [api/types.ts:1620](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1620)* ___ diff --git a/docs/interfaces/_api_types_.sourceidentification.md b/docs/interfaces/_api_types_.sourceidentification.md index 87273c9..8291dcf 100644 --- a/docs/interfaces/_api_types_.sourceidentification.md +++ b/docs/interfaces/_api_types_.sourceidentification.md @@ -20,11 +20,11 @@ -### Extension +### `` Extension **● Extension**: *[SourceIdentificationExtension](_api_types_.sourceidentificationextension.md)* -*Defined in [api/types.ts:3845](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3845)* +*Defined in [api/types.ts:3845](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3845)* ___ @@ -33,7 +33,7 @@ ___ **● Name**: *`string`* -*Defined in [api/types.ts:3843](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3843)* +*Defined in [api/types.ts:3843](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3843)* ___ @@ -42,7 +42,7 @@ ___ **● Token**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3844](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3844)* +*Defined in [api/types.ts:3844](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3844)* ___ diff --git a/docs/interfaces/_api_types_.sourcereference.md b/docs/interfaces/_api_types_.sourcereference.md index aa01d44..1a7344b 100644 --- a/docs/interfaces/_api_types_.sourcereference.md +++ b/docs/interfaces/_api_types_.sourcereference.md @@ -22,7 +22,7 @@ **● Token**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:3421](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3421)* +*Defined in [api/types.ts:3421](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3421)* ___ diff --git a/docs/interfaces/_api_types_.space1ddescription.md b/docs/interfaces/_api_types_.space1ddescription.md index 9c82f48..c550b96 100644 --- a/docs/interfaces/_api_types_.space1ddescription.md +++ b/docs/interfaces/_api_types_.space1ddescription.md @@ -27,7 +27,7 @@ **● URI**: *`string`* -*Defined in [api/types.ts:2268](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2268)* +*Defined in [api/types.ts:2268](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2268)* ___ @@ -36,7 +36,7 @@ ___ **● XRange**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2269](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2269)* +*Defined in [api/types.ts:2269](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2269)* ___ diff --git a/docs/interfaces/_api_types_.space2ddescription.md b/docs/interfaces/_api_types_.space2ddescription.md index 7089c6f..0f6ed4d 100644 --- a/docs/interfaces/_api_types_.space2ddescription.md +++ b/docs/interfaces/_api_types_.space2ddescription.md @@ -28,7 +28,7 @@ **● URI**: *`string`* -*Defined in [api/types.ts:2257](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2257)* +*Defined in [api/types.ts:2257](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2257)* ___ @@ -37,7 +37,7 @@ ___ **● XRange**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2258](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2258)* +*Defined in [api/types.ts:2258](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2258)* ___ @@ -46,7 +46,7 @@ ___ **● YRange**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2259](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2259)* +*Defined in [api/types.ts:2259](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2259)* ___ diff --git a/docs/interfaces/_api_types_.storagereferencepath.md b/docs/interfaces/_api_types_.storagereferencepath.md index 9024ddf..d3efd3e 100644 --- a/docs/interfaces/_api_types_.storagereferencepath.md +++ b/docs/interfaces/_api_types_.storagereferencepath.md @@ -22,20 +22,20 @@ identifier of an existing Storage Configuration. -### Extension +### `` Extension **● Extension**: *[StorageReferencePathExtension](_api_types_.storagereferencepathextension.md)* -*Defined in [api/types.ts:4171](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4171)* +*Defined in [api/types.ts:4171](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4171)* ___ -### RelativePath +### `` RelativePath -**● RelativePath**: *`string`* +**● RelativePath**: *`undefined` \| `string`* -*Defined in [api/types.ts:4170](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4170)* +*Defined in [api/types.ts:4170](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4170)* ___ @@ -44,7 +44,7 @@ ___ **● StorageToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:4169](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L4169)* +*Defined in [api/types.ts:4169](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L4169)* ___ diff --git a/docs/interfaces/_api_types_.streamsetup.md b/docs/interfaces/_api_types_.streamsetup.md index 4e368a8..9699e2d 100644 --- a/docs/interfaces/_api_types_.streamsetup.md +++ b/docs/interfaces/_api_types_.streamsetup.md @@ -25,7 +25,7 @@ Defines if a multicast or unicast stream is requested **● Stream**: *[StreamType](../enums/_api_types_.streamtype.md)* -*Defined in [api/types.ts:994](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L994)* +*Defined in [api/types.ts:994](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L994)* ___ @@ -34,7 +34,7 @@ ___ **● Transport**: *[Transport](_api_types_.transport.md)* -*Defined in [api/types.ts:995](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L995)* +*Defined in [api/types.ts:995](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L995)* ___ diff --git a/docs/interfaces/_api_types_.supportedanalyticsmodules.md b/docs/interfaces/_api_types_.supportedanalyticsmodules.md index f8d1c9e..c0bab6b 100644 --- a/docs/interfaces/_api_types_.supportedanalyticsmodules.md +++ b/docs/interfaces/_api_types_.supportedanalyticsmodules.md @@ -22,29 +22,29 @@ It optionally contains a list of URLs that provide the location of schema files. -### AnalyticsModuleContentSchemaLocation +### `` AnalyticsModuleContentSchemaLocation -**● AnalyticsModuleContentSchemaLocation**: *`string`* +**● AnalyticsModuleContentSchemaLocation**: *`undefined` \| `string`* -*Defined in [api/types.ts:3255](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3255)* +*Defined in [api/types.ts:3255](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3255)* ___ -### AnalyticsModuleDescription +### `` AnalyticsModuleDescription **● AnalyticsModuleDescription**: *[ConfigDescription](_api_types_.configdescription.md)* -*Defined in [api/types.ts:3256](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3256)* +*Defined in [api/types.ts:3256](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3256)* ___ -### Extension +### `` Extension **● Extension**: *[SupportedAnalyticsModulesExtension](_api_types_.supportedanalyticsmodulesextension.md)* -*Defined in [api/types.ts:3257](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3257)* +*Defined in [api/types.ts:3257](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3257)* ___ diff --git a/docs/interfaces/_api_types_.supportedrules.md b/docs/interfaces/_api_types_.supportedrules.md index 8175c65..a6f1ce2 100644 --- a/docs/interfaces/_api_types_.supportedrules.md +++ b/docs/interfaces/_api_types_.supportedrules.md @@ -22,29 +22,29 @@ Lists the location of all schemas that are referenced in the rules. -### Extension +### `` Extension **● Extension**: *[SupportedRulesExtension](_api_types_.supportedrulesextension.md)* -*Defined in [api/types.ts:3239](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3239)* +*Defined in [api/types.ts:3239](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3239)* ___ -### RuleContentSchemaLocation +### `` RuleContentSchemaLocation -**● RuleContentSchemaLocation**: *`string`* +**● RuleContentSchemaLocation**: *`undefined` \| `string`* -*Defined in [api/types.ts:3237](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3237)* +*Defined in [api/types.ts:3237](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3237)* ___ -### RuleDescription +### `` RuleDescription **● RuleDescription**: *[ConfigDescription](_api_types_.configdescription.md)* -*Defined in [api/types.ts:3238](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3238)* +*Defined in [api/types.ts:3238](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3238)* ___ diff --git a/docs/interfaces/_api_types_.supportinformation.md b/docs/interfaces/_api_types_.supportinformation.md index f93a177..3556963 100644 --- a/docs/interfaces/_api_types_.supportinformation.md +++ b/docs/interfaces/_api_types_.supportinformation.md @@ -21,20 +21,20 @@ The support information as attachment data. -### Binary +### `` Binary **● Binary**: *[AttachmentData](_api_types_.attachmentdata.md)* -*Defined in [api/types.ts:1763](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1763)* +*Defined in [api/types.ts:1763](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1763)* ___ -### String +### `` String -**● String**: *`string`* +**● String**: *`undefined` \| `string`* -*Defined in [api/types.ts:1764](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1764)* +*Defined in [api/types.ts:1764](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1764)* ___ diff --git a/docs/interfaces/_api_types_.systemcapabilities.md b/docs/interfaces/_api_types_.systemcapabilities.md index bc8fc73..8dd2fa2 100644 --- a/docs/interfaces/_api_types_.systemcapabilities.md +++ b/docs/interfaces/_api_types_.systemcapabilities.md @@ -31,7 +31,7 @@ Indicates whether or not WS Discovery resolve requests are supported. **● DiscoveryBye**: *`boolean`* -*Defined in [api/types.ts:1629](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1629)* +*Defined in [api/types.ts:1629](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1629)* ___ @@ -40,16 +40,16 @@ ___ **● DiscoveryResolve**: *`boolean`* -*Defined in [api/types.ts:1628](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1628)* +*Defined in [api/types.ts:1628](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1628)* ___ -### Extension +### `` Extension **● Extension**: *[SystemCapabilitiesExtension](_api_types_.systemcapabilitiesextension.md)* -*Defined in [api/types.ts:1635](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1635)* +*Defined in [api/types.ts:1635](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1635)* ___ @@ -58,7 +58,7 @@ ___ **● FirmwareUpgrade**: *`boolean`* -*Defined in [api/types.ts:1633](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1633)* +*Defined in [api/types.ts:1633](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1633)* ___ @@ -67,7 +67,7 @@ ___ **● RemoteDiscovery**: *`boolean`* -*Defined in [api/types.ts:1630](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1630)* +*Defined in [api/types.ts:1630](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1630)* ___ @@ -76,7 +76,7 @@ ___ **● SupportedVersions**: *[OnvifVersion](_api_types_.onvifversion.md)* -*Defined in [api/types.ts:1634](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1634)* +*Defined in [api/types.ts:1634](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1634)* ___ @@ -85,7 +85,7 @@ ___ **● SystemBackup**: *`boolean`* -*Defined in [api/types.ts:1631](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1631)* +*Defined in [api/types.ts:1631](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1631)* ___ @@ -94,7 +94,7 @@ ___ **● SystemLogging**: *`boolean`* -*Defined in [api/types.ts:1632](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1632)* +*Defined in [api/types.ts:1632](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1632)* ___ diff --git a/docs/interfaces/_api_types_.systemcapabilitiesextension.md b/docs/interfaces/_api_types_.systemcapabilitiesextension.md index 88ab74e..941b743 100644 --- a/docs/interfaces/_api_types_.systemcapabilitiesextension.md +++ b/docs/interfaces/_api_types_.systemcapabilitiesextension.md @@ -22,47 +22,47 @@ -### Extension +### `` Extension **● Extension**: *[SystemCapabilitiesExtension2](_api_types_.systemcapabilitiesextension2.md)* -*Defined in [api/types.ts:1646](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1646)* +*Defined in [api/types.ts:1646](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1646)* ___ -### HttpFirmwareUpgrade +### `` HttpFirmwareUpgrade -**● HttpFirmwareUpgrade**: *`boolean`* +**● HttpFirmwareUpgrade**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1642](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1642)* +*Defined in [api/types.ts:1642](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1642)* ___ -### HttpSupportInformation +### `` HttpSupportInformation -**● HttpSupportInformation**: *`boolean`* +**● HttpSupportInformation**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1645](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1645)* +*Defined in [api/types.ts:1645](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1645)* ___ -### HttpSystemBackup +### `` HttpSystemBackup -**● HttpSystemBackup**: *`boolean`* +**● HttpSystemBackup**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1643](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1643)* +*Defined in [api/types.ts:1643](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1643)* ___ -### HttpSystemLogging +### `` HttpSystemLogging -**● HttpSystemLogging**: *`boolean`* +**● HttpSystemLogging**: *`undefined` \| `false` \| `true`* -*Defined in [api/types.ts:1644](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1644)* +*Defined in [api/types.ts:1644](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1644)* ___ diff --git a/docs/interfaces/_api_types_.systemdatetime.md b/docs/interfaces/_api_types_.systemdatetime.md index defb7d4..1c3be8a 100644 --- a/docs/interfaces/_api_types_.systemdatetime.md +++ b/docs/interfaces/_api_types_.systemdatetime.md @@ -29,7 +29,7 @@ General date time inforamtion returned by the GetSystemDateTime method. **● DateTimeType**: *[SetDateTimeType](../enums/_api_types_.setdatetimetype.md)* -*Defined in [api/types.ts:1807](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1807)* +*Defined in [api/types.ts:1807](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1807)* ___ @@ -38,43 +38,43 @@ ___ **● DaylightSavings**: *`boolean`* -*Defined in [api/types.ts:1808](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1808)* +*Defined in [api/types.ts:1808](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1808)* ___ -### Extension +### `` Extension **● Extension**: *[SystemDateTimeExtension](_api_types_.systemdatetimeextension.md)* -*Defined in [api/types.ts:1812](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1812)* +*Defined in [api/types.ts:1812](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1812)* ___ -### LocalDateTime +### `` LocalDateTime **● LocalDateTime**: *[DateTime](_api_types_.datetime.md)* -*Defined in [api/types.ts:1811](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1811)* +*Defined in [api/types.ts:1811](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1811)* ___ -### TimeZone +### `` TimeZone -**● TimeZone**: *[TimeZone](_api_types_.timezone.md)* +**● TimeZone**: *[TimeZone](_api_types_.systemdatetime.md#timezone)* -*Defined in [api/types.ts:1809](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1809)* +*Defined in [api/types.ts:1809](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1809)* ___ -### UTCDateTime +### `` UTCDateTime **● UTCDateTime**: *[DateTime](_api_types_.datetime.md)* -*Defined in [api/types.ts:1810](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1810)* +*Defined in [api/types.ts:1810](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1810)* ___ diff --git a/docs/interfaces/_api_types_.systemlog.md b/docs/interfaces/_api_types_.systemlog.md index c8d7b1b..994cddf 100644 --- a/docs/interfaces/_api_types_.systemlog.md +++ b/docs/interfaces/_api_types_.systemlog.md @@ -21,20 +21,20 @@ The log information as attachment data. -### Binary +### `` Binary **● Binary**: *[AttachmentData](_api_types_.attachmentdata.md)* -*Defined in [api/types.ts:1755](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1755)* +*Defined in [api/types.ts:1755](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1755)* ___ -### String +### `` String -**● String**: *`string`* +**● String**: *`undefined` \| `string`* -*Defined in [api/types.ts:1756](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1756)* +*Defined in [api/types.ts:1756](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1756)* ___ diff --git a/docs/interfaces/_api_types_.systemloguri.md b/docs/interfaces/_api_types_.systemloguri.md index b8b683d..30daba8 100644 --- a/docs/interfaces/_api_types_.systemloguri.md +++ b/docs/interfaces/_api_types_.systemloguri.md @@ -23,7 +23,7 @@ **● Type**: *[SystemLogType](../enums/_api_types_.systemlogtype.md)* -*Defined in [api/types.ts:1799](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1799)* +*Defined in [api/types.ts:1799](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1799)* ___ @@ -32,7 +32,7 @@ ___ **● Uri**: *`string`* -*Defined in [api/types.ts:1800](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1800)* +*Defined in [api/types.ts:1800](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1800)* ___ diff --git a/docs/interfaces/_api_types_.systemlogurilist.md b/docs/interfaces/_api_types_.systemlogurilist.md index ecf635a..382d93c 100644 --- a/docs/interfaces/_api_types_.systemlogurilist.md +++ b/docs/interfaces/_api_types_.systemlogurilist.md @@ -18,11 +18,11 @@ -### SystemLog +### `` SystemLog **● SystemLog**: *[SystemLogUri](_api_types_.systemloguri.md)* -*Defined in [api/types.ts:1792](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1792)* +*Defined in [api/types.ts:1792](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1792)* ___ diff --git a/docs/interfaces/_api_types_.time.md b/docs/interfaces/_api_types_.time.md index 7047e6b..6fecc6b 100644 --- a/docs/interfaces/_api_types_.time.md +++ b/docs/interfaces/_api_types_.time.md @@ -26,7 +26,7 @@ Range is 0 to 23. **● Hour**: *`number`* -*Defined in [api/types.ts:1842](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1842)* +*Defined in [api/types.ts:1842](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1842)* ___ @@ -35,7 +35,7 @@ ___ **● Minute**: *`number`* -*Defined in [api/types.ts:1843](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1843)* +*Defined in [api/types.ts:1843](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1843)* ___ @@ -44,7 +44,7 @@ ___ **● Second**: *`number`* -*Defined in [api/types.ts:1844](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1844)* +*Defined in [api/types.ts:1844](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1844)* ___ diff --git a/docs/interfaces/_api_types_.timezone.md b/docs/interfaces/_api_types_.timezone.md index 5b24825..46d885e 100644 --- a/docs/interfaces/_api_types_.timezone.md +++ b/docs/interfaces/_api_types_.timezone.md @@ -35,7 +35,7 @@ **● TZ**: *`string`* -*Defined in [api/types.ts:1862](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1862)* +*Defined in [api/types.ts:1862](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1862)* ___ diff --git a/docs/interfaces/_api_types_.tlsconfiguration.md b/docs/interfaces/_api_types_.tlsconfiguration.md index f2a9939..094cc12 100644 --- a/docs/interfaces/_api_types_.tlsconfiguration.md +++ b/docs/interfaces/_api_types_.tlsconfiguration.md @@ -22,7 +22,7 @@ **● CertificateID**: *`string`* -*Defined in [api/types.ts:2001](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2001)* +*Defined in [api/types.ts:2001](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2001)* ___ diff --git a/docs/interfaces/_api_types_.tonecompensation.md b/docs/interfaces/_api_types_.tonecompensation.md index e749f13..8806062 100644 --- a/docs/interfaces/_api_types_.tonecompensation.md +++ b/docs/interfaces/_api_types_.tonecompensation.md @@ -22,20 +22,20 @@ Parameter to enable/disable or automatic ToneCompensation feature. Its options s -### Extension +### `` Extension **● Extension**: *[ToneCompensationExtension](_api_types_.tonecompensationextension.md)* -*Defined in [api/types.ts:2823](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2823)* +*Defined in [api/types.ts:2823](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2823)* ___ -### Level +### `` Level -**● Level**: *`number`* +**● Level**: *`undefined` \| `number`* -*Defined in [api/types.ts:2822](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2822)* +*Defined in [api/types.ts:2822](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2822)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *`string`* -*Defined in [api/types.ts:2821](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2821)* +*Defined in [api/types.ts:2821](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2821)* ___ diff --git a/docs/interfaces/_api_types_.tonecompensationoptions.md b/docs/interfaces/_api_types_.tonecompensationoptions.md index 1eeb2e8..b8cdb92 100644 --- a/docs/interfaces/_api_types_.tonecompensationoptions.md +++ b/docs/interfaces/_api_types_.tonecompensationoptions.md @@ -25,7 +25,7 @@ Supported options for Tone Compensation mode. Its options shall be chosen from t **● Level**: *`boolean`* -*Defined in [api/types.ts:3090](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3090)* +*Defined in [api/types.ts:3090](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3090)* ___ @@ -34,7 +34,7 @@ ___ **● Mode**: *`string`* -*Defined in [api/types.ts:3089](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3089)* +*Defined in [api/types.ts:3089](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3089)* ___ diff --git a/docs/interfaces/_api_types_.trackattributes.md b/docs/interfaces/_api_types_.trackattributes.md index d16b773..c2ec79a 100644 --- a/docs/interfaces/_api_types_.trackattributes.md +++ b/docs/interfaces/_api_types_.trackattributes.md @@ -24,29 +24,29 @@ The basic information about the track. Note that a track may represent a single -### AudioAttributes +### `` AudioAttributes -**● AudioAttributes**: *[AudioAttributes](_api_types_.audioattributes.md)* +**● AudioAttributes**: *[AudioAttributes](_api_types_.trackattributes.md#audioattributes)* -*Defined in [api/types.ts:3599](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3599)* +*Defined in [api/types.ts:3599](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3599)* ___ -### Extension +### `` Extension **● Extension**: *[TrackAttributesExtension](_api_types_.trackattributesextension.md)* -*Defined in [api/types.ts:3601](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3601)* +*Defined in [api/types.ts:3601](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3601)* ___ -### MetadataAttributes +### `` MetadataAttributes -**● MetadataAttributes**: *[MetadataAttributes](_api_types_.metadataattributes.md)* +**● MetadataAttributes**: *[MetadataAttributes](_api_types_.trackattributes.md#metadataattributes)* -*Defined in [api/types.ts:3600](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3600)* +*Defined in [api/types.ts:3600](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3600)* ___ @@ -55,16 +55,16 @@ ___ **● TrackInformation**: *[TrackInformation](_api_types_.trackinformation.md)* -*Defined in [api/types.ts:3597](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3597)* +*Defined in [api/types.ts:3597](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3597)* ___ -### VideoAttributes +### `` VideoAttributes -**● VideoAttributes**: *[VideoAttributes](_api_types_.videoattributes.md)* +**● VideoAttributes**: *[VideoAttributes](_api_types_.trackattributes.md#videoattributes)* -*Defined in [api/types.ts:3598](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3598)* +*Defined in [api/types.ts:3598](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3598)* ___ diff --git a/docs/interfaces/_api_types_.trackconfiguration.md b/docs/interfaces/_api_types_.trackconfiguration.md index 5593285..ce94fb4 100644 --- a/docs/interfaces/_api_types_.trackconfiguration.md +++ b/docs/interfaces/_api_types_.trackconfiguration.md @@ -25,7 +25,7 @@ Type of the track. It shall be equal to the strings “Video”, “Audio” or **● Description**: *[Description](_api_types_.trackconfiguration.md#description)* -*Defined in [api/types.ts:3654](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3654)* +*Defined in [api/types.ts:3654](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3654)* ___ @@ -34,7 +34,7 @@ ___ **● TrackType**: *[TrackType](../enums/_api_types_.tracktype.md)* -*Defined in [api/types.ts:3653](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3653)* +*Defined in [api/types.ts:3653](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3653)* ___ diff --git a/docs/interfaces/_api_types_.trackinformation.md b/docs/interfaces/_api_types_.trackinformation.md index a5a810b..0dec0ed 100644 --- a/docs/interfaces/_api_types_.trackinformation.md +++ b/docs/interfaces/_api_types_.trackinformation.md @@ -28,7 +28,7 @@ Type of the track: "Video", "Audio" or "Metadata". The track shall only be able **● DataFrom**: *`string`* -*Defined in [api/types.ts:3579](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3579)* +*Defined in [api/types.ts:3579](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3579)* ___ @@ -37,7 +37,7 @@ ___ **● DataTo**: *`string`* -*Defined in [api/types.ts:3580](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3580)* +*Defined in [api/types.ts:3580](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3580)* ___ @@ -46,7 +46,7 @@ ___ **● Description**: *[Description](_api_types_.trackinformation.md#description)* -*Defined in [api/types.ts:3578](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3578)* +*Defined in [api/types.ts:3578](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3578)* ___ @@ -55,7 +55,7 @@ ___ **● TrackToken**: *[TrackReference](../modules/_api_types_.md#trackreference)* -*Defined in [api/types.ts:3576](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3576)* +*Defined in [api/types.ts:3576](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3576)* ___ @@ -64,7 +64,7 @@ ___ **● TrackType**: *[TrackType](../enums/_api_types_.tracktype.md)* -*Defined in [api/types.ts:3577](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3577)* +*Defined in [api/types.ts:3577](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3577)* ___ diff --git a/docs/interfaces/_api_types_.transformation.md b/docs/interfaces/_api_types_.transformation.md index 4037c67..2b0e5bb 100644 --- a/docs/interfaces/_api_types_.transformation.md +++ b/docs/interfaces/_api_types_.transformation.md @@ -20,29 +20,29 @@ -### Extension +### `` Extension **● Extension**: *[TransformationExtension](_api_types_.transformationextension.md)* -*Defined in [api/types.ts:213](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L213)* +*Defined in [api/types.ts:213](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L213)* ___ -### Scale +### `` Scale **● Scale**: *[Vector](_api_types_.vector.md)* -*Defined in [api/types.ts:212](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L212)* +*Defined in [api/types.ts:212](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L212)* ___ -### Translate +### `` Translate **● Translate**: *[Vector](_api_types_.vector.md)* -*Defined in [api/types.ts:211](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L211)* +*Defined in [api/types.ts:211](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L211)* ___ diff --git a/docs/interfaces/_api_types_.transport.md b/docs/interfaces/_api_types_.transport.md index ea5980e..25c0cc4 100644 --- a/docs/interfaces/_api_types_.transport.md +++ b/docs/interfaces/_api_types_.transport.md @@ -25,16 +25,16 @@ Defines the network protocol for streaming, either UDP=RTP/UDP, RTSP=RTP/RTSP/TC **● Protocol**: *[TransportProtocol](../enums/_api_types_.transportprotocol.md)* -*Defined in [api/types.ts:1002](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1002)* +*Defined in [api/types.ts:1002](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1002)* ___ -### Tunnel +### `` Tunnel **● Tunnel**: *[Transport](_api_types_.transport.md)* -*Defined in [api/types.ts:1003](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1003)* +*Defined in [api/types.ts:1003](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1003)* ___ diff --git a/docs/interfaces/_api_types_.user.md b/docs/interfaces/_api_types_.user.md index a7e0016..d1d2226 100644 --- a/docs/interfaces/_api_types_.user.md +++ b/docs/interfaces/_api_types_.user.md @@ -23,20 +23,20 @@ Username string. -### Extension +### `` Extension **● Extension**: *[UserExtension](_api_types_.userextension.md)* -*Defined in [api/types.ts:1881](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1881)* +*Defined in [api/types.ts:1881](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1881)* ___ -### Password +### `` Password -**● Password**: *`string`* +**● Password**: *`undefined` \| `string`* -*Defined in [api/types.ts:1879](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1879)* +*Defined in [api/types.ts:1879](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1879)* ___ @@ -45,7 +45,7 @@ ___ **● UserLevel**: *[UserLevel](../enums/_api_types_.userlevel.md)* -*Defined in [api/types.ts:1880](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1880)* +*Defined in [api/types.ts:1880](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1880)* ___ @@ -54,7 +54,7 @@ ___ **● Username**: *`string`* -*Defined in [api/types.ts:1878](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L1878)* +*Defined in [api/types.ts:1878](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L1878)* ___ diff --git a/docs/interfaces/_api_types_.videoanalyticsconfiguration.md b/docs/interfaces/_api_types_.videoanalyticsconfiguration.md index fccf99b..f265f65 100644 --- a/docs/interfaces/_api_types_.videoanalyticsconfiguration.md +++ b/docs/interfaces/_api_types_.videoanalyticsconfiguration.md @@ -23,7 +23,7 @@ **● AnalyticsEngineConfiguration**: *[AnalyticsEngineConfiguration](_api_types_.analyticsengineconfiguration.md)* -*Defined in [api/types.ts:756](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L756)* +*Defined in [api/types.ts:756](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L756)* ___ @@ -32,7 +32,7 @@ ___ **● RuleEngineConfiguration**: *[RuleEngineConfiguration](_api_types_.ruleengineconfiguration.md)* -*Defined in [api/types.ts:757](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L757)* +*Defined in [api/types.ts:757](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L757)* ___ diff --git a/docs/interfaces/_api_types_.videoattributes.md b/docs/interfaces/_api_types_.videoattributes.md index 88f4469..b075030 100644 --- a/docs/interfaces/_api_types_.videoattributes.md +++ b/docs/interfaces/_api_types_.videoattributes.md @@ -24,11 +24,11 @@ Average bitrate in kbps. -### Bitrate +### `` Bitrate -**● Bitrate**: *`number`* +**● Bitrate**: *`undefined` \| `number`* -*Defined in [api/types.ts:3614](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3614)* +*Defined in [api/types.ts:3614](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3614)* ___ @@ -37,7 +37,7 @@ ___ **● Encoding**: *`string`* -*Defined in [api/types.ts:3617](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3617)* +*Defined in [api/types.ts:3617](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3617)* ___ @@ -46,7 +46,7 @@ ___ **● Framerate**: *`number`* -*Defined in [api/types.ts:3618](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3618)* +*Defined in [api/types.ts:3618](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3618)* ___ @@ -55,7 +55,7 @@ ___ **● Height**: *`number`* -*Defined in [api/types.ts:3616](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3616)* +*Defined in [api/types.ts:3616](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3616)* ___ @@ -64,7 +64,7 @@ ___ **● Width**: *`number`* -*Defined in [api/types.ts:3615](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3615)* +*Defined in [api/types.ts:3615](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3615)* ___ diff --git a/docs/interfaces/_api_types_.videodecoderconfigurationoptions.md b/docs/interfaces/_api_types_.videodecoderconfigurationoptions.md index 12346f1..5426726 100644 --- a/docs/interfaces/_api_types_.videodecoderconfigurationoptions.md +++ b/docs/interfaces/_api_types_.videodecoderconfigurationoptions.md @@ -23,38 +23,38 @@ If the device is able to decode Jpeg streams this element describes the supporte -### Extension +### `` Extension **● Extension**: *[VideoDecoderConfigurationOptionsExtension](_api_types_.videodecoderconfigurationoptionsextension.md)* -*Defined in [api/types.ts:871](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L871)* +*Defined in [api/types.ts:871](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L871)* ___ -### H264DecOptions +### `` H264DecOptions -**● H264DecOptions**: *[H264DecOptions](_api_types_.h264decoptions.md)* +**● H264DecOptions**: *[H264DecOptions](_api_types_.videodecoderconfigurationoptions.md#h264decoptions)* -*Defined in [api/types.ts:869](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L869)* +*Defined in [api/types.ts:869](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L869)* ___ -### JpegDecOptions +### `` JpegDecOptions -**● JpegDecOptions**: *[JpegDecOptions](_api_types_.jpegdecoptions.md)* +**● JpegDecOptions**: *[JpegDecOptions](_api_types_.videodecoderconfigurationoptions.md#jpegdecoptions)* -*Defined in [api/types.ts:868](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L868)* +*Defined in [api/types.ts:868](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L868)* ___ -### Mpeg4DecOptions +### `` Mpeg4DecOptions -**● Mpeg4DecOptions**: *[Mpeg4DecOptions](_api_types_.mpeg4decoptions.md)* +**● Mpeg4DecOptions**: *[Mpeg4DecOptions](_api_types_.videodecoderconfigurationoptions.md#mpeg4decoptions)* -*Defined in [api/types.ts:870](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L870)* +*Defined in [api/types.ts:870](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L870)* ___ diff --git a/docs/interfaces/_api_types_.videoencoder2configuration.md b/docs/interfaces/_api_types_.videoencoder2configuration.md index b7a85a9..b5d2fc1 100644 --- a/docs/interfaces/_api_types_.videoencoder2configuration.md +++ b/docs/interfaces/_api_types_.videoencoder2configuration.md @@ -28,16 +28,16 @@ Video Media Subtype for the video format. For definitions see tt:VideoEncodingMi **● Encoding**: *`string`* -*Defined in [api/types.ts:652](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L652)* +*Defined in [api/types.ts:652](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L652)* ___ -### Multicast +### `` Multicast **● Multicast**: *[MulticastConfiguration](_api_types_.multicastconfiguration.md)* -*Defined in [api/types.ts:655](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L655)* +*Defined in [api/types.ts:655](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L655)* ___ @@ -46,16 +46,16 @@ ___ **● Quality**: *`number`* -*Defined in [api/types.ts:656](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L656)* +*Defined in [api/types.ts:656](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L656)* ___ -### RateControl +### `` RateControl **● RateControl**: *[VideoRateControl2](_api_types_.videoratecontrol2.md)* -*Defined in [api/types.ts:654](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L654)* +*Defined in [api/types.ts:654](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L654)* ___ @@ -64,7 +64,7 @@ ___ **● Resolution**: *[VideoResolution2](_api_types_.videoresolution2.md)* -*Defined in [api/types.ts:653](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L653)* +*Defined in [api/types.ts:653](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L653)* ___ diff --git a/docs/interfaces/_api_types_.videoencoder2configurationoptions.md b/docs/interfaces/_api_types_.videoencoder2configurationoptions.md index b3e4f48..e896adc 100644 --- a/docs/interfaces/_api_types_.videoencoder2configurationoptions.md +++ b/docs/interfaces/_api_types_.videoencoder2configurationoptions.md @@ -27,7 +27,7 @@ Video Media Subtype for the video format. For definitions see tt:VideoEncodingMi **● BitrateRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:682](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L682)* +*Defined in [api/types.ts:682](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L682)* ___ @@ -36,7 +36,7 @@ ___ **● Encoding**: *`string`* -*Defined in [api/types.ts:679](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L679)* +*Defined in [api/types.ts:679](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L679)* ___ @@ -45,7 +45,7 @@ ___ **● QualityRange**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:680](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L680)* +*Defined in [api/types.ts:680](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L680)* ___ @@ -54,7 +54,7 @@ ___ **● ResolutionsAvailable**: *[VideoResolution2](_api_types_.videoresolution2.md)* -*Defined in [api/types.ts:681](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L681)* +*Defined in [api/types.ts:681](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L681)* ___ diff --git a/docs/interfaces/_api_types_.videoencoderconfiguration.md b/docs/interfaces/_api_types_.videoencoderconfiguration.md index bb85f8e..897ee51 100644 --- a/docs/interfaces/_api_types_.videoencoderconfiguration.md +++ b/docs/interfaces/_api_types_.videoencoderconfiguration.md @@ -31,25 +31,25 @@ Used video codec, either Jpeg, H.264 or Mpeg4 **● Encoding**: *[VideoEncoding](../enums/_api_types_.videoencoding.md)* -*Defined in [api/types.ts:526](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L526)* +*Defined in [api/types.ts:526](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L526)* ___ -### H264 +### `` H264 **● H264**: *[H264Configuration](_api_types_.h264configuration.md)* -*Defined in [api/types.ts:531](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L531)* +*Defined in [api/types.ts:531](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L531)* ___ -### MPEG4 +### `` MPEG4 **● MPEG4**: *[Mpeg4Configuration](_api_types_.mpeg4configuration.md)* -*Defined in [api/types.ts:530](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L530)* +*Defined in [api/types.ts:530](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L530)* ___ @@ -58,7 +58,7 @@ ___ **● Multicast**: *[MulticastConfiguration](_api_types_.multicastconfiguration.md)* -*Defined in [api/types.ts:532](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L532)* +*Defined in [api/types.ts:532](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L532)* ___ @@ -67,16 +67,16 @@ ___ **● Quality**: *`number`* -*Defined in [api/types.ts:528](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L528)* +*Defined in [api/types.ts:528](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L528)* ___ -### RateControl +### `` RateControl **● RateControl**: *[VideoRateControl](_api_types_.videoratecontrol.md)* -*Defined in [api/types.ts:529](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L529)* +*Defined in [api/types.ts:529](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L529)* ___ @@ -85,7 +85,7 @@ ___ **● Resolution**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:527](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L527)* +*Defined in [api/types.ts:527](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L527)* ___ @@ -94,7 +94,7 @@ ___ **● SessionTimeout**: *`string`* -*Defined in [api/types.ts:533](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L533)* +*Defined in [api/types.ts:533](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L533)* ___ diff --git a/docs/interfaces/_api_types_.videoencoderconfigurationoptions.md b/docs/interfaces/_api_types_.videoencoderconfigurationoptions.md index 0e3777b..3640bf5 100644 --- a/docs/interfaces/_api_types_.videoencoderconfigurationoptions.md +++ b/docs/interfaces/_api_types_.videoencoderconfigurationoptions.md @@ -24,38 +24,38 @@ Range of the quality values. A high value means higher quality. -### Extension +### `` Extension **● Extension**: *[VideoEncoderOptionsExtension](_api_types_.videoencoderoptionsextension.md)* -*Defined in [api/types.ts:577](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L577)* +*Defined in [api/types.ts:577](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L577)* ___ -### H264 +### `` H264 **● H264**: *[H264Options](_api_types_.h264options.md)* -*Defined in [api/types.ts:576](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L576)* +*Defined in [api/types.ts:576](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L576)* ___ -### JPEG +### `` JPEG **● JPEG**: *[JpegOptions](_api_types_.jpegoptions.md)* -*Defined in [api/types.ts:574](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L574)* +*Defined in [api/types.ts:574](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L574)* ___ -### MPEG4 +### `` MPEG4 **● MPEG4**: *[Mpeg4Options](_api_types_.mpeg4options.md)* -*Defined in [api/types.ts:575](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L575)* +*Defined in [api/types.ts:575](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L575)* ___ @@ -64,7 +64,7 @@ ___ **● QualityRange**: *[IntRange](_api_types_.intrange.md)* -*Defined in [api/types.ts:573](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L573)* +*Defined in [api/types.ts:573](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L573)* ___ diff --git a/docs/interfaces/_api_types_.videoencoderoptionsextension.md b/docs/interfaces/_api_types_.videoencoderoptionsextension.md index 3e78a66..2e5586f 100644 --- a/docs/interfaces/_api_types_.videoencoderoptionsextension.md +++ b/docs/interfaces/_api_types_.videoencoderoptionsextension.md @@ -23,38 +23,38 @@ Optional JPEG encoder settings ranges. -### Extension +### `` Extension **● Extension**: *[VideoEncoderOptionsExtension2](_api_types_.videoencoderoptionsextension2.md)* -*Defined in [api/types.ts:587](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L587)* +*Defined in [api/types.ts:587](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L587)* ___ -### H264 +### `` H264 **● H264**: *[H264Options2](_api_types_.h264options2.md)* -*Defined in [api/types.ts:586](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L586)* +*Defined in [api/types.ts:586](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L586)* ___ -### JPEG +### `` JPEG **● JPEG**: *[JpegOptions2](_api_types_.jpegoptions2.md)* -*Defined in [api/types.ts:584](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L584)* +*Defined in [api/types.ts:584](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L584)* ___ -### MPEG4 +### `` MPEG4 **● MPEG4**: *[Mpeg4Options2](_api_types_.mpeg4options2.md)* -*Defined in [api/types.ts:585](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L585)* +*Defined in [api/types.ts:585](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L585)* ___ diff --git a/docs/interfaces/_api_types_.videooutput.md b/docs/interfaces/_api_types_.videooutput.md index 1502927..b2e4549 100644 --- a/docs/interfaces/_api_types_.videooutput.md +++ b/docs/interfaces/_api_types_.videooutput.md @@ -24,20 +24,20 @@ Representation of a physical video outputs. -### AspectRatio +### `` AspectRatio -**● AspectRatio**: *`number`* +**● AspectRatio**: *`undefined` \| `number`* -*Defined in [api/types.ts:841](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L841)* +*Defined in [api/types.ts:841](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L841)* ___ -### Extension +### `` Extension **● Extension**: *[VideoOutputExtension](_api_types_.videooutputextension.md)* -*Defined in [api/types.ts:842](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L842)* +*Defined in [api/types.ts:842](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L842)* ___ @@ -46,25 +46,25 @@ ___ **● Layout**: *[Layout](_api_types_.layout.md)* -*Defined in [api/types.ts:838](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L838)* +*Defined in [api/types.ts:838](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L838)* ___ -### RefreshRate +### `` RefreshRate -**● RefreshRate**: *`number`* +**● RefreshRate**: *`undefined` \| `number`* -*Defined in [api/types.ts:840](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L840)* +*Defined in [api/types.ts:840](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L840)* ___ -### Resolution +### `` Resolution **● Resolution**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:839](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L839)* +*Defined in [api/types.ts:839](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L839)* ___ diff --git a/docs/interfaces/_api_types_.videooutputconfiguration.md b/docs/interfaces/_api_types_.videooutputconfiguration.md index 97fdaf7..67d4c9e 100644 --- a/docs/interfaces/_api_types_.videooutputconfiguration.md +++ b/docs/interfaces/_api_types_.videooutputconfiguration.md @@ -24,7 +24,7 @@ Token of the Video Output the configuration applies to **● OutputToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:855](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L855)* +*Defined in [api/types.ts:855](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L855)* ___ diff --git a/docs/interfaces/_api_types_.videoratecontrol.md b/docs/interfaces/_api_types_.videoratecontrol.md index e017a55..e02ec40 100644 --- a/docs/interfaces/_api_types_.videoratecontrol.md +++ b/docs/interfaces/_api_types_.videoratecontrol.md @@ -26,7 +26,7 @@ Maximum output framerate in fps. If an EncodingInterval is provided the resultin **● BitrateLimit**: *`number`* -*Defined in [api/types.ts:550](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L550)* +*Defined in [api/types.ts:550](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L550)* ___ @@ -35,7 +35,7 @@ ___ **● EncodingInterval**: *`number`* -*Defined in [api/types.ts:549](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L549)* +*Defined in [api/types.ts:549](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L549)* ___ @@ -44,7 +44,7 @@ ___ **● FrameRateLimit**: *`number`* -*Defined in [api/types.ts:548](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L548)* +*Defined in [api/types.ts:548](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L548)* ___ diff --git a/docs/interfaces/_api_types_.videoratecontrol2.md b/docs/interfaces/_api_types_.videoratecontrol2.md index 66d3c94..97be940 100644 --- a/docs/interfaces/_api_types_.videoratecontrol2.md +++ b/docs/interfaces/_api_types_.videoratecontrol2.md @@ -25,7 +25,7 @@ Desired frame rate in fps. The actual rate may be lower due to e.g. performance **● BitrateLimit**: *`number`* -*Defined in [api/types.ts:672](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L672)* +*Defined in [api/types.ts:672](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L672)* ___ @@ -34,7 +34,7 @@ ___ **● FrameRateLimit**: *`number`* -*Defined in [api/types.ts:671](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L671)* +*Defined in [api/types.ts:671](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L671)* ___ diff --git a/docs/interfaces/_api_types_.videoresolution.md b/docs/interfaces/_api_types_.videoresolution.md index 43bc4a1..0001964 100644 --- a/docs/interfaces/_api_types_.videoresolution.md +++ b/docs/interfaces/_api_types_.videoresolution.md @@ -25,7 +25,7 @@ Number of the columns of the Video image. **● Height**: *`number`* -*Defined in [api/types.ts:541](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L541)* +*Defined in [api/types.ts:541](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L541)* ___ @@ -34,7 +34,7 @@ ___ **● Width**: *`number`* -*Defined in [api/types.ts:540](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L540)* +*Defined in [api/types.ts:540](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L540)* ___ diff --git a/docs/interfaces/_api_types_.videoresolution2.md b/docs/interfaces/_api_types_.videoresolution2.md index c65b99d..0b0366c 100644 --- a/docs/interfaces/_api_types_.videoresolution2.md +++ b/docs/interfaces/_api_types_.videoresolution2.md @@ -25,7 +25,7 @@ Number of the columns of the Video image. **● Height**: *`number`* -*Defined in [api/types.ts:664](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L664)* +*Defined in [api/types.ts:664](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L664)* ___ @@ -34,7 +34,7 @@ ___ **● Width**: *`number`* -*Defined in [api/types.ts:663](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L663)* +*Defined in [api/types.ts:663](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L663)* ___ diff --git a/docs/interfaces/_api_types_.videosource.md b/docs/interfaces/_api_types_.videosource.md index b890aef..3528319 100644 --- a/docs/interfaces/_api_types_.videosource.md +++ b/docs/interfaces/_api_types_.videosource.md @@ -23,11 +23,11 @@ Representation of a physical video input. -### Extension +### `` Extension **● Extension**: *[VideoSourceExtension](_api_types_.videosourceextension.md)* -*Defined in [api/types.ts:329](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L329)* +*Defined in [api/types.ts:329](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L329)* ___ @@ -36,16 +36,16 @@ ___ **● Framerate**: *`number`* -*Defined in [api/types.ts:326](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L326)* +*Defined in [api/types.ts:326](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L326)* ___ -### Imaging +### `` Imaging **● Imaging**: *[ImagingSettings](_api_types_.imagingsettings.md)* -*Defined in [api/types.ts:328](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L328)* +*Defined in [api/types.ts:328](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L328)* ___ @@ -54,7 +54,7 @@ ___ **● Resolution**: *[VideoResolution](_api_types_.videoresolution.md)* -*Defined in [api/types.ts:327](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L327)* +*Defined in [api/types.ts:327](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L327)* ___ diff --git a/docs/interfaces/_api_types_.videosourceconfiguration.md b/docs/interfaces/_api_types_.videosourceconfiguration.md index 8a07193..537d9db 100644 --- a/docs/interfaces/_api_types_.videosourceconfiguration.md +++ b/docs/interfaces/_api_types_.videosourceconfiguration.md @@ -26,16 +26,16 @@ Reference to the physical input. **● Bounds**: *[IntRectangle](_api_types_.intrectangle.md)* -*Defined in [api/types.ts:405](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L405)* +*Defined in [api/types.ts:405](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L405)* ___ -### Extension +### `` Extension **● Extension**: *[VideoSourceConfigurationExtension](_api_types_.videosourceconfigurationextension.md)* -*Defined in [api/types.ts:406](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L406)* +*Defined in [api/types.ts:406](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L406)* ___ @@ -44,7 +44,7 @@ ___ **● SourceToken**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:404](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L404)* +*Defined in [api/types.ts:404](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L404)* ___ diff --git a/docs/interfaces/_api_types_.videosourceconfigurationextension.md b/docs/interfaces/_api_types_.videosourceconfigurationextension.md index d2a1712..2c9cb1c 100644 --- a/docs/interfaces/_api_types_.videosourceconfigurationextension.md +++ b/docs/interfaces/_api_types_.videosourceconfigurationextension.md @@ -21,20 +21,20 @@ Optional element to configure rotation of captured image. What resolutions a dev -### Extension +### `` Extension **● Extension**: *[VideoSourceConfigurationExtension2](_api_types_.videosourceconfigurationextension2.md)* -*Defined in [api/types.ts:419](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L419)* +*Defined in [api/types.ts:419](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L419)* ___ -### Rotate +### `` Rotate -**● Rotate**: *[Rotate](_api_types_.rotate.md)* +**● Rotate**: *[Rotate](_api_types_.videosourceconfigurationextension.md#rotate)* -*Defined in [api/types.ts:418](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L418)* +*Defined in [api/types.ts:418](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L418)* ___ diff --git a/docs/interfaces/_api_types_.videosourceconfigurationextension2.md b/docs/interfaces/_api_types_.videosourceconfigurationextension2.md index 19520a6..0309b9e 100644 --- a/docs/interfaces/_api_types_.videosourceconfigurationextension2.md +++ b/docs/interfaces/_api_types_.videosourceconfigurationextension2.md @@ -21,20 +21,20 @@ Optional element describing the geometric lens distortion. Multiple instances fo -### LensDescription +### `` LensDescription -**● LensDescription**: *[LensDescription](_api_types_.lensdescription.md)* +**● LensDescription**: *[LensDescription](_api_types_.videosourceconfigurationextension2.md#lensdescription)* -*Defined in [api/types.ts:426](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L426)* +*Defined in [api/types.ts:426](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L426)* ___ -### SceneOrientation +### `` SceneOrientation -**● SceneOrientation**: *[SceneOrientation](_api_types_.sceneorientation.md)* +**● SceneOrientation**: *[SceneOrientation](_api_types_.videosourceconfigurationextension2.md#sceneorientation)* -*Defined in [api/types.ts:427](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L427)* +*Defined in [api/types.ts:427](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L427)* ___ diff --git a/docs/interfaces/_api_types_.videosourceconfigurationoptions.md b/docs/interfaces/_api_types_.videosourceconfigurationoptions.md index 193146f..c0b978b 100644 --- a/docs/interfaces/_api_types_.videosourceconfigurationoptions.md +++ b/docs/interfaces/_api_types_.videosourceconfigurationoptions.md @@ -30,16 +30,16 @@ **● BoundsRange**: *[IntRectangleRange](_api_types_.intrectanglerange.md)* -*Defined in [api/types.ts:477](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L477)* +*Defined in [api/types.ts:477](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L477)* ___ -### Extension +### `` Extension **● Extension**: *[VideoSourceConfigurationOptionsExtension](_api_types_.videosourceconfigurationoptionsextension.md)* -*Defined in [api/types.ts:479](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L479)* +*Defined in [api/types.ts:479](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L479)* ___ @@ -48,7 +48,7 @@ ___ **● VideoSourceTokensAvailable**: *[ReferenceToken](../modules/_api_types_.md#referencetoken)* -*Defined in [api/types.ts:478](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L478)* +*Defined in [api/types.ts:478](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L478)* ___ diff --git a/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension.md b/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension.md index 343aa4e..fdb5f5c 100644 --- a/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension.md +++ b/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension.md @@ -21,20 +21,20 @@ Options of parameters for Rotation feature. -### Extension +### `` Extension **● Extension**: *[VideoSourceConfigurationOptionsExtension2](_api_types_.videosourceconfigurationoptionsextension2.md)* -*Defined in [api/types.ts:487](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L487)* +*Defined in [api/types.ts:487](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L487)* ___ -### Rotate +### `` Rotate **● Rotate**: *[RotateOptions](_api_types_.rotateoptions.md)* -*Defined in [api/types.ts:486](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L486)* +*Defined in [api/types.ts:486](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L486)* ___ diff --git a/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension2.md b/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension2.md index 1e4cd77..1e353d9 100644 --- a/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension2.md +++ b/docs/interfaces/_api_types_.videosourceconfigurationoptionsextension2.md @@ -20,11 +20,11 @@ Scene orientation modes supported by the device for this configuration. -### SceneOrientationMode +### `` SceneOrientationMode -**● SceneOrientationMode**: *[SceneOrientationMode](../enums/_api_types_.sceneorientationmode.md)* +**● SceneOrientationMode**: *[SceneOrientationMode](_api_types_.videosourceconfigurationoptionsextension2.md#sceneorientationmode)* -*Defined in [api/types.ts:494](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L494)* +*Defined in [api/types.ts:494](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L494)* ___ diff --git a/docs/interfaces/_api_types_.videosourceextension.md b/docs/interfaces/_api_types_.videosourceextension.md index a7ff207..1e0d034 100644 --- a/docs/interfaces/_api_types_.videosourceextension.md +++ b/docs/interfaces/_api_types_.videosourceextension.md @@ -21,20 +21,20 @@ Optional configuration of the image sensor. To be used if imaging service 2.00 i -### Extension +### `` Extension **● Extension**: *[VideoSourceExtension2](_api_types_.videosourceextension2.md)* -*Defined in [api/types.ts:337](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L337)* +*Defined in [api/types.ts:337](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L337)* ___ -### Imaging +### `` Imaging **● Imaging**: *[ImagingSettings20](_api_types_.imagingsettings20.md)* -*Defined in [api/types.ts:336](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L336)* +*Defined in [api/types.ts:336](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L336)* ___ diff --git a/docs/interfaces/_api_types_.whitebalance.md b/docs/interfaces/_api_types_.whitebalance.md index 317b078..d7c062d 100644 --- a/docs/interfaces/_api_types_.whitebalance.md +++ b/docs/interfaces/_api_types_.whitebalance.md @@ -26,7 +26,7 @@ Auto whitebalancing mode (auto/manual). **● CbGain**: *`number`* -*Defined in [api/types.ts:2666](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2666)* +*Defined in [api/types.ts:2666](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2666)* ___ @@ -35,7 +35,7 @@ ___ **● CrGain**: *`number`* -*Defined in [api/types.ts:2665](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2665)* +*Defined in [api/types.ts:2665](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2665)* ___ @@ -44,7 +44,7 @@ ___ **● Mode**: *[WhiteBalanceMode](../enums/_api_types_.whitebalancemode.md)* -*Defined in [api/types.ts:2664](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2664)* +*Defined in [api/types.ts:2664](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2664)* ___ diff --git a/docs/interfaces/_api_types_.whitebalance20.md b/docs/interfaces/_api_types_.whitebalance20.md index bcd92b4..0b97367 100644 --- a/docs/interfaces/_api_types_.whitebalance20.md +++ b/docs/interfaces/_api_types_.whitebalance20.md @@ -25,29 +25,29 @@ -### CbGain +### `` CbGain -**● CbGain**: *`number`* +**● CbGain**: *`undefined` \| `number`* -*Defined in [api/types.ts:3006](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3006)* +*Defined in [api/types.ts:3006](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3006)* ___ -### CrGain +### `` CrGain -**● CrGain**: *`number`* +**● CrGain**: *`undefined` \| `number`* -*Defined in [api/types.ts:3005](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3005)* +*Defined in [api/types.ts:3005](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3005)* ___ -### Extension +### `` Extension **● Extension**: *[WhiteBalance20Extension](_api_types_.whitebalance20extension.md)* -*Defined in [api/types.ts:3007](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3007)* +*Defined in [api/types.ts:3007](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3007)* ___ @@ -56,7 +56,7 @@ ___ **● Mode**: *[WhiteBalanceMode](../enums/_api_types_.whitebalancemode.md)* -*Defined in [api/types.ts:3004](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3004)* +*Defined in [api/types.ts:3004](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3004)* ___ diff --git a/docs/interfaces/_api_types_.whitebalanceoptions.md b/docs/interfaces/_api_types_.whitebalanceoptions.md index 769aac7..8638988 100644 --- a/docs/interfaces/_api_types_.whitebalanceoptions.md +++ b/docs/interfaces/_api_types_.whitebalanceoptions.md @@ -24,7 +24,7 @@ **● Mode**: *[WhiteBalanceMode](../enums/_api_types_.whitebalancemode.md)* -*Defined in [api/types.ts:2577](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2577)* +*Defined in [api/types.ts:2577](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2577)* ___ @@ -33,7 +33,7 @@ ___ **● YbGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2579](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2579)* +*Defined in [api/types.ts:2579](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2579)* ___ @@ -42,7 +42,7 @@ ___ **● YrGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2578](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2578)* +*Defined in [api/types.ts:2578](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2578)* ___ diff --git a/docs/interfaces/_api_types_.whitebalanceoptions20.md b/docs/interfaces/_api_types_.whitebalanceoptions20.md index 98a1bbe..b75364e 100644 --- a/docs/interfaces/_api_types_.whitebalanceoptions20.md +++ b/docs/interfaces/_api_types_.whitebalanceoptions20.md @@ -30,11 +30,11 @@ -### Extension +### `` Extension **● Extension**: *[WhiteBalanceOptions20Extension](_api_types_.whitebalanceoptions20extension.md)* -*Defined in [api/types.ts:3053](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3053)* +*Defined in [api/types.ts:3053](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3053)* ___ @@ -43,25 +43,25 @@ ___ **● Mode**: *[WhiteBalanceMode](../enums/_api_types_.whitebalancemode.md)* -*Defined in [api/types.ts:3050](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3050)* +*Defined in [api/types.ts:3050](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3050)* ___ -### YbGain +### `` YbGain **● YbGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:3052](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3052)* +*Defined in [api/types.ts:3052](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3052)* ___ -### YrGain +### `` YrGain **● YrGain**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:3051](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L3051)* +*Defined in [api/types.ts:3051](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L3051)* ___ diff --git a/docs/interfaces/_api_types_.widedynamicrange.md b/docs/interfaces/_api_types_.widedynamicrange.md index c3813a7..7e74fbd 100644 --- a/docs/interfaces/_api_types_.widedynamicrange.md +++ b/docs/interfaces/_api_types_.widedynamicrange.md @@ -27,7 +27,7 @@ **● Level**: *`number`* -*Defined in [api/types.ts:2503](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2503)* +*Defined in [api/types.ts:2503](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2503)* ___ @@ -36,7 +36,7 @@ ___ **● Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* -*Defined in [api/types.ts:2502](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2502)* +*Defined in [api/types.ts:2502](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2502)* ___ diff --git a/docs/interfaces/_api_types_.widedynamicrange20.md b/docs/interfaces/_api_types_.widedynamicrange20.md index 812e2e2..168b987 100644 --- a/docs/interfaces/_api_types_.widedynamicrange20.md +++ b/docs/interfaces/_api_types_.widedynamicrange20.md @@ -21,11 +21,11 @@ Type describing whether WDR mode is enabled or disabled (on/off). -### Level +### `` Level -**● Level**: *`number`* +**● Level**: *`undefined` \| `number`* -*Defined in [api/types.ts:2788](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2788)* +*Defined in [api/types.ts:2788](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2788)* ___ @@ -34,7 +34,7 @@ ___ **● Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* -*Defined in [api/types.ts:2787](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2787)* +*Defined in [api/types.ts:2787](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2787)* ___ diff --git a/docs/interfaces/_api_types_.widedynamicrangeoptions.md b/docs/interfaces/_api_types_.widedynamicrangeoptions.md index 77f7313..9aa6b7c 100644 --- a/docs/interfaces/_api_types_.widedynamicrangeoptions.md +++ b/docs/interfaces/_api_types_.widedynamicrangeoptions.md @@ -23,7 +23,7 @@ **● Level**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2535](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2535)* +*Defined in [api/types.ts:2535](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2535)* ___ @@ -32,7 +32,7 @@ ___ **● Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* -*Defined in [api/types.ts:2534](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2534)* +*Defined in [api/types.ts:2534](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2534)* ___ diff --git a/docs/interfaces/_api_types_.widedynamicrangeoptions20.md b/docs/interfaces/_api_types_.widedynamicrangeoptions20.md index 3600eb6..25033f5 100644 --- a/docs/interfaces/_api_types_.widedynamicrangeoptions20.md +++ b/docs/interfaces/_api_types_.widedynamicrangeoptions20.md @@ -19,11 +19,11 @@ -### Level +### `` Level **● Level**: *[FloatRange](_api_types_.floatrange.md)* -*Defined in [api/types.ts:2941](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2941)* +*Defined in [api/types.ts:2941](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2941)* ___ @@ -32,7 +32,7 @@ ___ **● Mode**: *[WideDynamicMode](../enums/_api_types_.widedynamicmode.md)* -*Defined in [api/types.ts:2940](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2940)* +*Defined in [api/types.ts:2940](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2940)* ___ diff --git a/docs/interfaces/_api_types_.zoomlimits.md b/docs/interfaces/_api_types_.zoomlimits.md index 5b86c79..16e1dc0 100644 --- a/docs/interfaces/_api_types_.zoomlimits.md +++ b/docs/interfaces/_api_types_.zoomlimits.md @@ -26,7 +26,7 @@ **● Range**: *[Space1DDescription](_api_types_.space1ddescription.md)* -*Defined in [api/types.ts:2224](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L2224)* +*Defined in [api/types.ts:2224](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L2224)* ___ diff --git a/docs/interfaces/_config_interfaces_.ideviceconfig.md b/docs/interfaces/_config_interfaces_.ideviceconfig.md index c0556ea..97df1bc 100644 --- a/docs/interfaces/_config_interfaces_.ideviceconfig.md +++ b/docs/interfaces/_config_interfaces_.ideviceconfig.md @@ -24,7 +24,7 @@ **● deviceUrl**: *`string`* -*Defined in [config/interfaces.ts:25](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L25)* +*Defined in [config/interfaces.ts:25](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L25)* ___ @@ -33,7 +33,7 @@ ___ **● system**: *[ISystemConfig](_config_interfaces_.isystemconfig.md)* -*Defined in [config/interfaces.ts:24](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L24)* +*Defined in [config/interfaces.ts:24](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L24)* ___ @@ -42,7 +42,7 @@ ___ **● user**: *`IMaybe`<[IUserCredentials](_config_interfaces_.iusercredentials.md)>* -*Defined in [config/interfaces.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L26)* +*Defined in [config/interfaces.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L26)* ___ diff --git a/docs/interfaces/_config_interfaces_.isystemconfig.md b/docs/interfaces/_config_interfaces_.isystemconfig.md index bac8a86..dd67e50 100644 --- a/docs/interfaces/_config_interfaces_.isystemconfig.md +++ b/docs/interfaces/_config_interfaces_.isystemconfig.md @@ -26,7 +26,7 @@ **● buffer**: *`any`* -*Defined in [config/interfaces.ts:19](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L19)* +*Defined in [config/interfaces.ts:19](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L19)* ___ @@ -35,7 +35,7 @@ ___ **● digestSha1**: *[ISha1Digest](../modules/_config_interfaces_.md#isha1digest)* -*Defined in [config/interfaces.ts:20](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L20)* +*Defined in [config/interfaces.ts:20](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L20)* ___ @@ -44,7 +44,7 @@ ___ **● nonce**: *[INonce](../modules/_config_interfaces_.md#inonce)* -*Defined in [config/interfaces.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L18)* +*Defined in [config/interfaces.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L18)* ___ @@ -53,7 +53,7 @@ ___ **● parser**: *`DOMParser`* -*Defined in [config/interfaces.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L16)* +*Defined in [config/interfaces.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L16)* ___ @@ -62,7 +62,7 @@ ___ **● transport**: *[ITransport](../modules/_config_interfaces_.md#itransport)* -*Defined in [config/interfaces.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L17)* +*Defined in [config/interfaces.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L17)* ___ diff --git a/docs/interfaces/_config_interfaces_.itransportpayoad.md b/docs/interfaces/_config_interfaces_.itransportpayoad.md index b13b0f2..3f56ce5 100644 --- a/docs/interfaces/_config_interfaces_.itransportpayoad.md +++ b/docs/interfaces/_config_interfaces_.itransportpayoad.md @@ -24,7 +24,7 @@ **● body**: *`string`* -*Defined in [config/interfaces.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L5)* +*Defined in [config/interfaces.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L5)* ___ @@ -33,7 +33,7 @@ ___ **● status**: *`number`* -*Defined in [config/interfaces.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L7)* +*Defined in [config/interfaces.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L7)* ___ @@ -42,7 +42,7 @@ ___ **● statusMessage**: *`string`* -*Defined in [config/interfaces.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L6)* +*Defined in [config/interfaces.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L6)* ___ diff --git a/docs/interfaces/_config_interfaces_.iusercredentials.md b/docs/interfaces/_config_interfaces_.iusercredentials.md index 0572215..6c4ff9d 100644 --- a/docs/interfaces/_config_interfaces_.iusercredentials.md +++ b/docs/interfaces/_config_interfaces_.iusercredentials.md @@ -23,7 +23,7 @@ **● password**: *`string`* -*Defined in [config/interfaces.ts:31](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L31)* +*Defined in [config/interfaces.ts:31](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L31)* ___ @@ -32,7 +32,7 @@ ___ **● username**: *`string`* -*Defined in [config/interfaces.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L30)* +*Defined in [config/interfaces.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L30)* ___ diff --git a/docs/interfaces/_manage_device_.ideviceinitconfig.md b/docs/interfaces/_manage_device_.ideviceinitconfig.md index 55fd11b..d22af67 100644 --- a/docs/interfaces/_manage_device_.ideviceinitconfig.md +++ b/docs/interfaces/_manage_device_.ideviceinitconfig.md @@ -24,7 +24,7 @@ **● deviceUrl**: *`string`* -*Defined in [manage/device.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/manage/device.ts#L13)* +*Defined in [manage/device.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/manage/device.ts#L13)* ___ @@ -33,7 +33,7 @@ ___ **● password**: *`undefined` \| `string`* -*Defined in [manage/device.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/manage/device.ts#L15)* +*Defined in [manage/device.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/manage/device.ts#L15)* ___ @@ -42,7 +42,7 @@ ___ **● username**: *`undefined` \| `string`* -*Defined in [manage/device.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/manage/device.ts#L14)* +*Defined in [manage/device.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/manage/device.ts#L14)* ___ diff --git a/docs/interfaces/_manage_device_.imanageddevice.md b/docs/interfaces/_manage_device_.imanageddevice.md index e966d9f..765ebf8 100644 --- a/docs/interfaces/_manage_device_.imanageddevice.md +++ b/docs/interfaces/_manage_device_.imanageddevice.md @@ -22,7 +22,7 @@ **● api**: *[ManagedONVIFApi](../classes/_api_index_.managedonvifapi.md)* -*Defined in [manage/device.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/manage/device.ts#L9)* +*Defined in [manage/device.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/manage/device.ts#L9)* ONVIF standard API diff --git a/docs/interfaces/_soap_auth_.idigestbag.md b/docs/interfaces/_soap_auth_.idigestbag.md index 5c01f05..2846317 100644 --- a/docs/interfaces/_soap_auth_.idigestbag.md +++ b/docs/interfaces/_soap_auth_.idigestbag.md @@ -25,7 +25,7 @@ **● dateIsoString**: *`string`* -*Defined in [soap/auth.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L5)* +*Defined in [soap/auth.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L5)* ___ @@ -34,7 +34,7 @@ ___ **● digest64**: *`string`* -*Defined in [soap/auth.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L7)* +*Defined in [soap/auth.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L7)* ___ @@ -43,7 +43,7 @@ ___ **● nonceBase64**: *`string`* -*Defined in [soap/auth.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L6)* +*Defined in [soap/auth.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L6)* ___ @@ -52,7 +52,7 @@ ___ **● username**: *`string`* -*Defined in [soap/auth.ts:8](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L8)* +*Defined in [soap/auth.ts:8](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L8)* ___ diff --git a/docs/interfaces/_soap_auth_.iusercredentials.md b/docs/interfaces/_soap_auth_.iusercredentials.md index 1e9b1c2..2b0dcab 100644 --- a/docs/interfaces/_soap_auth_.iusercredentials.md +++ b/docs/interfaces/_soap_auth_.iusercredentials.md @@ -23,7 +23,7 @@ **● password**: *`string`* -*Defined in [soap/auth.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L13)* +*Defined in [soap/auth.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L13)* ___ @@ -32,7 +32,7 @@ ___ **● username**: *`string`* -*Defined in [soap/auth.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L12)* +*Defined in [soap/auth.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L12)* ___ diff --git a/docs/interfaces/_soap_request_.iresultstructure.md b/docs/interfaces/_soap_request_.iresultstructure.md new file mode 100644 index 0000000..6d83fc9 --- /dev/null +++ b/docs/interfaces/_soap_request_.iresultstructure.md @@ -0,0 +1,40 @@ +[onvif-rx](../README.md) > ["soap/request"](../modules/_soap_request_.md) > [IResultStructure](../interfaces/_soap_request_.iresultstructure.md) + +# Interface: IResultStructure + +## Type parameters +#### T +## Hierarchy + +**IResultStructure** + +## Index + +### Properties + +* [json](_soap_request_.iresultstructure.md#json) +* [xml](_soap_request_.iresultstructure.md#xml) + +--- + +## Properties + + + +### json + +**● json**: *`T`* + +*Defined in [soap/request.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L9)* + +___ + + +### xml + +**● xml**: *`string`* + +*Defined in [soap/request.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L10)* + +___ + diff --git a/docs/interfaces/_soap_request_.itransportpayloadxml.md b/docs/interfaces/_soap_request_.itransportpayloadxml.md deleted file mode 100644 index a73340b..0000000 --- a/docs/interfaces/_soap_request_.itransportpayloadxml.md +++ /dev/null @@ -1,48 +0,0 @@ -[onvif-rx](../README.md) > ["soap/request"](../modules/_soap_request_.md) > [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md) - -# Interface: ITransportPayloadXml - -## Hierarchy - -**ITransportPayloadXml** - -## Index - -### Properties - -* [body](_soap_request_.itransportpayloadxml.md#body) -* [status](_soap_request_.itransportpayloadxml.md#status) -* [statusMessage](_soap_request_.itransportpayloadxml.md#statusmessage) - ---- - -## Properties - - - -### body - -**● body**: *`Document`* - -*Defined in [soap/request.ts:45](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L45)* - -___ - - -### status - -**● status**: *`number`* - -*Defined in [soap/request.ts:47](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L47)* - -___ - - -### statusMessage - -**● statusMessage**: *`string`* - -*Defined in [soap/request.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L46)* - -___ - diff --git a/docs/interfaces/_soap_request_.ixmlcontainer.md b/docs/interfaces/_soap_request_.ixmlcontainer.md new file mode 100644 index 0000000..ad90c99 --- /dev/null +++ b/docs/interfaces/_soap_request_.ixmlcontainer.md @@ -0,0 +1,38 @@ +[onvif-rx](../README.md) > ["soap/request"](../modules/_soap_request_.md) > [IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md) + +# Interface: IXmlContainer + +## Hierarchy + +**IXmlContainer** + +## Index + +### Properties + +* [xmlDocument](_soap_request_.ixmlcontainer.md#xmldocument) +* [xmlString](_soap_request_.ixmlcontainer.md#xmlstring) + +--- + +## Properties + + + +### xmlDocument + +**● xmlDocument**: *`Document`* + +*Defined in [soap/request.ts:107](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L107)* + +___ + + +### xmlString + +**● xmlString**: *`string`* + +*Defined in [soap/request.ts:106](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L106)* + +___ + diff --git a/docs/modules/_api_types_.md b/docs/modules/_api_types_.md index c52c66c..849e7d7 100644 --- a/docs/modules/_api_types_.md +++ b/docs/modules/_api_types_.md @@ -583,7 +583,7 @@ **Ƭ AudioClassType**: *`string`* -*Defined in [api/types.ts:113](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L113)* +*Defined in [api/types.ts:113](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L113)* ``` AudioClassType acceptable values are; @@ -597,7 +597,7 @@ ___ **Ƭ AuxiliaryData**: *`string`* -*Defined in [api/types.ts:66](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L66)* +*Defined in [api/types.ts:66](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L66)* ___ @@ -606,7 +606,7 @@ ___ **Ƭ DNSName**: *`string`* -*Defined in [api/types.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L46)* +*Defined in [api/types.ts:46](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L46)* ___ @@ -615,7 +615,7 @@ ___ **Ƭ Description**: *`string`* -*Defined in [api/types.ts:86](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L86)* +*Defined in [api/types.ts:86](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L86)* ___ @@ -624,7 +624,7 @@ ___ **Ƭ Domain**: *`string`* -*Defined in [api/types.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L50)* +*Defined in [api/types.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L50)* ___ @@ -633,7 +633,7 @@ ___ **Ƭ Dot11PSK**: *`string`* -*Defined in [api/types.ts:58](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L58)* +*Defined in [api/types.ts:58](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L58)* ___ @@ -642,7 +642,7 @@ ___ **Ƭ Dot11PSKPassphrase**: *`string`* -*Defined in [api/types.ts:62](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L62)* +*Defined in [api/types.ts:62](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L62)* ___ @@ -651,7 +651,7 @@ ___ **Ƭ Dot11SSIDType**: *`string`* -*Defined in [api/types.ts:54](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L54)* +*Defined in [api/types.ts:54](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L54)* ___ @@ -660,7 +660,7 @@ ___ **Ƭ FloatAttrList**: *`ReadonlyArray`<`number`>* -*Defined in [api/types.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L18)* +*Defined in [api/types.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L18)* ___ @@ -669,7 +669,7 @@ ___ **Ƭ HwAddress**: *`string`* -*Defined in [api/types.ts:42](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L42)* +*Defined in [api/types.ts:42](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L42)* ___ @@ -678,7 +678,7 @@ ___ **Ƭ IPv4Address**: *`string`* -*Defined in [api/types.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L34)* +*Defined in [api/types.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L34)* ___ @@ -687,7 +687,7 @@ ___ **Ƭ IPv6Address**: *`string`* -*Defined in [api/types.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L38)* +*Defined in [api/types.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L38)* ___ @@ -696,7 +696,7 @@ ___ **Ƭ IntAttrList**: *`ReadonlyArray`<`number`>* -*Defined in [api/types.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L14)* +*Defined in [api/types.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L14)* ___ @@ -705,7 +705,7 @@ ___ **Ƭ JobToken**: *[ReferenceToken](_api_types_.md#referencetoken)* -*Defined in [api/types.ts:94](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L94)* +*Defined in [api/types.ts:94](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L94)* ___ @@ -714,7 +714,7 @@ ___ **Ƭ Name**: *`string`* -*Defined in [api/types.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L10)* +*Defined in [api/types.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L10)* User readable name. Length up to 64 characters. @@ -725,7 +725,7 @@ ___ **Ƭ NetworkInterfaceConfigPriority**: *`number`* -*Defined in [api/types.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L30)* +*Defined in [api/types.ts:30](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L30)* ___ @@ -734,7 +734,7 @@ ___ **Ƭ ReceiverReference**: *[ReferenceToken](_api_types_.md#referencetoken)* -*Defined in [api/types.ts:74](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L74)* +*Defined in [api/types.ts:74](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L74)* ___ @@ -743,7 +743,7 @@ ___ **Ƭ RecordingJobMode**: *`string`* -*Defined in [api/types.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L102)* +*Defined in [api/types.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L102)* ___ @@ -752,7 +752,7 @@ ___ **Ƭ RecordingJobReference**: *[ReferenceToken](_api_types_.md#referencetoken)* -*Defined in [api/types.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L98)* +*Defined in [api/types.ts:98](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L98)* ___ @@ -761,7 +761,7 @@ ___ **Ƭ RecordingJobState**: *`string`* -*Defined in [api/types.ts:106](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L106)* +*Defined in [api/types.ts:106](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L106)* ___ @@ -770,7 +770,7 @@ ___ **Ƭ RecordingReference**: *[ReferenceToken](_api_types_.md#referencetoken)* -*Defined in [api/types.ts:78](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L78)* +*Defined in [api/types.ts:78](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L78)* ___ @@ -779,7 +779,7 @@ ___ **Ƭ ReferenceToken**: *`string`* -*Defined in [api/types.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L6)* +*Defined in [api/types.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L6)* Unique identifier for a physical or logical resource. Tokens should be assigned such that they are unique within a device. Tokens must be at least unique within its class. Length up to 64 characters. @@ -790,7 +790,7 @@ ___ **Ƭ ReferenceTokenList**: *`ReadonlyArray`<[ReferenceToken](_api_types_.md#referencetoken)>* -*Defined in [api/types.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L26)* +*Defined in [api/types.ts:26](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L26)* ___ @@ -799,7 +799,7 @@ ___ **Ƭ StringAttrList**: *`ReadonlyArray`<`string`>* -*Defined in [api/types.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L22)* +*Defined in [api/types.ts:22](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L22)* ___ @@ -808,7 +808,7 @@ ___ **Ƭ TopicNamespaceLocation**: *`string`* -*Defined in [api/types.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L70)* +*Defined in [api/types.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L70)* ___ @@ -817,7 +817,7 @@ ___ **Ƭ TrackReference**: *[ReferenceToken](_api_types_.md#referencetoken)* -*Defined in [api/types.ts:82](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L82)* +*Defined in [api/types.ts:82](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L82)* ___ @@ -826,7 +826,7 @@ ___ **Ƭ XPathExpression**: *`string`* -*Defined in [api/types.ts:90](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L90)* +*Defined in [api/types.ts:90](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L90)* ___ @@ -835,7 +835,7 @@ ___ **Ƭ encodingStyle**: *`ReadonlyArray`<`string`>* -*Defined in [api/types.ts:119](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/api/types.ts#L119)* +*Defined in [api/types.ts:119](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/api/types.ts#L119)* ``` 'encodingStyle' indicates any canonicalization conventions followed in the contents of the containing element. For example, the value 'http://schemas.xmlsoap.org/soap/encoding/' indicates the pattern described in SOAP specification diff --git a/docs/modules/_browser_.md b/docs/modules/_browser_.md index 12bd051..d1816f1 100644 --- a/docs/modules/_browser_.md +++ b/docs/modules/_browser_.md @@ -18,7 +18,7 @@ ▸ **createManagedDeviceInBrowser**(config: *[IDeviceInitConfig](../interfaces/_manage_device_.ideviceinitconfig.md)*): [IManagedDevice](../interfaces/_manage_device_.imanageddevice.md) -*Defined in [browser.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/browser.ts#L7)* +*Defined in [browser.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/browser.ts#L7)* **Parameters:** diff --git a/docs/modules/_config_browser_.md b/docs/modules/_config_browser_.md index 44239ba..2b60b8a 100644 --- a/docs/modules/_config_browser_.md +++ b/docs/modules/_config_browser_.md @@ -22,7 +22,7 @@ ▸ **transport**(body: *`string`*): `(Anonymous function)` -*Defined in [config/browser.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L5)* +*Defined in [config/browser.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L5)* **Parameters:** @@ -42,7 +42,7 @@ ___ **DEFAULT_BROWSER_ENV**: *`object`* -*Defined in [config/browser.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L10)* +*Defined in [config/browser.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L10)* @@ -50,7 +50,7 @@ ___ **● buffer**: *`object`* = Buffer -*Defined in [config/browser.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L15)* +*Defined in [config/browser.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L15)* #### Type declaration @@ -371,7 +371,7 @@ ___ **● digestSha1**: *`function`* -*Defined in [config/browser.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L13)* +*Defined in [config/browser.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L13)* #### Type declaration ▸(str: *`string`*): `string` @@ -391,7 +391,7 @@ ___ **● nonce**: *`function`* -*Defined in [config/browser.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L12)* +*Defined in [config/browser.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L12)* #### Type declaration ▸(size?: *`undefined` \| `number`*): `string` @@ -411,7 +411,7 @@ ___ **● parser**: *`DOMParser`* = typeof DOMParser !== 'undefined' ? new DOMParser() : {} as DOMParser -*Defined in [config/browser.ts:11](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L11)* +*Defined in [config/browser.ts:11](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L11)* ___ @@ -420,7 +420,7 @@ ___ **● transport**: *[transport]()* -*Defined in [config/browser.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/browser.ts#L14)* +*Defined in [config/browser.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/browser.ts#L14)* ___ diff --git a/docs/modules/_config_interfaces_.md b/docs/modules/_config_interfaces_.md index 72f7495..d51f1a2 100644 --- a/docs/modules/_config_interfaces_.md +++ b/docs/modules/_config_interfaces_.md @@ -28,7 +28,7 @@ **Ƭ IEncodeBase64**: *`function`* -*Defined in [config/interfaces.ts:11](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L11)* +*Defined in [config/interfaces.ts:11](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L11)* #### Type declaration ▸(str: *`string`*): `string` @@ -48,7 +48,7 @@ ___ **Ƭ INonce**: *`function`* -*Defined in [config/interfaces.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L13)* +*Defined in [config/interfaces.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L13)* #### Type declaration ▸(size?: *`undefined` \| `number`*): `string` @@ -68,7 +68,7 @@ ___ **Ƭ ISha1Digest**: *`function`* -*Defined in [config/interfaces.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L12)* +*Defined in [config/interfaces.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L12)* #### Type declaration ▸(str: *`string`*): `string` @@ -88,7 +88,7 @@ ___ **Ƭ ITransport**: *`function`* -*Defined in [config/interfaces.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/interfaces.ts#L9)* +*Defined in [config/interfaces.ts:9](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/interfaces.ts#L9)* #### Type declaration ▸(body: *`string`*): `function` diff --git a/docs/modules/_config_node_.md b/docs/modules/_config_node_.md index c243062..fdfb037 100644 --- a/docs/modules/_config_node_.md +++ b/docs/modules/_config_node_.md @@ -26,7 +26,7 @@ **● parser**: *`DOMParser`* = new DOMParser() -*Defined in [config/node.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L6)* +*Defined in [config/node.ts:6](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L6)* ___ @@ -38,7 +38,7 @@ ___ ▸ **transport**(body: *`string`*): `(Anonymous function)` -*Defined in [config/node.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L7)* +*Defined in [config/node.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L7)* **Parameters:** @@ -58,7 +58,7 @@ ___ **DEFAULT_NODE_ENV**: *`object`* -*Defined in [config/node.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L12)* +*Defined in [config/node.ts:12](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L12)* @@ -66,7 +66,7 @@ ___ **● buffer**: *`object`* = Buffer -*Defined in [config/node.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L17)* +*Defined in [config/node.ts:17](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L17)* #### Type declaration @@ -387,7 +387,7 @@ ___ **● digestSha1**: *`function`* -*Defined in [config/node.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L16)* +*Defined in [config/node.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L16)* #### Type declaration ▸(str: *`string`*): `string` @@ -407,7 +407,7 @@ ___ **● nonce**: *`function`* -*Defined in [config/node.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L15)* +*Defined in [config/node.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L15)* #### Type declaration ▸(size?: *`undefined` \| `number`*): `string` @@ -427,7 +427,7 @@ ___ **● parser**: *`DOMParser`* -*Defined in [config/node.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L13)* +*Defined in [config/node.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L13)* ___ @@ -436,7 +436,7 @@ ___ **● transport**: *[transport]()* -*Defined in [config/node.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/node.ts#L14)* +*Defined in [config/node.ts:14](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/node.ts#L14)* ___ diff --git a/docs/modules/_config_universal_.md b/docs/modules/_config_universal_.md index 2ded676..e465952 100644 --- a/docs/modules/_config_universal_.md +++ b/docs/modules/_config_universal_.md @@ -28,7 +28,7 @@ **● digestSha1**: *[ISha1Digest](_config_interfaces_.md#isha1digest)* = require('js-sha1').digest -*Defined in [config/universal.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/universal.ts#L5)* +*Defined in [config/universal.ts:5](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/universal.ts#L5)* ___ @@ -40,7 +40,7 @@ ___ ▸ **FETCH_CONFIG**(body: *`string`*): `object` -*Defined in [config/universal.ts:8](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/universal.ts#L8)* +*Defined in [config/universal.ts:8](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/universal.ts#L8)* **Parameters:** @@ -57,7 +57,7 @@ ___ ▸ **nonce**(size?: *`undefined` \| `number`*): `string` -*Defined in [config/universal.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/universal.ts#L21)* +*Defined in [config/universal.ts:21](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/universal.ts#L21)* **Parameters:** @@ -74,7 +74,7 @@ ___ ▸ **sharedFetchWrapper**(fetchResponse: *`Promise`<`any`>*): `Observable`<[ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)> -*Defined in [config/universal.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/universal.ts#L10)* +*Defined in [config/universal.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/universal.ts#L10)* **Parameters:** @@ -94,7 +94,7 @@ ___ **REQUEST_HEADERS**: *`object`* -*Defined in [config/universal.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/universal.ts#L7)* +*Defined in [config/universal.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/universal.ts#L7)* @@ -102,7 +102,7 @@ ___ **● Content-Type**: *`string`* = "application/soap+xml; charset=utf-8;" -*Defined in [config/universal.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/config/universal.ts#L7)* +*Defined in [config/universal.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/config/universal.ts#L7)* ___ diff --git a/docs/modules/_manage_device_.md b/docs/modules/_manage_device_.md index ca3defb..9298b7e 100644 --- a/docs/modules/_manage_device_.md +++ b/docs/modules/_manage_device_.md @@ -23,7 +23,7 @@ ▸ **createManagedDevice**(config: *[IDeviceInitConfig](../interfaces/_manage_device_.ideviceinitconfig.md)*): `IReader`<[ISystemConfig](../interfaces/_config_interfaces_.isystemconfig.md), [IManagedDevice](../interfaces/_manage_device_.imanageddevice.md)> -*Defined in [manage/device.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/manage/device.ts#L18)* +*Defined in [manage/device.ts:18](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/manage/device.ts#L18)* **Parameters:** diff --git a/docs/modules/_node_.md b/docs/modules/_node_.md index 25010d8..dc612a3 100644 --- a/docs/modules/_node_.md +++ b/docs/modules/_node_.md @@ -4,12 +4,32 @@ ## Index +### Variables + +* [device](_node_.md#device) + ### Functions * [createManagedDeviceInNode](_node_.md#createmanageddeviceinnode) --- +## Variables + + + +### `` device + +**● device**: *[IManagedDevice](../interfaces/_manage_device_.imanageddevice.md)* = createManagedDeviceInNode({ + deviceUrl: 'http://192.168.1.172/onvif/device_service', + password: 'admin', + username: 'admin' +}) + +*Defined in [node.ts:15](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/node.ts#L15)* + +___ + ## Functions @@ -18,7 +38,7 @@ ▸ **createManagedDeviceInNode**(config: *[IDeviceInitConfig](../interfaces/_manage_device_.ideviceinitconfig.md)*): [IManagedDevice](../interfaces/_manage_device_.imanageddevice.md) -*Defined in [node.ts:7](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/node.ts#L7)* +*Defined in [node.ts:10](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/node.ts#L10)* **Parameters:** diff --git a/docs/modules/_soap_auth_.md b/docs/modules/_soap_auth_.md index 5700c29..95f5805 100644 --- a/docs/modules/_soap_auth_.md +++ b/docs/modules/_soap_auth_.md @@ -28,7 +28,7 @@ ▸ **createUserToken**(timeDifference?: *`number`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `IMaybe`<`string`>> -*Defined in [soap/auth.ts:42](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L42)* +*Defined in [soap/auth.ts:42](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L42)* **Parameters:** @@ -45,7 +45,7 @@ ___ ▸ **onvifDigest**(dateIsoString: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `IMaybe`<[IDigestBag](../interfaces/_soap_auth_.idigestbag.md)>> -*Defined in [soap/auth.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L16)* +*Defined in [soap/auth.ts:16](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L16)* **Parameters:** @@ -65,7 +65,7 @@ ___ **TOKENS**: *`object`* -*Defined in [soap/auth.ts:33](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L33)* +*Defined in [soap/auth.ts:33](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L33)* @@ -73,7 +73,7 @@ ___ **● cr**: *`string`* = "wsu:Created" -*Defined in [soap/auth.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L39)* +*Defined in [soap/auth.ts:39](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L39)* ___ @@ -82,7 +82,7 @@ ___ **● nc**: *`string`* = "wsse:Nonce" -*Defined in [soap/auth.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L38)* +*Defined in [soap/auth.ts:38](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L38)* ___ @@ -91,7 +91,7 @@ ___ **● pw**: *`string`* = "wsse:Password" -*Defined in [soap/auth.ts:37](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L37)* +*Defined in [soap/auth.ts:37](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L37)* ___ @@ -100,7 +100,7 @@ ___ **● s**: *`string`* = "wsse:Security" -*Defined in [soap/auth.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L34)* +*Defined in [soap/auth.ts:34](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L34)* ___ @@ -109,7 +109,7 @@ ___ **● un**: *`string`* = "wsse:Username" -*Defined in [soap/auth.ts:36](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L36)* +*Defined in [soap/auth.ts:36](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L36)* ___ @@ -118,7 +118,7 @@ ___ **● unt**: *`string`* = "wsse:UsernameToken" -*Defined in [soap/auth.ts:35](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/auth.ts#L35)* +*Defined in [soap/auth.ts:35](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/auth.ts#L35)* ___ diff --git a/docs/modules/_soap_request_.md b/docs/modules/_soap_request_.md index 59236a5..b6ebf8f 100644 --- a/docs/modules/_soap_request_.md +++ b/docs/modules/_soap_request_.md @@ -11,11 +11,11 @@ ### Interfaces -* [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md) +* [IResultStructure](../interfaces/_soap_request_.iresultstructure.md) +* [IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md) ### Type aliases -* [IOnvifNetworkResponse](_soap_request_.md#ionvifnetworkresponse) * [IOnvifResult](_soap_request_.md#ionvifresult) ### Functions @@ -36,22 +36,13 @@ ## Type aliases - - -### IOnvifNetworkResponse - -**Ƭ IOnvifNetworkResponse**: *`Observable`<`IResult`<`T`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>* - -*Defined in [soap/request.ts:50](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L50)* - -___ ### IOnvifResult -**Ƭ IOnvifResult**: *`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>* +**Ƭ IOnvifResult**: *`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>* -*Defined in [soap/request.ts:107](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L107)* +*Defined in [soap/request.ts:13](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L13)* ___ @@ -61,9 +52,9 @@ ___ ### `` createDeviceRequestBodyFromString -▸ **createDeviceRequestBodyFromString**(key: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **createDeviceRequestBodyFromString**(key: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [soap/request.ts:142](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L142)* +*Defined in [soap/request.ts:159](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L159)* **Parameters:** @@ -71,16 +62,16 @@ ___ | ------ | ------ | | key | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` createMediaRequestBodyFromString -▸ **createMediaRequestBodyFromString**(key: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **createMediaRequestBodyFromString**(key: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [soap/request.ts:146](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L146)* +*Defined in [soap/request.ts:163](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L163)* **Parameters:** @@ -88,16 +79,16 @@ ___ | ------ | ------ | | key | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` createSimpleRequestBodyFromString -▸ **createSimpleRequestBodyFromString**(key: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **createSimpleRequestBodyFromString**(key: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [soap/request.ts:138](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L138)* +*Defined in [soap/request.ts:155](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L155)* **Parameters:** @@ -105,16 +96,16 @@ ___ | ------ | ------ | | key | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` createStandardRequestBody -▸ **createStandardRequestBody**(body: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **createStandardRequestBody**(body: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [soap/request.ts:109](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L109)* +*Defined in [soap/request.ts:126](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L126)* **Parameters:** @@ -122,16 +113,16 @@ ___ | ------ | ------ | | body | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ ### `` createStandardRequestBodyFromString -▸ **createStandardRequestBodyFromString**(body: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +▸ **createStandardRequestBodyFromString**(body: *`string`*): `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> -*Defined in [soap/request.ts:134](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L134)* +*Defined in [soap/request.ts:151](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L151)* **Parameters:** @@ -139,7 +130,7 @@ ___ | ------ | ------ | | body | `string` | -**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<`Document`, [ITransportPayloadXml](../interfaces/_soap_request_.itransportpayloadxml.md)>>> +**Returns:** `IReader`<[IDeviceConfig](../interfaces/_config_interfaces_.ideviceconfig.md), `Observable`<`IResult`<[IXmlContainer](../interfaces/_soap_request_.ixmlcontainer.md), [ITransportPayoad](../interfaces/_config_interfaces_.itransportpayoad.md)>>> ___ @@ -148,7 +139,7 @@ ___ ▸ **generateRequestElements**(reqNode: *`string`*): `(Anonymous function)` -*Defined in [soap/request.ts:151](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L151)* +*Defined in [soap/request.ts:110](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L110)* **Parameters:** @@ -165,7 +156,7 @@ ___ ▸ **mapResponseObsToProperty**<`A`,`B`,`E`>(propSelectFn: *`function`*): `(Anonymous function)` -*Defined in [soap/request.ts:102](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L102)* +*Defined in [soap/request.ts:100](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L100)* **Type parameters:** @@ -187,7 +178,7 @@ ___ ▸ **mapResponseXmlToJson**<`T`>(node: *`string`*): `(Anonymous function)` -*Defined in [soap/request.ts:79](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L79)* +*Defined in [soap/request.ts:73](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L73)* **Type parameters:** @@ -207,7 +198,7 @@ ___ ▸ **nsstr**(): `string`[] -*Defined in [soap/request.ts:68](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L68)* +*Defined in [soap/request.ts:56](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L56)* **Returns:** `string`[] @@ -218,7 +209,7 @@ ___ ▸ **parseXml**(parser: *`DOMParser`*): `(Anonymous function)` -*Defined in [soap/request.ts:52](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L52)* +*Defined in [soap/request.ts:51](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L51)* **Parameters:** @@ -235,7 +226,7 @@ ___ ▸ **soapShell**(rawBody: *`string`*): `(Anonymous function)` -*Defined in [soap/request.ts:70](https://github.com/patrickmichalina/onvif-rx/blob/d62cee9/src/soap/request.ts#L70)* +*Defined in [soap/request.ts:64](https://github.com/patrickmichalina/onvif-rx/blob/034e4d6/src/soap/request.ts#L64)* **Parameters:** diff --git a/scripts/api/ast.ts b/scripts/api/ast.ts index 8ddf4e5..ef19444 100644 --- a/scripts/api/ast.ts +++ b/scripts/api/ast.ts @@ -40,8 +40,9 @@ generateTypes() properties: m.properties.map((a: any) => { return { isReadonly: true, + hasQuestionToken: a.minOccurs, name: `'${a.name}'` as string, - type: a.type as string + type: a.type as string, } }) } @@ -112,11 +113,13 @@ generateTypes() parameters: [{ name: 'config', type: 'IDeviceConfig', scope: Scope.Private }] }], methods: [...group.actions.map(action => { + const ps = action.input.parameters.map(a => a.name).join(',') + return { isStatic: true, docs: [{ description: action.documentation.replace(/\*/g, '') }], name: action.actionName, - bodyText: `return createStandardRequestBodyFromString(generateRequestElements('${action.soapRequestNode}')([${action.input.parameters.map(a => `'${a.name}'`).join(',')}])(${action.input.parameters.map(a => a.name).join(',')})) + bodyText: `return createStandardRequestBodyFromString(generateRequestElements('${action.soapRequestNode}')({${ps}})) .map(mapResponseXmlToJson('${action.output.ref}')) `, parameters: action.input.parameters diff --git a/scripts/api/gen-api.ts b/scripts/api/gen-api.ts deleted file mode 100644 index 1718fa0..0000000 --- a/scripts/api/gen-api.ts +++ /dev/null @@ -1,104 +0,0 @@ -// import { DOMParser } from 'xmldom' -// import { maybe, result } from 'typescript-monads' -// import { writeFile, ensureDir, ensureDirSync, writeFileSync } from 'fs-extra' -// import { resolve } from 'path' -// import fetch from 'node-fetch' - -// const funcBody = (name: string, reqNode: string, outputXmlNode: string, docs: string) => { -// return `import { createStandardRequestBodyFromString, mapResponseXmlToJson, mapResponseObsToProperty } from '../../soap/request' - -// /** -// * ${docs} -// */ -// export const ${name} = -// () => -// createStandardRequestBodyFromString('<${reqNode} />') -// .map(mapResponseXmlToJson('${outputXmlNode}')()) -// ` -// } - -// const genIndexApi = (name: string) => (exp: string) => (imports: string) => (funcs: string) => (iface: string) => { -// return `${exp} - -// ${imports} -// import { IDeviceConfig } from '../../config' -// import { IOnvifNetworkResponse } from '../../soap/request' - -// export interface IONVIF${name}Api { -// ${iface} -// } - -// export const ONVIF_${name}_API = (config: IDeviceConfig): IONVIF${name}Api => { -// return { -// ${funcs} -// } -// }` -// } - -// const genApiMain = (objs: string) => (iface: string) => (imports: string) => { -// return `import { IDeviceConfig } from '../config' -// ${imports} - -// export interface IONVIFApi { -// ${iface} -// } - -// export const ONVIF_API = (config: IDeviceConfig): IONVIFApi => { -// return { -// ${objs} -// } -// }` -// } - -// enum WSDL { -// Device = 'https://www.onvif.org/ver10/device/wsdl/devicemgmt.wsdl', -// Media = 'https://www.onvif.org/ver10/media/wsdl/media.wsdl', -// PTZ = 'https://www.onvif.org/ver20/ptz/wsdl/ptz.wsdl' -// } - -// const gen = (wsdl: WSDL | string) => { -// return fetch(wsdl) -// .then(res => res.text()) -// .then(xml => { - -// }) -// } - -// const promises = Object.keys(WSDL) -// .map((a: any) => WSDL[a]) -// .map(gen) - -// Promise -// .all(promises) -// .then(results => { -// const operateMe = results.map(b => b.valueOrUndefined()).filter(Boolean) -// operateMe.forEach(a => a && ensureDirSync(a.baseDir)) - - -// const formain = operateMe.reduce((acc, curr: any) => { -// return { -// ...acc, -// apis: [ -// ...acc.apis, -// `IONVIF${curr.name}Api` -// ] -// } -// }, { apis: [] } as any) - - -// const interfaces = operateMe.map((a: any) => `readonly ${a.type}: IONVIF${a.name}Api`).join('\n ') -// const imports = operateMe.map((a: any) => `import { IONVIF${a.name}Api, ONVIF_${a.name}_API } from './${a.type}'`).join('\n') -// const objs = operateMe.map((a: any) => `${a.type}: ONVIF_${a.name}_API(config),`).join('\n ') - -// writeFileSync(resolve('src/api/index.ts'), genApiMain(objs)(interfaces)(imports)) - -// const writeOperations = operateMe.reduce((acc, curr: any) => { -// return [ -// ...acc, -// ...curr.outputFiles.map((f: any) => () => writeFile(f.path, f.body)), -// () => writeFile(curr.indexFile.path, curr.indexFile.body) -// ] -// }, [] as ReadonlyArray) - -// Promise.all(writeOperations.map(b => b())) -// }) diff --git a/scripts/api/parse-onvif-xsd.ts b/scripts/api/parse-onvif-xsd.ts index 282d6f0..2d60576 100644 --- a/scripts/api/parse-onvif-xsd.ts +++ b/scripts/api/parse-onvif-xsd.ts @@ -86,7 +86,6 @@ export const parseOnvifXsdForTypeInfo = (xmlDoc: Document): ParsedXsd => { } }) - const complexTypes = Array.from(xmlDoc.getElementsByTagNameNS(NS, 'complexType')) .filter(complexType => complexType.getAttribute('name')) .map(complexType => { @@ -98,7 +97,7 @@ export const parseOnvifXsdForTypeInfo = (xmlDoc: Document): ParsedXsd => { const type = maybe(elm.getAttribute('type')).flatMapAuto(a => a.split(':').pop()) .map(typeConvert) .valueOr('') - const minOccurs = elm.getAttribute('minOccurs') + const minOccurs = maybe(elm.getAttribute('minOccurs')).map(a => parseInt(a) === 0).valueOr(false) return { name, type, diff --git a/src/api/advancedsecurity.ts b/src/api/advancedsecurity.ts index c8e8e3c..b4cfbc5 100644 --- a/src/api/advancedsecurity.ts +++ b/src/api/advancedsecurity.ts @@ -10,7 +10,7 @@ export class ONVIFAdvancedSecurity { * Returns the capabilities of the security configuraiton service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tas:GetServiceCapabilitiesResponse')) } @@ -30,7 +30,7 @@ export class ONVIFAdvancedSecurity { * */ static CreateRSAKeyPair() { - return createStandardRequestBodyFromString(generateRequestElements('tas:CreateRSAKeyPair')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:CreateRSAKeyPair')({})) .map(mapResponseXmlToJson('tas:CreateRSAKeyPairResponse')) } @@ -45,7 +45,7 @@ export class ONVIFAdvancedSecurity { * */ static UploadKeyPairInPKCS8() { - return createStandardRequestBodyFromString(generateRequestElements('tas:UploadKeyPairInPKCS8')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:UploadKeyPairInPKCS8')({})) .map(mapResponseXmlToJson('tas:UploadKeyPairInPKCS8Response')) } @@ -69,7 +69,7 @@ export class ONVIFAdvancedSecurity { * */ static UploadCertificateWithPrivateKeyInPKCS12() { - return createStandardRequestBodyFromString(generateRequestElements('tas:UploadCertificateWithPrivateKeyInPKCS12')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:UploadCertificateWithPrivateKeyInPKCS12')({})) .map(mapResponseXmlToJson('tas:UploadCertificateWithPrivateKeyInPKCS12Response')) } @@ -82,7 +82,7 @@ export class ONVIFAdvancedSecurity { * */ static GetKeyStatus() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetKeyStatus')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetKeyStatus')({})) .map(mapResponseXmlToJson('tas:GetKeyStatusResponse')) } @@ -96,7 +96,7 @@ export class ONVIFAdvancedSecurity { * */ static GetPrivateKeyStatus() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetPrivateKeyStatus')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetPrivateKeyStatus')({})) .map(mapResponseXmlToJson('tas:GetPrivateKeyStatusResponse')) } @@ -109,7 +109,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllKeys() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllKeys')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllKeys')({})) .map(mapResponseXmlToJson('tas:GetAllKeysResponse')) } @@ -125,7 +125,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteKey() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteKey')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteKey')({})) .map(mapResponseXmlToJson('tas:DeleteKeyResponse')) } @@ -147,7 +147,7 @@ export class ONVIFAdvancedSecurity { * */ static CreatePKCS10CSR() { - return createStandardRequestBodyFromString(generateRequestElements('tas:CreatePKCS10CSR')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:CreatePKCS10CSR')({})) .map(mapResponseXmlToJson('tas:CreatePKCS10CSRResponse')) } @@ -172,7 +172,7 @@ export class ONVIFAdvancedSecurity { * */ static CreateSelfSignedCertificate() { - return createStandardRequestBodyFromString(generateRequestElements('tas:CreateSelfSignedCertificate')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:CreateSelfSignedCertificate')({})) .map(mapResponseXmlToJson('tas:CreateSelfSignedCertificateResponse')) } @@ -211,7 +211,7 @@ export class ONVIFAdvancedSecurity { * */ static UploadCertificate() { - return createStandardRequestBodyFromString(generateRequestElements('tas:UploadCertificate')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:UploadCertificate')({})) .map(mapResponseXmlToJson('tas:UploadCertificateResponse')) } @@ -224,7 +224,7 @@ export class ONVIFAdvancedSecurity { * */ static GetCertificate() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetCertificate')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetCertificate')({})) .map(mapResponseXmlToJson('tas:GetCertificateResponse')) } @@ -237,7 +237,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllCertificates() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCertificates')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCertificates')({})) .map(mapResponseXmlToJson('tas:GetAllCertificatesResponse')) } @@ -253,7 +253,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteCertificate() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCertificate')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCertificate')({})) .map(mapResponseXmlToJson('tas:DeleteCertificateResponse')) } @@ -272,7 +272,7 @@ export class ONVIFAdvancedSecurity { * */ static CreateCertificationPath() { - return createStandardRequestBodyFromString(generateRequestElements('tas:CreateCertificationPath')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:CreateCertificationPath')({})) .map(mapResponseXmlToJson('tas:CreateCertificationPathResponse')) } @@ -285,7 +285,7 @@ export class ONVIFAdvancedSecurity { * */ static GetCertificationPath() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetCertificationPath')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetCertificationPath')({})) .map(mapResponseXmlToJson('tas:GetCertificationPathResponse')) } @@ -298,7 +298,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllCertificationPaths() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCertificationPaths')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCertificationPaths')({})) .map(mapResponseXmlToJson('tas:GetAllCertificationPathsResponse')) } @@ -316,7 +316,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteCertificationPath() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCertificationPath')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCertificationPath')({})) .map(mapResponseXmlToJson('tas:DeleteCertificationPathResponse')) } @@ -327,7 +327,7 @@ export class ONVIFAdvancedSecurity { * */ static UploadPassphrase() { - return createStandardRequestBodyFromString(generateRequestElements('tas:UploadPassphrase')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:UploadPassphrase')({})) .map(mapResponseXmlToJson('tas:UploadPassphraseResponse')) } @@ -340,7 +340,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllPassphrases() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllPassphrases')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllPassphrases')({})) .map(mapResponseXmlToJson('tas:GetAllPassphrasesResponse')) } @@ -351,7 +351,7 @@ export class ONVIFAdvancedSecurity { * */ static DeletePassphrase() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeletePassphrase')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeletePassphrase')({})) .map(mapResponseXmlToJson('tas:DeletePassphraseResponse')) } @@ -365,7 +365,7 @@ export class ONVIFAdvancedSecurity { * */ static UploadCRL() { - return createStandardRequestBodyFromString(generateRequestElements('tas:UploadCRL')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:UploadCRL')({})) .map(mapResponseXmlToJson('tas:UploadCRLResponse')) } @@ -377,7 +377,7 @@ export class ONVIFAdvancedSecurity { * */ static GetCRL() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetCRL')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetCRL')({})) .map(mapResponseXmlToJson('tas:GetCRLResponse')) } @@ -389,7 +389,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllCRLs() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCRLs')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCRLs')({})) .map(mapResponseXmlToJson('tas:GetAllCRLsResponse')) } @@ -403,7 +403,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteCRL() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCRL')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCRL')({})) .map(mapResponseXmlToJson('tas:DeleteCRLResponse')) } @@ -419,7 +419,7 @@ export class ONVIFAdvancedSecurity { * */ static CreateCertPathValidationPolicy() { - return createStandardRequestBodyFromString(generateRequestElements('tas:CreateCertPathValidationPolicy')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:CreateCertPathValidationPolicy')({})) .map(mapResponseXmlToJson('tas:CreateCertPathValidationPolicyResponse')) } @@ -431,7 +431,7 @@ export class ONVIFAdvancedSecurity { * */ static GetCertPathValidationPolicy() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetCertPathValidationPolicy')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetCertPathValidationPolicy')({})) .map(mapResponseXmlToJson('tas:GetCertPathValidationPolicyResponse')) } @@ -443,7 +443,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllCertPathValidationPolicies() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCertPathValidationPolicies')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllCertPathValidationPolicies')({})) .map(mapResponseXmlToJson('tas:GetAllCertPathValidationPoliciesResponse')) } @@ -457,7 +457,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteCertPathValidationPolicy() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCertPathValidationPolicy')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteCertPathValidationPolicy')({})) .map(mapResponseXmlToJson('tas:DeleteCertPathValidationPolicyResponse')) } @@ -482,7 +482,7 @@ export class ONVIFAdvancedSecurity { * */ static AddServerCertificateAssignment() { - return createStandardRequestBodyFromString(generateRequestElements('tas:AddServerCertificateAssignment')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:AddServerCertificateAssignment')({})) .map(mapResponseXmlToJson('tas:AddServerCertificateAssignmentResponse')) } @@ -494,7 +494,7 @@ export class ONVIFAdvancedSecurity { * */ static RemoveServerCertificateAssignment() { - return createStandardRequestBodyFromString(generateRequestElements('tas:RemoveServerCertificateAssignment')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:RemoveServerCertificateAssignment')({})) .map(mapResponseXmlToJson('tas:RemoveServerCertificateAssignmentResponse')) } @@ -520,7 +520,7 @@ export class ONVIFAdvancedSecurity { * */ static ReplaceServerCertificateAssignment() { - return createStandardRequestBodyFromString(generateRequestElements('tas:ReplaceServerCertificateAssignment')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:ReplaceServerCertificateAssignment')({})) .map(mapResponseXmlToJson('tas:ReplaceServerCertificateAssignmentResponse')) } @@ -535,7 +535,7 @@ export class ONVIFAdvancedSecurity { * */ static SetEnabledTLSVersions() { - return createStandardRequestBodyFromString(generateRequestElements('tas:SetEnabledTLSVersions')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:SetEnabledTLSVersions')({})) .map(mapResponseXmlToJson('tas:SetEnabledTLSVersionsResponse')) } @@ -546,7 +546,7 @@ export class ONVIFAdvancedSecurity { * */ static GetEnabledTLSVersions() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetEnabledTLSVersions')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetEnabledTLSVersions')({})) .map(mapResponseXmlToJson('tas:GetEnabledTLSVersionsResponse')) } @@ -559,7 +559,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAssignedServerCertificates() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAssignedServerCertificates')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAssignedServerCertificates')({})) .map(mapResponseXmlToJson('tas:GetAssignedServerCertificatesResponse')) } @@ -573,7 +573,7 @@ export class ONVIFAdvancedSecurity { * */ static SetClientAuthenticationRequired() { - return createStandardRequestBodyFromString(generateRequestElements('tas:SetClientAuthenticationRequired')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:SetClientAuthenticationRequired')({})) .map(mapResponseXmlToJson('tas:SetClientAuthenticationRequiredResponse')) } @@ -584,7 +584,7 @@ export class ONVIFAdvancedSecurity { * */ static GetClientAuthenticationRequired() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetClientAuthenticationRequired')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetClientAuthenticationRequired')({})) .map(mapResponseXmlToJson('tas:GetClientAuthenticationRequiredResponse')) } @@ -597,7 +597,7 @@ export class ONVIFAdvancedSecurity { * */ static AddCertPathValidationPolicyAssignment() { - return createStandardRequestBodyFromString(generateRequestElements('tas:AddCertPathValidationPolicyAssignment')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:AddCertPathValidationPolicyAssignment')({})) .map(mapResponseXmlToJson('tas:AddCertPathValidationPolicyAssignmentResponse')) } @@ -609,7 +609,7 @@ export class ONVIFAdvancedSecurity { * */ static RemoveCertPathValidationPolicyAssignment() { - return createStandardRequestBodyFromString(generateRequestElements('tas:RemoveCertPathValidationPolicyAssignment')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:RemoveCertPathValidationPolicyAssignment')({})) .map(mapResponseXmlToJson('tas:RemoveCertPathValidationPolicyAssignmentResponse')) } @@ -622,7 +622,7 @@ export class ONVIFAdvancedSecurity { * */ static ReplaceCertPathValidationPolicyAssignment() { - return createStandardRequestBodyFromString(generateRequestElements('tas:ReplaceCertPathValidationPolicyAssignment')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:ReplaceCertPathValidationPolicyAssignment')({})) .map(mapResponseXmlToJson('tas:ReplaceCertPathValidationPolicyAssignmentResponse')) } @@ -633,7 +633,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAssignedCertPathValidationPolicies() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAssignedCertPathValidationPolicies')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAssignedCertPathValidationPolicies')({})) .map(mapResponseXmlToJson('tas:GetAssignedCertPathValidationPoliciesResponse')) } @@ -644,7 +644,7 @@ export class ONVIFAdvancedSecurity { * */ static AddDot1XConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tas:AddDot1XConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:AddDot1XConfiguration')({})) .map(mapResponseXmlToJson('tas:AddDot1XConfigurationResponse')) } @@ -655,7 +655,7 @@ export class ONVIFAdvancedSecurity { * */ static GetAllDot1XConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllDot1XConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetAllDot1XConfigurations')({})) .map(mapResponseXmlToJson('tas:GetAllDot1XConfigurationsResponse')) } @@ -666,7 +666,7 @@ export class ONVIFAdvancedSecurity { * */ static GetDot1XConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetDot1XConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetDot1XConfiguration')({})) .map(mapResponseXmlToJson('tas:GetDot1XConfigurationResponse')) } @@ -677,7 +677,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteDot1XConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteDot1XConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteDot1XConfiguration')({})) .map(mapResponseXmlToJson('tas:DeleteDot1XConfigurationResponse')) } @@ -688,7 +688,7 @@ export class ONVIFAdvancedSecurity { * */ static SetNetworkInterfaceDot1XConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tas:SetNetworkInterfaceDot1XConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:SetNetworkInterfaceDot1XConfiguration')({})) .map(mapResponseXmlToJson('tas:SetNetworkInterfaceDot1XConfigurationResponse')) } @@ -699,7 +699,7 @@ export class ONVIFAdvancedSecurity { * */ static GetNetworkInterfaceDot1XConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tas:GetNetworkInterfaceDot1XConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:GetNetworkInterfaceDot1XConfiguration')({})) .map(mapResponseXmlToJson('tas:GetNetworkInterfaceDot1XConfigurationResponse')) } @@ -710,7 +710,7 @@ export class ONVIFAdvancedSecurity { * */ static DeleteNetworkInterfaceDot1XConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteNetworkInterfaceDot1XConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tas:DeleteNetworkInterfaceDot1XConfiguration')({})) .map(mapResponseXmlToJson('tas:DeleteNetworkInterfaceDot1XConfigurationResponse')) } diff --git a/src/api/analytics.ts b/src/api/analytics.ts index 07358bd..99eb00b 100644 --- a/src/api/analytics.ts +++ b/src/api/analytics.ts @@ -14,7 +14,7 @@ export class ONVIFAnalytics { * */ static GetSupportedRules(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetSupportedRules')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetSupportedRules')({ConfigurationToken})) .map(mapResponseXmlToJson('tan:GetSupportedRulesResponse')) } @@ -33,7 +33,7 @@ export class ONVIFAnalytics { * */ static CreateRules(ConfigurationToken: ReferenceToken, Rule: Config) { - return createStandardRequestBodyFromString(generateRequestElements('tan:CreateRules')(['ConfigurationToken','Rule'])(ConfigurationToken,Rule)) + return createStandardRequestBodyFromString(generateRequestElements('tan:CreateRules')({ConfigurationToken,Rule})) .map(mapResponseXmlToJson('tan:CreateRulesResponse')) } @@ -44,7 +44,7 @@ export class ONVIFAnalytics { * */ static DeleteRules(ConfigurationToken: ReferenceToken, RuleName: string) { - return createStandardRequestBodyFromString(generateRequestElements('tan:DeleteRules')(['ConfigurationToken','RuleName'])(ConfigurationToken,RuleName)) + return createStandardRequestBodyFromString(generateRequestElements('tan:DeleteRules')({ConfigurationToken,RuleName})) .map(mapResponseXmlToJson('tan:DeleteRulesResponse')) } @@ -55,7 +55,7 @@ export class ONVIFAnalytics { * */ static GetRules(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetRules')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetRules')({ConfigurationToken})) .map(mapResponseXmlToJson('tan:GetRulesResponse')) } @@ -66,7 +66,7 @@ export class ONVIFAnalytics { * */ static GetRuleOptions(ConfigurationToken: ReferenceToken, RuleType?: any) { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetRuleOptions')(['ConfigurationToken','RuleType'])(ConfigurationToken,RuleType)) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetRuleOptions')({ConfigurationToken,RuleType})) .map(mapResponseXmlToJson('tan:GetRuleOptionsResponse')) } @@ -77,7 +77,7 @@ export class ONVIFAnalytics { * */ static ModifyRules(ConfigurationToken: ReferenceToken, Rule: Config) { - return createStandardRequestBodyFromString(generateRequestElements('tan:ModifyRules')(['ConfigurationToken','Rule'])(ConfigurationToken,Rule)) + return createStandardRequestBodyFromString(generateRequestElements('tan:ModifyRules')({ConfigurationToken,Rule})) .map(mapResponseXmlToJson('tan:ModifyRulesResponse')) } @@ -86,7 +86,7 @@ export class ONVIFAnalytics { * Returns the capabilities of the analytics service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tan:GetServiceCapabilitiesResponse')) } @@ -99,7 +99,7 @@ export class ONVIFAnalytics { * */ static GetSupportedAnalyticsModules(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetSupportedAnalyticsModules')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetSupportedAnalyticsModules')({ConfigurationToken})) .map(mapResponseXmlToJson('tan:GetSupportedAnalyticsModulesResponse')) } @@ -110,7 +110,7 @@ export class ONVIFAnalytics { * */ static GetAnalyticsModuleOptions(ConfigurationToken: ReferenceToken, Type?: any) { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetAnalyticsModuleOptions')(['ConfigurationToken','Type'])(ConfigurationToken,Type)) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetAnalyticsModuleOptions')({ConfigurationToken,Type})) .map(mapResponseXmlToJson('tan:GetAnalyticsModuleOptionsResponse')) } @@ -136,7 +136,7 @@ export class ONVIFAnalytics { * */ static CreateAnalyticsModules(ConfigurationToken: ReferenceToken, AnalyticsModule: Config) { - return createStandardRequestBodyFromString(generateRequestElements('tan:CreateAnalyticsModules')(['ConfigurationToken','AnalyticsModule'])(ConfigurationToken,AnalyticsModule)) + return createStandardRequestBodyFromString(generateRequestElements('tan:CreateAnalyticsModules')({ConfigurationToken,AnalyticsModule})) .map(mapResponseXmlToJson('tan:CreateAnalyticsModulesResponse')) } @@ -147,7 +147,7 @@ export class ONVIFAnalytics { * */ static DeleteAnalyticsModules(ConfigurationToken: ReferenceToken, AnalyticsModuleName: string) { - return createStandardRequestBodyFromString(generateRequestElements('tan:DeleteAnalyticsModules')(['ConfigurationToken','AnalyticsModuleName'])(ConfigurationToken,AnalyticsModuleName)) + return createStandardRequestBodyFromString(generateRequestElements('tan:DeleteAnalyticsModules')({ConfigurationToken,AnalyticsModuleName})) .map(mapResponseXmlToJson('tan:DeleteAnalyticsModulesResponse')) } @@ -158,7 +158,7 @@ export class ONVIFAnalytics { * */ static GetAnalyticsModules(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tan:GetAnalyticsModules')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tan:GetAnalyticsModules')({ConfigurationToken})) .map(mapResponseXmlToJson('tan:GetAnalyticsModulesResponse')) } @@ -170,7 +170,7 @@ export class ONVIFAnalytics { * */ static ModifyAnalyticsModules(ConfigurationToken: ReferenceToken, AnalyticsModule: Config) { - return createStandardRequestBodyFromString(generateRequestElements('tan:ModifyAnalyticsModules')(['ConfigurationToken','AnalyticsModule'])(ConfigurationToken,AnalyticsModule)) + return createStandardRequestBodyFromString(generateRequestElements('tan:ModifyAnalyticsModules')({ConfigurationToken,AnalyticsModule})) .map(mapResponseXmlToJson('tan:ModifyAnalyticsModulesResponse')) } diff --git a/src/api/device.ts b/src/api/device.ts index c6039f5..e3a85eb 100644 --- a/src/api/device.ts +++ b/src/api/device.ts @@ -10,7 +10,7 @@ export class ONVIFDevice { * Returns information about services on the device. */ static GetServices(IncludeCapability: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetServices')(['IncludeCapability'])(IncludeCapability)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetServices')({IncludeCapability})) .map(mapResponseXmlToJson('tds:GetServicesResponse')) } @@ -19,7 +19,7 @@ export class ONVIFDevice { * Returns the capabilities of the device service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tds:GetServiceCapabilitiesResponse')) } @@ -28,7 +28,7 @@ export class ONVIFDevice { * This operation gets basic device information from the device. */ static GetDeviceInformation() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDeviceInformation')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDeviceInformation')({})) .map(mapResponseXmlToJson('tds:GetDeviceInformationResponse')) } @@ -45,7 +45,7 @@ export class ONVIFDevice { * */ static SetSystemDateAndTime(DateTimeType: SetDateTimeType, DaylightSavings: boolean, TimeZone?: TimeZone, UTCDateTime?: DateTime) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetSystemDateAndTime')(['DateTimeType','DaylightSavings','TimeZone','UTCDateTime'])(DateTimeType,DaylightSavings,TimeZone,UTCDateTime)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetSystemDateAndTime')({DateTimeType,DaylightSavings,TimeZone,UTCDateTime})) .map(mapResponseXmlToJson('tds:SetSystemDateAndTimeResponse')) } @@ -57,7 +57,7 @@ export class ONVIFDevice { * A device shall provide the UTCDateTime information. */ static GetSystemDateAndTime() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemDateAndTime')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemDateAndTime')({})) .map(mapResponseXmlToJson('tds:GetSystemDateAndTimeResponse')) } @@ -66,7 +66,7 @@ export class ONVIFDevice { * This operation reloads the parameters on the device to their factory default values. */ static SetSystemFactoryDefault(FactoryDefault: FactoryDefaultType) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetSystemFactoryDefault')(['FactoryDefault'])(FactoryDefault)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetSystemFactoryDefault')({FactoryDefault})) .map(mapResponseXmlToJson('tds:SetSystemFactoryDefaultResponse')) } @@ -78,7 +78,7 @@ export class ONVIFDevice { * outside the scope of this standard. */ static UpgradeSystemFirmware(Firmware: AttachmentData) { - return createStandardRequestBodyFromString(generateRequestElements('tds:UpgradeSystemFirmware')(['Firmware'])(Firmware)) + return createStandardRequestBodyFromString(generateRequestElements('tds:UpgradeSystemFirmware')({Firmware})) .map(mapResponseXmlToJson('tds:UpgradeSystemFirmwareResponse')) } @@ -87,7 +87,7 @@ export class ONVIFDevice { * This operation reboots the device. */ static SystemReboot() { - return createStandardRequestBodyFromString(generateRequestElements('tds:SystemReboot')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:SystemReboot')({})) .map(mapResponseXmlToJson('tds:SystemRebootResponse')) } @@ -100,7 +100,7 @@ export class ONVIFDevice { * the GetSystemBackup command. */ static RestoreSystem(BackupFiles: BackupFile) { - return createStandardRequestBodyFromString(generateRequestElements('tds:RestoreSystem')(['BackupFiles'])(BackupFiles)) + return createStandardRequestBodyFromString(generateRequestElements('tds:RestoreSystem')({BackupFiles})) .map(mapResponseXmlToJson('tds:RestoreSystemResponse')) } @@ -112,7 +112,7 @@ export class ONVIFDevice { * The exact format of the backup configuration files is outside the scope of this standard. */ static GetSystemBackup() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemBackup')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemBackup')({})) .map(mapResponseXmlToJson('tds:GetSystemBackupResponse')) } @@ -121,7 +121,7 @@ export class ONVIFDevice { * This operation gets a system log from the device. The exact format of the system logs is outside the scope of this standard. */ static GetSystemLog(LogType: SystemLogType) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemLog')(['LogType'])(LogType)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemLog')({LogType})) .map(mapResponseXmlToJson('tds:GetSystemLogResponse')) } @@ -130,7 +130,7 @@ export class ONVIFDevice { * This operation gets arbitary device diagnostics information from the device. */ static GetSystemSupportInformation() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemSupportInformation')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemSupportInformation')({})) .map(mapResponseXmlToJson('tds:GetSystemSupportInformationResponse')) } @@ -148,7 +148,7 @@ export class ONVIFDevice { * the device shall return a non-empty scope list in the response. */ static GetScopes() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetScopes')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetScopes')({})) .map(mapResponseXmlToJson('tds:GetScopesResponse')) } @@ -161,7 +161,7 @@ export class ONVIFDevice { * support configuration of discovery scope parameters through the SetScopes command. */ static SetScopes(Scopes: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetScopes')(['Scopes'])(Scopes)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetScopes')({Scopes})) .map(mapResponseXmlToJson('tds:SetScopesResponse')) } @@ -172,7 +172,7 @@ export class ONVIFDevice { * support addition of discovery scope parameters through the AddScopes command. */ static AddScopes(ScopeItem: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:AddScopes')(['ScopeItem'])(ScopeItem)) + return createStandardRequestBodyFromString(generateRequestElements('tds:AddScopes')({ScopeItem})) .map(mapResponseXmlToJson('tds:AddScopesResponse')) } @@ -185,7 +185,7 @@ export class ONVIFDevice { * Table */ static RemoveScopes(ScopeItem: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:RemoveScopes')(['ScopeItem'])(ScopeItem)) + return createStandardRequestBodyFromString(generateRequestElements('tds:RemoveScopes')({ScopeItem})) .map(mapResponseXmlToJson('tds:RemoveScopesResponse')) } @@ -196,7 +196,7 @@ export class ONVIFDevice { * setting through the GetDiscoveryMode command. */ static GetDiscoveryMode() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDiscoveryMode')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDiscoveryMode')({})) .map(mapResponseXmlToJson('tds:GetDiscoveryModeResponse')) } @@ -207,7 +207,7 @@ export class ONVIFDevice { * the discovery mode setting through the SetDiscoveryMode command. */ static SetDiscoveryMode(DiscoveryMode: DiscoveryMode) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetDiscoveryMode')(['DiscoveryMode'])(DiscoveryMode)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetDiscoveryMode')({DiscoveryMode})) .map(mapResponseXmlToJson('tds:SetDiscoveryModeResponse')) } @@ -219,7 +219,7 @@ export class ONVIFDevice { * command. */ static GetRemoteDiscoveryMode() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetRemoteDiscoveryMode')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetRemoteDiscoveryMode')({})) .map(mapResponseXmlToJson('tds:GetRemoteDiscoveryModeResponse')) } @@ -231,7 +231,7 @@ export class ONVIFDevice { * SetRemoteDiscoveryMode command. */ static SetRemoteDiscoveryMode(RemoteDiscoveryMode: DiscoveryMode) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetRemoteDiscoveryMode')(['RemoteDiscoveryMode'])(RemoteDiscoveryMode)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetRemoteDiscoveryMode')({RemoteDiscoveryMode})) .map(mapResponseXmlToJson('tds:SetRemoteDiscoveryModeResponse')) } @@ -242,7 +242,7 @@ export class ONVIFDevice { * DP address(es) through the GetDPAddresses command. */ static GetDPAddresses() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDPAddresses')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDPAddresses')({})) .map(mapResponseXmlToJson('tds:GetDPAddressesResponse')) } @@ -253,7 +253,7 @@ export class ONVIFDevice { * remote DP address(es) through the SetDPAddresses command. */ static SetDPAddresses(DPAddress?: NetworkHost) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetDPAddresses')(['DPAddress'])(DPAddress)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetDPAddresses')({DPAddress})) .map(mapResponseXmlToJson('tds:SetDPAddressesResponse')) } @@ -265,7 +265,7 @@ export class ONVIFDevice { * endpoint reference. */ static GetEndpointReference() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetEndpointReference')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetEndpointReference')({})) .map(mapResponseXmlToJson('tds:GetEndpointReferenceResponse')) } @@ -277,7 +277,7 @@ export class ONVIFDevice { * The algorithm to use for deriving the password is described in section 5.12.2.1 of the core specification. */ static GetRemoteUser() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetRemoteUser')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetRemoteUser')({})) .map(mapResponseXmlToJson('tds:GetRemoteUserResponse')) } @@ -291,7 +291,7 @@ export class ONVIFDevice { * To remove the remote user SetRemoteUser should be called without the RemoteUser parameter. */ static SetRemoteUser(RemoteUser?: RemoteUser) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetRemoteUser')(['RemoteUser'])(RemoteUser)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetRemoteUser')({RemoteUser})) .map(mapResponseXmlToJson('tds:SetRemoteUserResponse')) } @@ -302,7 +302,7 @@ export class ONVIFDevice { * token through the GetUsers command. */ static GetUsers() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetUsers')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetUsers')({})) .map(mapResponseXmlToJson('tds:GetUsersResponse')) } @@ -317,7 +317,7 @@ export class ONVIFDevice { * equivalent' of length 28 bytes, as described in section 3.1.2 of the ONVIF security white paper. */ static CreateUsers(User: User) { - return createStandardRequestBodyFromString(generateRequestElements('tds:CreateUsers')(['User'])(User)) + return createStandardRequestBodyFromString(generateRequestElements('tds:CreateUsers')({User})) .map(mapResponseXmlToJson('tds:CreateUsersResponse')) } @@ -329,7 +329,7 @@ export class ONVIFDevice { * fault message shall be returned and no users be deleted. */ static DeleteUsers(Username: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteUsers')(['Username'])(Username)) + return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteUsers')({Username})) .map(mapResponseXmlToJson('tds:DeleteUsersResponse')) } @@ -340,7 +340,7 @@ export class ONVIFDevice { * Either all change requests are processed successfully or a fault message shall be returned and no change requests be processed. */ static SetUser(User: User) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetUser')(['User'])(User)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetUser')({User})) .map(mapResponseXmlToJson('tds:SetUserResponse')) } @@ -352,7 +352,7 @@ export class ONVIFDevice { * device shall provide a URL for WSDL and schema download through the GetWsdlUrl command. */ static GetWsdlUrl() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetWsdlUrl')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetWsdlUrl')({})) .map(mapResponseXmlToJson('tds:GetWsdlUrlResponse')) } @@ -362,7 +362,7 @@ export class ONVIFDevice { * For capabilities of individual services refer to the GetServiceCapabilities methods. */ static GetCapabilities(Category?: CapabilityCategory) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetCapabilities')(['Category'])(Category)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetCapabilities')({Category})) .map(mapResponseXmlToJson('tds:GetCapabilitiesResponse')) } @@ -372,7 +372,7 @@ export class ONVIFDevice { * return its hostname configurations through the GetHostname command. */ static GetHostname() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetHostname')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetHostname')({})) .map(mapResponseXmlToJson('tds:GetHostnameResponse')) } @@ -385,7 +385,7 @@ export class ONVIFDevice { * */ static SetHostname(Name: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetHostname')(['Name'])(Name)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetHostname')({Name})) .map(mapResponseXmlToJson('tds:SetHostnameResponse')) } @@ -394,7 +394,7 @@ export class ONVIFDevice { * This operation controls whether the hostname is set manually or retrieved via DHCP. */ static SetHostnameFromDHCP(FromDHCP: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetHostnameFromDHCP')(['FromDHCP'])(FromDHCP)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetHostnameFromDHCP')({FromDHCP})) .map(mapResponseXmlToJson('tds:SetHostnameFromDHCPResponse')) } @@ -404,7 +404,7 @@ export class ONVIFDevice { * configurations through the GetDNS command. */ static GetDNS() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDNS')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDNS')({})) .map(mapResponseXmlToJson('tds:GetDNSResponse')) } @@ -414,7 +414,7 @@ export class ONVIFDevice { * configurations through the SetDNS command. */ static SetDNS(FromDHCP: boolean, SearchDomain?: string, DNSManual?: IPAddress) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetDNS')(['FromDHCP','SearchDomain','DNSManual'])(FromDHCP,SearchDomain,DNSManual)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetDNS')({FromDHCP,SearchDomain,DNSManual})) .map(mapResponseXmlToJson('tds:SetDNSResponse')) } @@ -424,7 +424,7 @@ export class ONVIFDevice { * possible to get the NTP server settings through the GetNTP command. */ static GetNTP() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetNTP')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetNTP')({})) .map(mapResponseXmlToJson('tds:GetNTPResponse')) } @@ -438,7 +438,7 @@ export class ONVIFDevice { * */ static SetNTP(FromDHCP: boolean, NTPManual?: NetworkHost) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetNTP')(['FromDHCP','NTPManual'])(FromDHCP,NTPManual)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetNTP')({FromDHCP,NTPManual})) .map(mapResponseXmlToJson('tds:SetNTPResponse')) } @@ -449,7 +449,7 @@ export class ONVIFDevice { * and TTL through the GetDynamicDNS command. */ static GetDynamicDNS() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDynamicDNS')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDynamicDNS')({})) .map(mapResponseXmlToJson('tds:GetDynamicDNSResponse')) } @@ -460,7 +460,7 @@ export class ONVIFDevice { * and TTL through the SetDynamicDNS command. */ static SetDynamicDNS(Type: DynamicDNSType, Name?: DNSName, TTL?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetDynamicDNS')(['Type','Name','TTL'])(Type,Name,TTL)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetDynamicDNS')({Type,Name,TTL})) .map(mapResponseXmlToJson('tds:SetDynamicDNSResponse')) } @@ -471,7 +471,7 @@ export class ONVIFDevice { * type through the GetNetworkInterfaces command. */ static GetNetworkInterfaces() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetNetworkInterfaces')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetNetworkInterfaces')({})) .map(mapResponseXmlToJson('tds:GetNetworkInterfacesResponse')) } @@ -485,7 +485,7 @@ export class ONVIFDevice { * request. */ static SetNetworkInterfaces(InterfaceToken: ReferenceToken, NetworkInterface: NetworkInterfaceSetConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetNetworkInterfaces')(['InterfaceToken','NetworkInterface'])(InterfaceToken,NetworkInterface)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetNetworkInterfaces')({InterfaceToken,NetworkInterface})) .map(mapResponseXmlToJson('tds:SetNetworkInterfacesResponse')) } @@ -495,7 +495,7 @@ export class ONVIFDevice { * GetNetworkProtocols command returning configured network protocols. */ static GetNetworkProtocols() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetNetworkProtocols')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetNetworkProtocols')({})) .map(mapResponseXmlToJson('tds:GetNetworkProtocolsResponse')) } @@ -505,7 +505,7 @@ export class ONVIFDevice { * configuration of defined network protocols through the SetNetworkProtocols command. */ static SetNetworkProtocols(NetworkProtocols: NetworkProtocol) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetNetworkProtocols')(['NetworkProtocols'])(NetworkProtocols)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetNetworkProtocols')({NetworkProtocols})) .map(mapResponseXmlToJson('tds:SetNetworkProtocolsResponse')) } @@ -515,7 +515,7 @@ export class ONVIFDevice { * GetNetworkDefaultGateway command returning configured default gateway address(es). */ static GetNetworkDefaultGateway() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetNetworkDefaultGateway')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetNetworkDefaultGateway')({})) .map(mapResponseXmlToJson('tds:GetNetworkDefaultGatewayResponse')) } @@ -525,7 +525,7 @@ export class ONVIFDevice { * configuration of default gateway through the SetNetworkDefaultGateway command. */ static SetNetworkDefaultGateway(IPv4Address?: IPv4Address, IPv6Address?: IPv6Address) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetNetworkDefaultGateway')(['IPv4Address','IPv6Address'])(IPv4Address,IPv6Address)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetNetworkDefaultGateway')({IPv4Address,IPv6Address})) .map(mapResponseXmlToJson('tds:SetNetworkDefaultGatewayResponse')) } @@ -537,7 +537,7 @@ export class ONVIFDevice { * Devices supporting zero configuration on more than one interface shall use the extension to list the additional interface settings. */ static GetZeroConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetZeroConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetZeroConfiguration')({})) .map(mapResponseXmlToJson('tds:GetZeroConfigurationResponse')) } @@ -546,7 +546,7 @@ export class ONVIFDevice { * This operation sets the zero-configuration. Use GetCapalities to get if zero-zero-configuration is supported or not. */ static SetZeroConfiguration(InterfaceToken: ReferenceToken, Enabled: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetZeroConfiguration')(['InterfaceToken','Enabled'])(InterfaceToken,Enabled)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetZeroConfiguration')({InterfaceToken,Enabled})) .map(mapResponseXmlToJson('tds:SetZeroConfigurationResponse')) } @@ -557,7 +557,7 @@ export class ONVIFDevice { * device shall support the GetIPAddressFilter command. */ static GetIPAddressFilter() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetIPAddressFilter')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetIPAddressFilter')({})) .map(mapResponseXmlToJson('tds:GetIPAddressFilterResponse')) } @@ -569,7 +569,7 @@ export class ONVIFDevice { * command. */ static SetIPAddressFilter(IPAddressFilter: IPAddressFilter) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetIPAddressFilter')(['IPAddressFilter'])(IPAddressFilter)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetIPAddressFilter')({IPAddressFilter})) .map(mapResponseXmlToJson('tds:SetIPAddressFilterResponse')) } @@ -580,7 +580,7 @@ export class ONVIFDevice { * shall support adding of IP filtering addresses through the AddIPAddressFilter command. */ static AddIPAddressFilter(IPAddressFilter: IPAddressFilter) { - return createStandardRequestBodyFromString(generateRequestElements('tds:AddIPAddressFilter')(['IPAddressFilter'])(IPAddressFilter)) + return createStandardRequestBodyFromString(generateRequestElements('tds:AddIPAddressFilter')({IPAddressFilter})) .map(mapResponseXmlToJson('tds:AddIPAddressFilterResponse')) } @@ -591,7 +591,7 @@ export class ONVIFDevice { * shall support deletion of IP filtering addresses through the RemoveIPAddressFilter command. */ static RemoveIPAddressFilter(IPAddressFilter: IPAddressFilter) { - return createStandardRequestBodyFromString(generateRequestElements('tds:RemoveIPAddressFilter')(['IPAddressFilter'])(IPAddressFilter)) + return createStandardRequestBodyFromString(generateRequestElements('tds:RemoveIPAddressFilter')({IPAddressFilter})) .map(mapResponseXmlToJson('tds:RemoveIPAddressFilterResponse')) } @@ -607,7 +607,7 @@ export class ONVIFDevice { * shall support this command. */ static GetAccessPolicy() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetAccessPolicy')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetAccessPolicy')({})) .map(mapResponseXmlToJson('tds:GetAccessPolicyResponse')) } @@ -618,7 +618,7 @@ export class ONVIFDevice { * based on WS-Security authentication, then the device shall support this command. */ static SetAccessPolicy(PolicyFile: BinaryData) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetAccessPolicy')(['PolicyFile'])(PolicyFile)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetAccessPolicy')({PolicyFile})) .map(mapResponseXmlToJson('tds:SetAccessPolicyResponse')) } @@ -635,7 +635,7 @@ export class ONVIFDevice { * given). */ static CreateCertificate(CertificateID?: string, Subject?: string, ValidNotBefore?: string, ValidNotAfter?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:CreateCertificate')(['CertificateID','Subject','ValidNotBefore','ValidNotAfter'])(CertificateID,Subject,ValidNotBefore,ValidNotAfter)) + return createStandardRequestBodyFromString(generateRequestElements('tds:CreateCertificate')({CertificateID,Subject,ValidNotBefore,ValidNotAfter})) .map(mapResponseXmlToJson('tds:CreateCertificateResponse')) } @@ -650,7 +650,7 @@ export class ONVIFDevice { * rules. */ static GetCertificates() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetCertificates')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetCertificates')({})) .map(mapResponseXmlToJson('tds:GetCertificatesResponse')) } @@ -661,7 +661,7 @@ export class ONVIFDevice { * support this command. */ static GetCertificatesStatus() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetCertificatesStatus')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetCertificatesStatus')({})) .map(mapResponseXmlToJson('tds:GetCertificatesStatusResponse')) } @@ -672,7 +672,7 @@ export class ONVIFDevice { * Typically only one device server certificate is allowed to be enabled at a time. */ static SetCertificatesStatus(CertificateStatus?: CertificateStatus) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetCertificatesStatus')(['CertificateStatus'])(CertificateStatus)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetCertificatesStatus')({CertificateStatus})) .map(mapResponseXmlToJson('tds:SetCertificatesStatusResponse')) } @@ -685,7 +685,7 @@ export class ONVIFDevice { * message shall be returned without deleting any certificate. */ static DeleteCertificates(CertificateID: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteCertificates')(['CertificateID'])(CertificateID)) + return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteCertificates')({CertificateID})) .map(mapResponseXmlToJson('tds:DeleteCertificatesResponse')) } @@ -701,7 +701,7 @@ export class ONVIFDevice { * using client certificate shall support this command. */ static GetPkcs10Request(CertificateID: string, Subject?: string, Attributes?: BinaryData) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetPkcs10Request')(['CertificateID','Subject','Attributes'])(CertificateID,Subject,Attributes)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetPkcs10Request')({CertificateID,Subject,Attributes})) .map(mapResponseXmlToJson('tds:GetPkcs10RequestResponse')) } @@ -723,7 +723,7 @@ export class ONVIFDevice { * historical reasons NVTCertificate. */ static LoadCertificates(NVTCertificate: Certificate) { - return createStandardRequestBodyFromString(generateRequestElements('tds:LoadCertificates')(['NVTCertificate'])(NVTCertificate)) + return createStandardRequestBodyFromString(generateRequestElements('tds:LoadCertificates')({NVTCertificate})) .map(mapResponseXmlToJson('tds:LoadCertificatesResponse')) } @@ -734,7 +734,7 @@ export class ONVIFDevice { * support this command. */ static GetClientCertificateMode() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetClientCertificateMode')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetClientCertificateMode')({})) .map(mapResponseXmlToJson('tds:GetClientCertificateModeResponse')) } @@ -745,7 +745,7 @@ export class ONVIFDevice { * support this command. */ static SetClientCertificateMode(Enabled: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetClientCertificateMode')(['Enabled'])(Enabled)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetClientCertificateMode')({Enabled})) .map(mapResponseXmlToJson('tds:SetClientCertificateModeResponse')) } @@ -755,7 +755,7 @@ export class ONVIFDevice { * This method has been depricated with version 2.0. Refer to the DeviceIO service. */ static GetRelayOutputs() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetRelayOutputs')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetRelayOutputs')({})) .map(mapResponseXmlToJson('tds:GetRelayOutputsResponse')) } @@ -765,7 +765,7 @@ export class ONVIFDevice { * This method has been depricated with version 2.0. Refer to the DeviceIO service. */ static SetRelayOutputSettings(RelayOutputToken: ReferenceToken, Properties: RelayOutputSettings) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetRelayOutputSettings')(['RelayOutputToken','Properties'])(RelayOutputToken,Properties)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetRelayOutputSettings')({RelayOutputToken,Properties})) .map(mapResponseXmlToJson('tds:SetRelayOutputSettingsResponse')) } @@ -775,7 +775,7 @@ export class ONVIFDevice { * This method has been depricated with version 2.0. Refer to the DeviceIO service. */ static SetRelayOutputState(RelayOutputToken: ReferenceToken, LogicalState: RelayLogicalState) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetRelayOutputState')(['RelayOutputToken','LogicalState'])(RelayOutputToken,LogicalState)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetRelayOutputState')({RelayOutputToken,LogicalState})) .map(mapResponseXmlToJson('tds:SetRelayOutputStateResponse')) } @@ -800,7 +800,7 @@ export class ONVIFDevice { * A device that indicates auxiliary service capability shall support this command. */ static SendAuxiliaryCommand(AuxiliaryCommand: AuxiliaryData) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SendAuxiliaryCommand')(['AuxiliaryCommand'])(AuxiliaryCommand)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SendAuxiliaryCommand')({AuxiliaryCommand})) .map(mapResponseXmlToJson('tds:SendAuxiliaryCommandResponse')) } @@ -814,7 +814,7 @@ export class ONVIFDevice { * be encoded using ASN.1 [X.681], [X.682], [X.683] DER [X.690] encoding rules. */ static GetCACertificates() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetCACertificates')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetCACertificates')({})) .map(mapResponseXmlToJson('tds:GetCACertificatesResponse')) } @@ -835,7 +835,7 @@ export class ONVIFDevice { * operation should make sure that the private key is sufficiently protected. */ static LoadCertificateWithPrivateKey(CertificateWithPrivateKey: CertificateWithPrivateKey) { - return createStandardRequestBodyFromString(generateRequestElements('tds:LoadCertificateWithPrivateKey')(['CertificateWithPrivateKey'])(CertificateWithPrivateKey)) + return createStandardRequestBodyFromString(generateRequestElements('tds:LoadCertificateWithPrivateKey')({CertificateWithPrivateKey})) .map(mapResponseXmlToJson('tds:LoadCertificateWithPrivateKeyResponse')) } @@ -849,7 +849,7 @@ export class ONVIFDevice { * A device that supports either TLS or IEEE 802.1X should support this command. */ static GetCertificateInformation(CertificateID: string) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetCertificateInformation')(['CertificateID'])(CertificateID)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetCertificateInformation')({CertificateID})) .map(mapResponseXmlToJson('tds:GetCertificateInformationResponse')) } @@ -866,7 +866,7 @@ export class ONVIFDevice { * message shall be returned without loading any CA certificate. */ static LoadCACertificates(CACertificate: Certificate) { - return createStandardRequestBodyFromString(generateRequestElements('tds:LoadCACertificates')(['CACertificate'])(CACertificate)) + return createStandardRequestBodyFromString(generateRequestElements('tds:LoadCACertificates')({CACertificate})) .map(mapResponseXmlToJson('tds:LoadCACertificatesResponse')) } @@ -879,7 +879,7 @@ export class ONVIFDevice { * conflict. */ static CreateDot1XConfiguration(Dot1XConfiguration: Dot1XConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('tds:CreateDot1XConfiguration')(['Dot1XConfiguration'])(Dot1XConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tds:CreateDot1XConfiguration')({Dot1XConfiguration})) .map(mapResponseXmlToJson('tds:CreateDot1XConfigurationResponse')) } @@ -890,7 +890,7 @@ export class ONVIFDevice { * the device. A device that support IEEE 802.1X shall support this command. */ static SetDot1XConfiguration(Dot1XConfiguration: Dot1XConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetDot1XConfiguration')(['Dot1XConfiguration'])(Dot1XConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetDot1XConfiguration')({Dot1XConfiguration})) .map(mapResponseXmlToJson('tds:SetDot1XConfigurationResponse')) } @@ -903,7 +903,7 @@ export class ONVIFDevice { * not, the device shall not include the Password element in the response. */ static GetDot1XConfiguration(Dot1XConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot1XConfiguration')(['Dot1XConfigurationToken'])(Dot1XConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot1XConfiguration')({Dot1XConfigurationToken})) .map(mapResponseXmlToJson('tds:GetDot1XConfigurationResponse')) } @@ -917,7 +917,7 @@ export class ONVIFDevice { * not, the device shall not include the Password element in the response. */ static GetDot1XConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot1XConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot1XConfigurations')({})) .map(mapResponseXmlToJson('tds:GetDot1XConfigurationsResponse')) } @@ -928,7 +928,7 @@ export class ONVIFDevice { * A device that support IEEE 802.1X shall support this command. */ static DeleteDot1XConfiguration(Dot1XConfigurationToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteDot1XConfiguration')(['Dot1XConfigurationToken'])(Dot1XConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteDot1XConfiguration')({Dot1XConfigurationToken})) .map(mapResponseXmlToJson('tds:DeleteDot1XConfigurationResponse')) } @@ -938,7 +938,7 @@ export class ONVIFDevice { * this operation. */ static GetDot11Capabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot11Capabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot11Capabilities')({})) .map(mapResponseXmlToJson('tds:GetDot11CapabilitiesResponse')) } @@ -948,7 +948,7 @@ export class ONVIFDevice { * command. */ static GetDot11Status(InterfaceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot11Status')(['InterfaceToken'])(InterfaceToken)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetDot11Status')({InterfaceToken})) .map(mapResponseXmlToJson('tds:GetDot11StatusResponse')) } @@ -958,7 +958,7 @@ export class ONVIFDevice { * support this operation. */ static ScanAvailableDot11Networks(InterfaceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tds:ScanAvailableDot11Networks')(['InterfaceToken'])(InterfaceToken)) + return createStandardRequestBodyFromString(generateRequestElements('tds:ScanAvailableDot11Networks')({InterfaceToken})) .map(mapResponseXmlToJson('tds:ScanAvailableDot11NetworksResponse')) } @@ -978,7 +978,7 @@ export class ONVIFDevice { * command. */ static GetSystemUris() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemUris')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetSystemUris')({})) .map(mapResponseXmlToJson('tds:GetSystemUrisResponse')) } @@ -1002,7 +1002,7 @@ export class ONVIFDevice { * The value of the Content-Type header in the HTTP POST request shall be “application/octetstream”. */ static StartFirmwareUpgrade() { - return createStandardRequestBodyFromString(generateRequestElements('tds:StartFirmwareUpgrade')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:StartFirmwareUpgrade')({})) .map(mapResponseXmlToJson('tds:StartFirmwareUpgradeResponse')) } @@ -1026,7 +1026,7 @@ export class ONVIFDevice { * The value of the Content-Type header in the HTTP POST request shall be “application/octetstream”. */ static StartSystemRestore() { - return createStandardRequestBodyFromString(generateRequestElements('tds:StartSystemRestore')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:StartSystemRestore')({})) .map(mapResponseXmlToJson('tds:StartSystemRestoreResponse')) } @@ -1037,7 +1037,7 @@ export class ONVIFDevice { * */ static GetStorageConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetStorageConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetStorageConfigurations')({})) .map(mapResponseXmlToJson('tds:GetStorageConfigurationsResponse')) } @@ -1049,7 +1049,7 @@ export class ONVIFDevice { * */ static CreateStorageConfiguration(StorageConfiguration: any) { - return createStandardRequestBodyFromString(generateRequestElements('tds:CreateStorageConfiguration')(['StorageConfiguration'])(StorageConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tds:CreateStorageConfiguration')({StorageConfiguration})) .map(mapResponseXmlToJson('tds:CreateStorageConfigurationResponse')) } @@ -1060,7 +1060,7 @@ export class ONVIFDevice { * */ static GetStorageConfiguration(Token: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetStorageConfiguration')(['Token'])(Token)) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetStorageConfiguration')({Token})) .map(mapResponseXmlToJson('tds:GetStorageConfigurationResponse')) } @@ -1071,7 +1071,7 @@ export class ONVIFDevice { * */ static SetStorageConfiguration(StorageConfiguration: any) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetStorageConfiguration')(['StorageConfiguration'])(StorageConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetStorageConfiguration')({StorageConfiguration})) .map(mapResponseXmlToJson('tds:SetStorageConfigurationResponse')) } @@ -1082,7 +1082,7 @@ export class ONVIFDevice { * */ static DeleteStorageConfiguration(Token: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteStorageConfiguration')(['Token'])(Token)) + return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteStorageConfiguration')({Token})) .map(mapResponseXmlToJson('tds:DeleteStorageConfigurationResponse')) } @@ -1093,7 +1093,7 @@ export class ONVIFDevice { * */ static GetGeoLocation() { - return createStandardRequestBodyFromString(generateRequestElements('tds:GetGeoLocation')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tds:GetGeoLocation')({})) .map(mapResponseXmlToJson('tds:GetGeoLocationResponse')) } @@ -1104,7 +1104,7 @@ export class ONVIFDevice { * */ static SetGeoLocation(Location: LocationEntity) { - return createStandardRequestBodyFromString(generateRequestElements('tds:SetGeoLocation')(['Location'])(Location)) + return createStandardRequestBodyFromString(generateRequestElements('tds:SetGeoLocation')({Location})) .map(mapResponseXmlToJson('tds:SetGeoLocationResponse')) } @@ -1115,7 +1115,7 @@ export class ONVIFDevice { * */ static DeleteGeoLocation(Location: LocationEntity) { - return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteGeoLocation')(['Location'])(Location)) + return createStandardRequestBodyFromString(generateRequestElements('tds:DeleteGeoLocation')({Location})) .map(mapResponseXmlToJson('tds:DeleteGeoLocationResponse')) } diff --git a/src/api/display.ts b/src/api/display.ts index 49145f1..8730520 100644 --- a/src/api/display.ts +++ b/src/api/display.ts @@ -10,7 +10,7 @@ export class ONVIFDisplay { * Returns the capabilities of the display service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tls:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tls:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tls:GetServiceCapabilitiesResponse')) } @@ -21,7 +21,7 @@ export class ONVIFDisplay { * their associated display areas. */ static GetLayout(VideoOutput: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tls:GetLayout')(['VideoOutput'])(VideoOutput)) + return createStandardRequestBodyFromString(generateRequestElements('tls:GetLayout')({VideoOutput})) .map(mapResponseXmlToJson('tls:GetLayoutResponse')) } @@ -35,7 +35,7 @@ export class ONVIFDisplay { * */ static SetLayout(VideoOutput: ReferenceToken, Layout: Layout) { - return createStandardRequestBodyFromString(generateRequestElements('tls:SetLayout')(['VideoOutput','Layout'])(VideoOutput,Layout)) + return createStandardRequestBodyFromString(generateRequestElements('tls:SetLayout')({VideoOutput,Layout})) .map(mapResponseXmlToJson('tls:SetLayoutResponse')) } @@ -46,7 +46,7 @@ export class ONVIFDisplay { * returns both, Layout and Coding Capabilities, of a VideoOutput. */ static GetDisplayOptions(VideoOutput: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tls:GetDisplayOptions')(['VideoOutput'])(VideoOutput)) + return createStandardRequestBodyFromString(generateRequestElements('tls:GetDisplayOptions')({VideoOutput})) .map(mapResponseXmlToJson('tls:GetDisplayOptionsResponse')) } @@ -59,7 +59,7 @@ export class ONVIFDisplay { * not be established. */ static GetPaneConfigurations(VideoOutput: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tls:GetPaneConfigurations')(['VideoOutput'])(VideoOutput)) + return createStandardRequestBodyFromString(generateRequestElements('tls:GetPaneConfigurations')({VideoOutput})) .map(mapResponseXmlToJson('tls:GetPaneConfigurationsResponse')) } @@ -68,7 +68,7 @@ export class ONVIFDisplay { * Retrieve the pane configuration for a pane token. */ static GetPaneConfiguration(VideoOutput: ReferenceToken, Pane: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tls:GetPaneConfiguration')(['VideoOutput','Pane'])(VideoOutput,Pane)) + return createStandardRequestBodyFromString(generateRequestElements('tls:GetPaneConfiguration')({VideoOutput,Pane})) .map(mapResponseXmlToJson('tls:GetPaneConfigurationResponse')) } @@ -79,7 +79,7 @@ export class ONVIFDisplay { * Use DeletePaneConfiguration to remove pane configurations. */ static SetPaneConfigurations(VideoOutput: ReferenceToken, PaneConfiguration: PaneConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('tls:SetPaneConfigurations')(['VideoOutput','PaneConfiguration'])(VideoOutput,PaneConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tls:SetPaneConfigurations')({VideoOutput,PaneConfiguration})) .map(mapResponseXmlToJson('tls:SetPaneConfigurationsResponse')) } @@ -88,7 +88,7 @@ export class ONVIFDisplay { * This command changes the configuration of the specified pane (tbd) */ static SetPaneConfiguration(VideoOutput: ReferenceToken, PaneConfiguration: PaneConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('tls:SetPaneConfiguration')(['VideoOutput','PaneConfiguration'])(VideoOutput,PaneConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tls:SetPaneConfiguration')({VideoOutput,PaneConfiguration})) .map(mapResponseXmlToJson('tls:SetPaneConfigurationResponse')) } @@ -100,7 +100,7 @@ export class ONVIFDisplay { * */ static CreatePaneConfiguration(VideoOutput: ReferenceToken, PaneConfiguration: PaneConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('tls:CreatePaneConfiguration')(['VideoOutput','PaneConfiguration'])(VideoOutput,PaneConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('tls:CreatePaneConfiguration')({VideoOutput,PaneConfiguration})) .map(mapResponseXmlToJson('tls:CreatePaneConfigurationResponse')) } @@ -112,7 +112,7 @@ export class ONVIFDisplay { * */ static DeletePaneConfiguration(VideoOutput: ReferenceToken, PaneToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tls:DeletePaneConfiguration')(['VideoOutput','PaneToken'])(VideoOutput,PaneToken)) + return createStandardRequestBodyFromString(generateRequestElements('tls:DeletePaneConfiguration')({VideoOutput,PaneToken})) .map(mapResponseXmlToJson('tls:DeletePaneConfigurationResponse')) } diff --git a/src/api/imaging.ts b/src/api/imaging.ts index 1a39a68..4db714e 100644 --- a/src/api/imaging.ts +++ b/src/api/imaging.ts @@ -10,7 +10,7 @@ export class ONVIFImaging { * Returns the capabilities of the imaging service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('timg:GetServiceCapabilitiesResponse')) } @@ -19,7 +19,7 @@ export class ONVIFImaging { * Get the ImagingConfiguration for the requested VideoSource. */ static GetImagingSettings(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetImagingSettings')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetImagingSettings')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:GetImagingSettingsResponse')) } @@ -28,7 +28,7 @@ export class ONVIFImaging { * Set the ImagingConfiguration for the requested VideoSource. */ static SetImagingSettings(VideoSourceToken: ReferenceToken, ImagingSettings: ImagingSettings20, ForcePersistence?: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('timg:SetImagingSettings')(['VideoSourceToken','ImagingSettings','ForcePersistence'])(VideoSourceToken,ImagingSettings,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('timg:SetImagingSettings')({VideoSourceToken,ImagingSettings,ForcePersistence})) .map(mapResponseXmlToJson('timg:SetImagingSettingsResponse')) } @@ -41,7 +41,7 @@ export class ONVIFImaging { * is provided. */ static GetOptions(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetOptions')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetOptions')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:GetOptionsResponse')) } @@ -59,7 +59,7 @@ export class ONVIFImaging { * */ static Move(VideoSourceToken: ReferenceToken, Focus: FocusMove) { - return createStandardRequestBodyFromString(generateRequestElements('timg:Move')(['VideoSourceToken','Focus'])(VideoSourceToken,Focus)) + return createStandardRequestBodyFromString(generateRequestElements('timg:Move')({VideoSourceToken,Focus})) .map(mapResponseXmlToJson('timg:MoveResponse')) } @@ -68,7 +68,7 @@ export class ONVIFImaging { * Imaging move operation options supported for the Video source. */ static GetMoveOptions(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetMoveOptions')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetMoveOptions')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:GetMoveOptionsResponse')) } @@ -78,7 +78,7 @@ export class ONVIFImaging { * the GetMoveOptions supports this command. The operation will not affect ongoing autofocus operation. */ static Stop(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:Stop')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:Stop')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:StopResponse')) } @@ -87,7 +87,7 @@ export class ONVIFImaging { * 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. */ static GetStatus(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetStatus')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetStatus')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:GetStatusResponse')) } @@ -96,7 +96,7 @@ export class ONVIFImaging { * Via this command the list of available Imaging Presets can be requested. */ static GetPresets(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetPresets')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetPresets')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:GetPresetsResponse')) } @@ -107,7 +107,7 @@ export class ONVIFImaging { * GetCurrentPreset shall return 0 if Imaging Presets are not supported by the Video Source. */ static GetCurrentPreset(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:GetCurrentPreset')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:GetCurrentPreset')({VideoSourceToken})) .map(mapResponseXmlToJson('timg:GetCurrentPresetResponse')) } @@ -119,7 +119,7 @@ export class ONVIFImaging { * 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. */ static SetCurrentPreset(VideoSourceToken: ReferenceToken, PresetToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('timg:SetCurrentPreset')(['VideoSourceToken','PresetToken'])(VideoSourceToken,PresetToken)) + return createStandardRequestBodyFromString(generateRequestElements('timg:SetCurrentPreset')({VideoSourceToken,PresetToken})) .map(mapResponseXmlToJson('timg:SetCurrentPresetResponse')) } diff --git a/src/api/media.ts b/src/api/media.ts index 197a456..80216c9 100644 --- a/src/api/media.ts +++ b/src/api/media.ts @@ -10,7 +10,7 @@ export class ONVIFMedia { * Returns the capabilities of the media service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('trt:GetServiceCapabilitiesResponse')) } @@ -19,7 +19,7 @@ export class ONVIFMedia { * This command lists all available physical video inputs of the device. */ static GetVideoSources() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSources')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSources')({})) .map(mapResponseXmlToJson('trt:GetVideoSourcesResponse')) } @@ -28,7 +28,7 @@ export class ONVIFMedia { * This command lists all available physical audio inputs of the device. */ static GetAudioSources() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSources')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSources')({})) .map(mapResponseXmlToJson('trt:GetAudioSourcesResponse')) } @@ -37,7 +37,7 @@ export class ONVIFMedia { * This command lists all available physical audio outputs of the device. */ static GetAudioOutputs() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputs')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputs')({})) .map(mapResponseXmlToJson('trt:GetAudioOutputsResponse')) } @@ -48,7 +48,7 @@ export class ONVIFMedia { * returned Profile. */ static CreateProfile(Name: Name, Token?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:CreateProfile')(['Name','Token'])(Name,Token)) + return createStandardRequestBodyFromString(generateRequestElements('trt:CreateProfile')({Name,Token})) .map(mapResponseXmlToJson('trt:CreateProfileResponse')) } @@ -57,7 +57,7 @@ export class ONVIFMedia { * If the profile token is already known, a profile can be fetched through the GetProfile command. */ static GetProfile(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetProfile')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetProfile')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetProfileResponse')) } @@ -69,7 +69,7 @@ export class ONVIFMedia { * know the media profile in order to use the command. */ static GetProfiles() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetProfiles')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetProfiles')({})) .map(mapResponseXmlToJson('trt:GetProfilesResponse')) } @@ -82,7 +82,7 @@ export class ONVIFMedia { * */ static AddVideoEncoderConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddVideoEncoderConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddVideoEncoderConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddVideoEncoderConfigurationResponse')) } @@ -92,7 +92,7 @@ export class ONVIFMedia { * media profile does not contain a VideoEncoderConfiguration, the operation has no effect. The removal shall be persistent. */ static RemoveVideoEncoderConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveVideoEncoderConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveVideoEncoderConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveVideoEncoderConfigurationResponse')) } @@ -102,7 +102,7 @@ export class ONVIFMedia { * configuration exists in the media profile, it will be replaced. The change shall be persistent. */ static AddVideoSourceConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddVideoSourceConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddVideoSourceConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddVideoSourceConfigurationResponse')) } @@ -113,7 +113,7 @@ export class ONVIFMedia { * VideoEncoderConfiguration from the media profile. */ static RemoveVideoSourceConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveVideoSourceConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveVideoSourceConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveVideoSourceConfigurationResponse')) } @@ -126,7 +126,7 @@ export class ONVIFMedia { * */ static AddAudioEncoderConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioEncoderConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioEncoderConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddAudioEncoderConfigurationResponse')) } @@ -137,7 +137,7 @@ export class ONVIFMedia { * The removal shall be persistent. */ static RemoveAudioEncoderConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioEncoderConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioEncoderConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveAudioEncoderConfigurationResponse')) } @@ -147,7 +147,7 @@ export class ONVIFMedia { * configuration exists in the media profile, it will be replaced. The change shall be persistent. */ static AddAudioSourceConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioSourceConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioSourceConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddAudioSourceConfigurationResponse')) } @@ -159,7 +159,7 @@ export class ONVIFMedia { * AudioEncoderConfiguration from the media profile. */ static RemoveAudioSourceConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioSourceConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioSourceConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveAudioSourceConfigurationResponse')) } @@ -171,7 +171,7 @@ export class ONVIFMedia { * PTZ movement. */ static AddPTZConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddPTZConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddPTZConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddPTZConfigurationResponse')) } @@ -181,7 +181,7 @@ export class ONVIFMedia { * does not contain a PTZConfiguration, the operation has no effect. The removal shall be persistent. */ static RemovePTZConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemovePTZConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemovePTZConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemovePTZConfigurationResponse')) } @@ -193,7 +193,7 @@ export class ONVIFMedia { * configuration before a video source configuration. */ static AddVideoAnalyticsConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddVideoAnalyticsConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddVideoAnalyticsConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddVideoAnalyticsConfigurationResponse')) } @@ -203,7 +203,7 @@ export class ONVIFMedia { * The removal shall be persistent. */ static RemoveVideoAnalyticsConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveVideoAnalyticsConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveVideoAnalyticsConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveVideoAnalyticsConfigurationResponse')) } @@ -212,7 +212,7 @@ export class ONVIFMedia { * 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. */ static AddMetadataConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddMetadataConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddMetadataConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddMetadataConfigurationResponse')) } @@ -221,7 +221,7 @@ export class ONVIFMedia { * 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. */ static RemoveMetadataConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveMetadataConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveMetadataConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveMetadataConfigurationResponse')) } @@ -230,7 +230,7 @@ export class ONVIFMedia { * 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. */ static AddAudioOutputConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioOutputConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioOutputConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddAudioOutputConfigurationResponse')) } @@ -239,7 +239,7 @@ export class ONVIFMedia { * 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. */ static RemoveAudioOutputConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioOutputConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioOutputConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveAudioOutputConfigurationResponse')) } @@ -248,7 +248,7 @@ export class ONVIFMedia { * 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. */ static AddAudioDecoderConfiguration(ProfileToken: ReferenceToken, ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioDecoderConfiguration')(['ProfileToken','ConfigurationToken'])(ProfileToken,ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:AddAudioDecoderConfiguration')({ProfileToken,ConfigurationToken})) .map(mapResponseXmlToJson('trt:AddAudioDecoderConfigurationResponse')) } @@ -257,7 +257,7 @@ export class ONVIFMedia { * 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. */ static RemoveAudioDecoderConfiguration(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioDecoderConfiguration')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:RemoveAudioDecoderConfiguration')({ProfileToken})) .map(mapResponseXmlToJson('trt:RemoveAudioDecoderConfigurationResponse')) } @@ -266,7 +266,7 @@ export class ONVIFMedia { * This operation deletes a profile. This change shall always be persistent. Deletion of a profile is only possible for non-fixed profiles */ static DeleteProfile(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:DeleteProfile')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:DeleteProfile')({ProfileToken})) .map(mapResponseXmlToJson('trt:DeleteProfileResponse')) } @@ -275,7 +275,7 @@ export class ONVIFMedia { * 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. */ static GetVideoSourceConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceConfigurations')({})) .map(mapResponseXmlToJson('trt:GetVideoSourceConfigurationsResponse')) } @@ -284,7 +284,7 @@ export class ONVIFMedia { * 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. */ static GetVideoEncoderConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoEncoderConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoEncoderConfigurations')({})) .map(mapResponseXmlToJson('trt:GetVideoEncoderConfigurationsResponse')) } @@ -293,7 +293,7 @@ export class ONVIFMedia { * 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. */ static GetAudioSourceConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSourceConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSourceConfigurations')({})) .map(mapResponseXmlToJson('trt:GetAudioSourceConfigurationsResponse')) } @@ -302,7 +302,7 @@ export class ONVIFMedia { * 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. */ static GetAudioEncoderConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioEncoderConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioEncoderConfigurations')({})) .map(mapResponseXmlToJson('trt:GetAudioEncoderConfigurationsResponse')) } @@ -311,7 +311,7 @@ export class ONVIFMedia { * 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. */ static GetVideoAnalyticsConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoAnalyticsConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoAnalyticsConfigurations')({})) .map(mapResponseXmlToJson('trt:GetVideoAnalyticsConfigurationsResponse')) } @@ -320,7 +320,7 @@ export class ONVIFMedia { * This operation lists all existing metadata configurations. The client need not know anything apriori about the metadata in order to use the command. */ static GetMetadataConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetMetadataConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetMetadataConfigurations')({})) .map(mapResponseXmlToJson('trt:GetMetadataConfigurationsResponse')) } @@ -329,7 +329,7 @@ export class ONVIFMedia { * This command lists all existing AudioOutputConfigurations of a device. The NVC need not know anything apriori about the audio configurations to use this command. */ static GetAudioOutputConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputConfigurations')({})) .map(mapResponseXmlToJson('trt:GetAudioOutputConfigurationsResponse')) } @@ -339,7 +339,7 @@ export class ONVIFMedia { * use this command. */ static GetAudioDecoderConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioDecoderConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioDecoderConfigurations')({})) .map(mapResponseXmlToJson('trt:GetAudioDecoderConfigurationsResponse')) } @@ -348,7 +348,7 @@ export class ONVIFMedia { * If the video source configuration token is already known, the video source configuration can be fetched through the GetVideoSourceConfiguration command. */ static GetVideoSourceConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetVideoSourceConfigurationResponse')) } @@ -357,7 +357,7 @@ export class ONVIFMedia { * If the video encoder configuration token is already known, the encoder configuration can be fetched through the GetVideoEncoderConfiguration command. */ static GetVideoEncoderConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoEncoderConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoEncoderConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetVideoEncoderConfigurationResponse')) } @@ -366,7 +366,7 @@ export class ONVIFMedia { * The GetAudioSourceConfiguration command fetches the audio source configurations if the audio source configuration token is already known. An */ static GetAudioSourceConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSourceConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSourceConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetAudioSourceConfigurationResponse')) } @@ -375,7 +375,7 @@ export class ONVIFMedia { * The GetAudioEncoderConfiguration command fetches the encoder configuration if the audio encoder configuration token is known. */ static GetAudioEncoderConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioEncoderConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioEncoderConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetAudioEncoderConfigurationResponse')) } @@ -384,7 +384,7 @@ export class ONVIFMedia { * The GetVideoAnalyticsConfiguration command fetches the video analytics configuration if the video analytics token is known. */ static GetVideoAnalyticsConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoAnalyticsConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoAnalyticsConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetVideoAnalyticsConfigurationResponse')) } @@ -393,7 +393,7 @@ export class ONVIFMedia { * The GetMetadataConfiguration command fetches the metadata configuration if the metadata token is known. */ static GetMetadataConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetMetadataConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetMetadataConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetMetadataConfigurationResponse')) } @@ -402,7 +402,7 @@ export class ONVIFMedia { * If the audio output configuration token is already known, the output configuration can be fetched through the GetAudioOutputConfiguration command. */ static GetAudioOutputConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetAudioOutputConfigurationResponse')) } @@ -411,7 +411,7 @@ export class ONVIFMedia { * If the audio decoder configuration token is already known, the decoder configuration can be fetched through the GetAudioDecoderConfiguration command. */ static GetAudioDecoderConfiguration(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioDecoderConfiguration')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioDecoderConfiguration')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetAudioDecoderConfigurationResponse')) } @@ -420,7 +420,7 @@ export class ONVIFMedia { * 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. */ static GetCompatibleVideoEncoderConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleVideoEncoderConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleVideoEncoderConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleVideoEncoderConfigurationsResponse')) } @@ -432,7 +432,7 @@ export class ONVIFMedia { * will vary depending on the capabilities, configurations and settings in the device. */ static GetCompatibleVideoSourceConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleVideoSourceConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleVideoSourceConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleVideoSourceConfigurationsResponse')) } @@ -441,7 +441,7 @@ export class ONVIFMedia { * 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. */ static GetCompatibleAudioEncoderConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioEncoderConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioEncoderConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleAudioEncoderConfigurationsResponse')) } @@ -450,7 +450,7 @@ export class ONVIFMedia { * 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. */ static GetCompatibleAudioSourceConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioSourceConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioSourceConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleAudioSourceConfigurationsResponse')) } @@ -459,7 +459,7 @@ export class ONVIFMedia { * 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. */ static GetCompatibleVideoAnalyticsConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleVideoAnalyticsConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleVideoAnalyticsConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleVideoAnalyticsConfigurationsResponse')) } @@ -468,7 +468,7 @@ export class ONVIFMedia { * 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. */ static GetCompatibleMetadataConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleMetadataConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleMetadataConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleMetadataConfigurationsResponse')) } @@ -478,7 +478,7 @@ export class ONVIFMedia { * AddAudioOutputConfiguration command. */ static GetCompatibleAudioOutputConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioOutputConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioOutputConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleAudioOutputConfigurationsResponse')) } @@ -487,7 +487,7 @@ export class ONVIFMedia { * 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. */ static GetCompatibleAudioDecoderConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioDecoderConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetCompatibleAudioDecoderConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetCompatibleAudioDecoderConfigurationsResponse')) } @@ -496,7 +496,7 @@ export class ONVIFMedia { * 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. */ static SetVideoSourceConfiguration(Configuration: VideoSourceConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoSourceConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoSourceConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetVideoSourceConfigurationResponse')) } @@ -505,7 +505,7 @@ export class ONVIFMedia { * 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. */ static SetVideoEncoderConfiguration(Configuration: VideoEncoderConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoEncoderConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoEncoderConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetVideoEncoderConfigurationResponse')) } @@ -518,7 +518,7 @@ export class ONVIFMedia { * NVC methods for changing a running stream are out of scope for this specification. */ static SetAudioSourceConfiguration(Configuration: AudioSourceConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioSourceConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioSourceConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetAudioSourceConfigurationResponse')) } @@ -531,7 +531,7 @@ export class ONVIFMedia { * running stream are out of scope for this specification. */ static SetAudioEncoderConfiguration(Configuration: AudioEncoderConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioEncoderConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioEncoderConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetAudioEncoderConfigurationResponse')) } @@ -545,7 +545,7 @@ export class ONVIFMedia { * video analytics configuration token. */ static SetVideoAnalyticsConfiguration(Configuration: VideoAnalyticsConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoAnalyticsConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoAnalyticsConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetVideoAnalyticsConfigurationResponse')) } @@ -559,7 +559,7 @@ export class ONVIFMedia { * running stream are out of scope for this specification. */ static SetMetadataConfiguration(Configuration: MetadataConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetMetadataConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetMetadataConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetMetadataConfigurationResponse')) } @@ -569,7 +569,7 @@ export class ONVIFMedia { * the changes shall remain after reboot of the device. */ static SetAudioOutputConfiguration(Configuration: AudioOutputConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioOutputConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioOutputConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetAudioOutputConfigurationResponse')) } @@ -579,7 +579,7 @@ export class ONVIFMedia { * the changes shall remain after reboot of the device. */ static SetAudioDecoderConfiguration(Configuration: AudioDecoderConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioDecoderConfiguration')(['Configuration','ForcePersistence'])(Configuration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetAudioDecoderConfiguration')({Configuration,ForcePersistence})) .map(mapResponseXmlToJson('trt:SetAudioDecoderConfigurationResponse')) } @@ -591,7 +591,7 @@ export class ONVIFMedia { * that media profile. */ static GetVideoSourceConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetVideoSourceConfigurationOptionsResponse')) } @@ -607,7 +607,7 @@ export class ONVIFMedia { * */ static GetVideoEncoderConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoEncoderConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoEncoderConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetVideoEncoderConfigurationOptionsResponse')) } @@ -619,7 +619,7 @@ export class ONVIFMedia { * that media profile. */ static GetAudioSourceConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSourceConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioSourceConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetAudioSourceConfigurationOptionsResponse')) } @@ -629,7 +629,7 @@ export class ONVIFMedia { * reconfigured. */ static GetAudioEncoderConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioEncoderConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioEncoderConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetAudioEncoderConfigurationOptionsResponse')) } @@ -638,7 +638,7 @@ export class ONVIFMedia { * This operation returns the available options (supported values and ranges for metadata configuration parameters) for changing the metadata configuration. */ static GetMetadataConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetMetadataConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetMetadataConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetMetadataConfigurationOptionsResponse')) } @@ -647,7 +647,7 @@ export class ONVIFMedia { * This operation returns the available options (supported values and ranges for audio output configuration parameters) for configuring an audio output. */ static GetAudioOutputConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioOutputConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetAudioOutputConfigurationOptionsResponse')) } @@ -657,7 +657,7 @@ export class ONVIFMedia { * device. */ static GetAudioDecoderConfigurationOptions(ConfigurationToken?: ReferenceToken, ProfileToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioDecoderConfigurationOptions')(['ConfigurationToken','ProfileToken'])(ConfigurationToken,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetAudioDecoderConfigurationOptions')({ConfigurationToken,ProfileToken})) .map(mapResponseXmlToJson('trt:GetAudioDecoderConfigurationOptionsResponse')) } @@ -668,7 +668,7 @@ export class ONVIFMedia { * Configuration. */ static GetGuaranteedNumberOfVideoEncoderInstances(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetGuaranteedNumberOfVideoEncoderInstances')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetGuaranteedNumberOfVideoEncoderInstances')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetGuaranteedNumberOfVideoEncoderInstancesResponse')) } @@ -691,7 +691,7 @@ export class ONVIFMedia { * 128 octets. */ static GetStreamUri(StreamSetup: StreamSetup, ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetStreamUri')(['StreamSetup','ProfileToken'])(StreamSetup,ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetStreamUri')({StreamSetup,ProfileToken})) .map(mapResponseXmlToJson('trt:GetStreamUriResponse')) } @@ -705,7 +705,7 @@ export class ONVIFMedia { * respectively. */ static StartMulticastStreaming(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:StartMulticastStreaming')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:StartMulticastStreaming')({ProfileToken})) .map(mapResponseXmlToJson('trt:StartMulticastStreamingResponse')) } @@ -714,7 +714,7 @@ export class ONVIFMedia { * This command stop multicast streaming using a specified media profile of a device */ static StopMulticastStreaming(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:StopMulticastStreaming')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:StopMulticastStreaming')({ProfileToken})) .map(mapResponseXmlToJson('trt:StopMulticastStreamingResponse')) } @@ -733,7 +733,7 @@ export class ONVIFMedia { * the PTZ position shall be repeated within the metadata stream. */ static SetSynchronizationPoint(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetSynchronizationPoint')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetSynchronizationPoint')({ProfileToken})) .map(mapResponseXmlToJson('trt:SetSynchronizationPointResponse')) } @@ -749,7 +749,7 @@ export class ONVIFMedia { * image will be updated automatically and independent from calls to GetSnapshotUri. */ static GetSnapshotUri(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetSnapshotUri')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetSnapshotUri')({ProfileToken})) .map(mapResponseXmlToJson('trt:GetSnapshotUriResponse')) } @@ -758,7 +758,7 @@ export class ONVIFMedia { * 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. */ static GetVideoSourceModes(VideoSourceToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceModes')(['VideoSourceToken'])(VideoSourceToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetVideoSourceModes')({VideoSourceToken})) .map(mapResponseXmlToJson('trt:GetVideoSourceModesResponse')) } @@ -767,7 +767,7 @@ export class ONVIFMedia { * 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. */ static SetVideoSourceMode(VideoSourceToken: ReferenceToken, VideoSourceModeToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoSourceMode')(['VideoSourceToken','VideoSourceModeToken'])(VideoSourceToken,VideoSourceModeToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetVideoSourceMode')({VideoSourceToken,VideoSourceModeToken})) .map(mapResponseXmlToJson('trt:SetVideoSourceModeResponse')) } @@ -776,7 +776,7 @@ export class ONVIFMedia { * Get the OSDs. */ static GetOSDs(ConfigurationToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetOSDs')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetOSDs')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetOSDsResponse')) } @@ -785,7 +785,7 @@ export class ONVIFMedia { * Get the OSD. */ static GetOSD(OSDToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetOSD')(['OSDToken'])(OSDToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetOSD')({OSDToken})) .map(mapResponseXmlToJson('trt:GetOSDResponse')) } @@ -794,7 +794,7 @@ export class ONVIFMedia { * Get the OSD Options. */ static GetOSDOptions(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:GetOSDOptions')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:GetOSDOptions')({ConfigurationToken})) .map(mapResponseXmlToJson('trt:GetOSDOptionsResponse')) } @@ -803,7 +803,7 @@ export class ONVIFMedia { * Set the OSD */ static SetOSD(OSD: OSDConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trt:SetOSD')(['OSD'])(OSD)) + return createStandardRequestBodyFromString(generateRequestElements('trt:SetOSD')({OSD})) .map(mapResponseXmlToJson('trt:SetOSDResponse')) } @@ -812,7 +812,7 @@ export class ONVIFMedia { * Create the OSD. */ static CreateOSD(OSD: OSDConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trt:CreateOSD')(['OSD'])(OSD)) + return createStandardRequestBodyFromString(generateRequestElements('trt:CreateOSD')({OSD})) .map(mapResponseXmlToJson('trt:CreateOSDResponse')) } @@ -821,7 +821,7 @@ export class ONVIFMedia { * Delete the OSD. */ static DeleteOSD(OSDToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trt:DeleteOSD')(['OSDToken'])(OSDToken)) + return createStandardRequestBodyFromString(generateRequestElements('trt:DeleteOSD')({OSDToken})) .map(mapResponseXmlToJson('trt:DeleteOSDResponse')) } diff --git a/src/api/provisioning.ts b/src/api/provisioning.ts index 7be073e..3c96a10 100644 --- a/src/api/provisioning.ts +++ b/src/api/provisioning.ts @@ -10,7 +10,7 @@ export class ONVIFProvisioning { * Returns the capabilities of the provisioning service. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tpv:GetServiceCapabilitiesResponse')) } @@ -19,7 +19,7 @@ export class ONVIFProvisioning { * Moves device on the pan axis. */ static PanMove() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:PanMove')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:PanMove')({})) .map(mapResponseXmlToJson('tpv:PanMoveResponse')) } @@ -28,7 +28,7 @@ export class ONVIFProvisioning { * Moves device on the tilt axis. */ static TiltMove() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:TiltMove')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:TiltMove')({})) .map(mapResponseXmlToJson('tpv:TiltMoveResponse')) } @@ -37,7 +37,7 @@ export class ONVIFProvisioning { * Moves device on the zoom axis. */ static ZoomMove() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:ZoomMove')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:ZoomMove')({})) .map(mapResponseXmlToJson('tpv:ZoomMoveResponse')) } @@ -46,7 +46,7 @@ export class ONVIFProvisioning { * Moves device on the roll axis. */ static RollMove() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:RollMove')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:RollMove')({})) .map(mapResponseXmlToJson('tpv:RollMoveResponse')) } @@ -55,7 +55,7 @@ export class ONVIFProvisioning { * Moves device on the focus axis. */ static FocusMove() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:FocusMove')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:FocusMove')({})) .map(mapResponseXmlToJson('tpv:FocusMoveResponse')) } @@ -64,7 +64,7 @@ export class ONVIFProvisioning { * Stops device motion on all axes. */ static Stop() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:Stop')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:Stop')({})) .map(mapResponseXmlToJson('tpv:StopResponse')) } @@ -73,7 +73,7 @@ export class ONVIFProvisioning { * Returns the lifetime move counts. */ static GetUsage() { - return createStandardRequestBodyFromString(generateRequestElements('tpv:GetUsage')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tpv:GetUsage')({})) .map(mapResponseXmlToJson('tpv:GetUsageResponse')) } diff --git a/src/api/ptz.ts b/src/api/ptz.ts index 3db1251..6f12492 100644 --- a/src/api/ptz.ts +++ b/src/api/ptz.ts @@ -10,7 +10,7 @@ export class ONVIFPTZ { * Returns the capabilities of the PTZ service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tptz:GetServiceCapabilitiesResponse')) } @@ -26,7 +26,7 @@ export class ONVIFPTZ { * */ static GetNodes() { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetNodes')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetNodes')({})) .map(mapResponseXmlToJson('tptz:GetNodesResponse')) } @@ -37,7 +37,7 @@ export class ONVIFPTZ { * */ static GetNode(NodeToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetNode')(['NodeToken'])(NodeToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetNode')({NodeToken})) .map(mapResponseXmlToJson('tptz:GetNodeResponse')) } @@ -62,7 +62,7 @@ export class ONVIFPTZ { * */ static GetConfiguration(PTZConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetConfiguration')(['PTZConfigurationToken'])(PTZConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetConfiguration')({PTZConfigurationToken})) .map(mapResponseXmlToJson('tptz:GetConfigurationResponse')) } @@ -88,7 +88,7 @@ export class ONVIFPTZ { * */ static GetConfigurations() { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetConfigurations')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetConfigurations')({})) .map(mapResponseXmlToJson('tptz:GetConfigurationsResponse')) } @@ -99,7 +99,7 @@ export class ONVIFPTZ { * */ static SetConfiguration(PTZConfiguration: PTZConfiguration, ForcePersistence: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:SetConfiguration')(['PTZConfiguration','ForcePersistence'])(PTZConfiguration,ForcePersistence)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:SetConfiguration')({PTZConfiguration,ForcePersistence})) .map(mapResponseXmlToJson('tptz:SetConfigurationResponse')) } @@ -115,7 +115,7 @@ export class ONVIFPTZ { * */ static GetConfigurationOptions(ConfigurationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetConfigurationOptions')(['ConfigurationToken'])(ConfigurationToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetConfigurationOptions')({ConfigurationToken})) .map(mapResponseXmlToJson('tptz:GetConfigurationOptionsResponse')) } @@ -129,7 +129,7 @@ export class ONVIFPTZ { * */ static SendAuxiliaryCommand(ProfileToken: ReferenceToken, AuxiliaryData: AuxiliaryData) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:SendAuxiliaryCommand')(['ProfileToken','AuxiliaryData'])(ProfileToken,AuxiliaryData)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:SendAuxiliaryCommand')({ProfileToken,AuxiliaryData})) .map(mapResponseXmlToJson('tptz:SendAuxiliaryCommandResponse')) } @@ -141,7 +141,7 @@ export class ONVIFPTZ { * for at least on PTZ preset by the PTZNode. */ static GetPresets(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresets')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresets')({ProfileToken})) .map(mapResponseXmlToJson('tptz:GetPresetsResponse')) } @@ -159,7 +159,7 @@ export class ONVIFPTZ { * Preset which then should be recalled in the GotoPreset operation. */ static SetPreset(ProfileToken: ReferenceToken, PresetName?: string, PresetToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:SetPreset')(['ProfileToken','PresetName','PresetToken'])(ProfileToken,PresetName,PresetToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:SetPreset')({ProfileToken,PresetName,PresetToken})) .map(mapResponseXmlToJson('tptz:SetPresetResponse')) } @@ -175,7 +175,7 @@ export class ONVIFPTZ { * */ static RemovePreset(ProfileToken: ReferenceToken, PresetToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:RemovePreset')(['ProfileToken','PresetToken'])(ProfileToken,PresetToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:RemovePreset')({ProfileToken,PresetToken})) .map(mapResponseXmlToJson('tptz:RemovePresetResponse')) } @@ -187,7 +187,7 @@ export class ONVIFPTZ { * support for at least on PTZ preset by the PTZNode. */ static GotoPreset(ProfileToken: ReferenceToken, PresetToken: ReferenceToken, Speed?: PTZSpeed) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GotoPreset')(['ProfileToken','PresetToken','Speed'])(ProfileToken,PresetToken,Speed)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GotoPreset')({ProfileToken,PresetToken,Speed})) .map(mapResponseXmlToJson('tptz:GotoPresetResponse')) } @@ -197,7 +197,7 @@ export class ONVIFPTZ { * Operation to move the PTZ device to it's "home" position. The operation is supported if the HomeSupported element in the PTZNode is true. */ static GotoHomePosition(ProfileToken: ReferenceToken, Speed?: PTZSpeed) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GotoHomePosition')(['ProfileToken','Speed'])(ProfileToken,Speed)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GotoHomePosition')({ProfileToken,Speed})) .map(mapResponseXmlToJson('tptz:GotoHomePositionResponse')) } @@ -209,7 +209,7 @@ export class ONVIFPTZ { * Home Position with the GotoHomePosition command. */ static SetHomePosition(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:SetHomePosition')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:SetHomePosition')({ProfileToken})) .map(mapResponseXmlToJson('tptz:SetHomePositionResponse')) } @@ -218,7 +218,7 @@ export class ONVIFPTZ { * 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. */ static ContinuousMove(ProfileToken: ReferenceToken, Velocity: PTZSpeed, Timeout?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:ContinuousMove')(['ProfileToken','Velocity','Timeout'])(ProfileToken,Velocity,Timeout)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:ContinuousMove')({ProfileToken,Velocity,Timeout})) .map(mapResponseXmlToJson('tptz:ContinuousMoveResponse')) } @@ -231,7 +231,7 @@ export class ONVIFPTZ { * */ static RelativeMove(ProfileToken: ReferenceToken, Translation: PTZVector, Speed?: PTZSpeed) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:RelativeMove')(['ProfileToken','Translation','Speed'])(ProfileToken,Translation,Speed)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:RelativeMove')({ProfileToken,Translation,Speed})) .map(mapResponseXmlToJson('tptz:RelativeMoveResponse')) } @@ -242,7 +242,7 @@ export class ONVIFPTZ { * selected profile. */ static GetStatus(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetStatus')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetStatus')({ProfileToken})) .map(mapResponseXmlToJson('tptz:GetStatusResponse')) } @@ -255,7 +255,7 @@ export class ONVIFPTZ { * */ static AbsoluteMove(ProfileToken: ReferenceToken, Position: PTZVector, Speed?: PTZSpeed) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:AbsoluteMove')(['ProfileToken','Position','Speed'])(ProfileToken,Position,Speed)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:AbsoluteMove')({ProfileToken,Position,Speed})) .map(mapResponseXmlToJson('tptz:AbsoluteMoveResponse')) } @@ -270,7 +270,7 @@ export class ONVIFPTZ { * */ static GeoMove(ProfileToken: ReferenceToken, Target: GeoLocation, Speed?: PTZSpeed, AreaHeight?: number, AreaWidth?: number) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GeoMove')(['ProfileToken','Target','Speed','AreaHeight','AreaWidth'])(ProfileToken,Target,Speed,AreaHeight,AreaWidth)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GeoMove')({ProfileToken,Target,Speed,AreaHeight,AreaWidth})) .map(mapResponseXmlToJson('tptz:GeoMoveResponse')) } @@ -280,7 +280,7 @@ export class ONVIFPTZ { * If no stop argument for pan, tilt or zoom is set, the device will stop all ongoing pan, tilt and zoom movements. */ static Stop(ProfileToken: ReferenceToken, PanTilt?: boolean, Zoom?: boolean) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:Stop')(['ProfileToken','PanTilt','Zoom'])(ProfileToken,PanTilt,Zoom)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:Stop')({ProfileToken,PanTilt,Zoom})) .map(mapResponseXmlToJson('tptz:StopResponse')) } @@ -289,7 +289,7 @@ export class ONVIFPTZ { * Operation to request PTZ preset tours in the selected media profiles. */ static GetPresetTours(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresetTours')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresetTours')({ProfileToken})) .map(mapResponseXmlToJson('tptz:GetPresetToursResponse')) } @@ -298,7 +298,7 @@ export class ONVIFPTZ { * Operation to request a specific PTZ preset tour in the selected media profile. */ static GetPresetTour(ProfileToken: ReferenceToken, PresetTourToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresetTour')(['ProfileToken','PresetTourToken'])(ProfileToken,PresetTourToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresetTour')({ProfileToken,PresetTourToken})) .map(mapResponseXmlToJson('tptz:GetPresetTourResponse')) } @@ -307,7 +307,7 @@ export class ONVIFPTZ { * Operation to request available options to configure PTZ preset tour. */ static GetPresetTourOptions(ProfileToken: ReferenceToken, PresetTourToken?: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresetTourOptions')(['ProfileToken','PresetTourToken'])(ProfileToken,PresetTourToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetPresetTourOptions')({ProfileToken,PresetTourToken})) .map(mapResponseXmlToJson('tptz:GetPresetTourOptionsResponse')) } @@ -316,7 +316,7 @@ export class ONVIFPTZ { * Operation to create a preset tour for the selected media profile. */ static CreatePresetTour(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:CreatePresetTour')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:CreatePresetTour')({ProfileToken})) .map(mapResponseXmlToJson('tptz:CreatePresetTourResponse')) } @@ -325,7 +325,7 @@ export class ONVIFPTZ { * Operation to modify a preset tour for the selected media profile. */ static ModifyPresetTour(ProfileToken: ReferenceToken, PresetTour: PresetTour) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:ModifyPresetTour')(['ProfileToken','PresetTour'])(ProfileToken,PresetTour)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:ModifyPresetTour')({ProfileToken,PresetTour})) .map(mapResponseXmlToJson('tptz:ModifyPresetTourResponse')) } @@ -334,7 +334,7 @@ export class ONVIFPTZ { * Operation to perform specific operation on the preset tour in selected media profile. */ static OperatePresetTour(ProfileToken: ReferenceToken, PresetTourToken: ReferenceToken, Operation: PTZPresetTourOperation) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:OperatePresetTour')(['ProfileToken','PresetTourToken','Operation'])(ProfileToken,PresetTourToken,Operation)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:OperatePresetTour')({ProfileToken,PresetTourToken,Operation})) .map(mapResponseXmlToJson('tptz:OperatePresetTourResponse')) } @@ -343,7 +343,7 @@ export class ONVIFPTZ { * Operation to delete a specific preset tour from the media profile. */ static RemovePresetTour(ProfileToken: ReferenceToken, PresetTourToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:RemovePresetTour')(['ProfileToken','PresetTourToken'])(ProfileToken,PresetTourToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:RemovePresetTour')({ProfileToken,PresetTourToken})) .map(mapResponseXmlToJson('tptz:RemovePresetTourResponse')) } @@ -356,7 +356,7 @@ export class ONVIFPTZ { * */ static GetCompatibleConfigurations(ProfileToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('tptz:GetCompatibleConfigurations')(['ProfileToken'])(ProfileToken)) + return createStandardRequestBodyFromString(generateRequestElements('tptz:GetCompatibleConfigurations')({ProfileToken})) .map(mapResponseXmlToJson('tptz:GetCompatibleConfigurationsResponse')) } diff --git a/src/api/receiver.ts b/src/api/receiver.ts index 06f6976..56dcb65 100644 --- a/src/api/receiver.ts +++ b/src/api/receiver.ts @@ -10,7 +10,7 @@ export class ONVIFReceiver { * Returns the capabilities of the receiver service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('trv:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trv:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('trv:GetServiceCapabilitiesResponse')) } @@ -21,7 +21,7 @@ export class ONVIFReceiver { * */ static GetReceivers() { - return createStandardRequestBodyFromString(generateRequestElements('trv:GetReceivers')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trv:GetReceivers')({})) .map(mapResponseXmlToJson('trv:GetReceiversResponse')) } @@ -32,7 +32,7 @@ export class ONVIFReceiver { * */ static GetReceiver(ReceiverToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trv:GetReceiver')(['ReceiverToken'])(ReceiverToken)) + return createStandardRequestBodyFromString(generateRequestElements('trv:GetReceiver')({ReceiverToken})) .map(mapResponseXmlToJson('trv:GetReceiverResponse')) } @@ -44,7 +44,7 @@ export class ONVIFReceiver { * */ static CreateReceiver(Configuration: ReceiverConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trv:CreateReceiver')(['Configuration'])(Configuration)) + return createStandardRequestBodyFromString(generateRequestElements('trv:CreateReceiver')({Configuration})) .map(mapResponseXmlToJson('trv:CreateReceiverResponse')) } @@ -57,7 +57,7 @@ export class ONVIFReceiver { * */ static DeleteReceiver(ReceiverToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trv:DeleteReceiver')(['ReceiverToken'])(ReceiverToken)) + return createStandardRequestBodyFromString(generateRequestElements('trv:DeleteReceiver')({ReceiverToken})) .map(mapResponseXmlToJson('trv:DeleteReceiverResponse')) } @@ -68,7 +68,7 @@ export class ONVIFReceiver { * */ static ConfigureReceiver(ReceiverToken: ReferenceToken, Configuration: ReceiverConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trv:ConfigureReceiver')(['ReceiverToken','Configuration'])(ReceiverToken,Configuration)) + return createStandardRequestBodyFromString(generateRequestElements('trv:ConfigureReceiver')({ReceiverToken,Configuration})) .map(mapResponseXmlToJson('trv:ConfigureReceiverResponse')) } @@ -80,7 +80,7 @@ export class ONVIFReceiver { * */ static SetReceiverMode(ReceiverToken: ReferenceToken, Mode: ReceiverMode) { - return createStandardRequestBodyFromString(generateRequestElements('trv:SetReceiverMode')(['ReceiverToken','Mode'])(ReceiverToken,Mode)) + return createStandardRequestBodyFromString(generateRequestElements('trv:SetReceiverMode')({ReceiverToken,Mode})) .map(mapResponseXmlToJson('trv:SetReceiverModeResponse')) } @@ -93,7 +93,7 @@ export class ONVIFReceiver { * */ static GetReceiverState(ReceiverToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trv:GetReceiverState')(['ReceiverToken'])(ReceiverToken)) + return createStandardRequestBodyFromString(generateRequestElements('trv:GetReceiverState')({ReceiverToken})) .map(mapResponseXmlToJson('trv:GetReceiverStateResponse')) } diff --git a/src/api/recording.ts b/src/api/recording.ts index 079397b..cfe81a0 100644 --- a/src/api/recording.ts +++ b/src/api/recording.ts @@ -10,7 +10,7 @@ export class ONVIFRecording { * Returns the capabilities of the recording service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('trc:GetServiceCapabilitiesResponse')) } @@ -34,7 +34,7 @@ export class ONVIFRecording { * */ static CreateRecording(RecordingConfiguration: RecordingConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trc:CreateRecording')(['RecordingConfiguration'])(RecordingConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('trc:CreateRecording')({RecordingConfiguration})) .map(mapResponseXmlToJson('trc:CreateRecordingResponse')) } @@ -50,7 +50,7 @@ export class ONVIFRecording { * */ static DeleteRecording(RecordingToken: RecordingReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:DeleteRecording')(['RecordingToken'])(RecordingToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:DeleteRecording')({RecordingToken})) .map(mapResponseXmlToJson('trc:DeleteRecordingResponse')) } @@ -60,7 +60,7 @@ export class ONVIFRecording { * shall include a list of all the tracks for each recording. */ static GetRecordings() { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordings')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordings')({})) .map(mapResponseXmlToJson('trc:GetRecordingsResponse')) } @@ -69,7 +69,7 @@ export class ONVIFRecording { * SetRecordingConfiguration shall change the configuration of a recording. */ static SetRecordingConfiguration(RecordingToken: RecordingReference, RecordingConfiguration: RecordingConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trc:SetRecordingConfiguration')(['RecordingToken','RecordingConfiguration'])(RecordingToken,RecordingConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('trc:SetRecordingConfiguration')({RecordingToken,RecordingConfiguration})) .map(mapResponseXmlToJson('trc:SetRecordingConfigurationResponse')) } @@ -78,7 +78,7 @@ export class ONVIFRecording { * GetRecordingConfiguration shall retrieve the recording configuration for a recording. */ static GetRecordingConfiguration(RecordingToken: RecordingReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingConfiguration')(['RecordingToken'])(RecordingToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingConfiguration')({RecordingToken})) .map(mapResponseXmlToJson('trc:GetRecordingConfigurationResponse')) } @@ -87,7 +87,7 @@ export class ONVIFRecording { * GetRecordingOptions returns information for a recording identified by the RecordingToken. The information includes the number of additonal tracks as well as recording jobs that can be configured. */ static GetRecordingOptions(RecordingToken: RecordingReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingOptions')(['RecordingToken'])(RecordingToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingOptions')({RecordingToken})) .map(mapResponseXmlToJson('trc:GetRecordingOptionsResponse')) } @@ -100,7 +100,7 @@ export class ONVIFRecording { * */ static CreateTrack(RecordingToken: RecordingReference, TrackConfiguration: TrackConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trc:CreateTrack')(['RecordingToken','TrackConfiguration'])(RecordingToken,TrackConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('trc:CreateTrack')({RecordingToken,TrackConfiguration})) .map(mapResponseXmlToJson('trc:CreateTrackResponse')) } @@ -111,7 +111,7 @@ export class ONVIFRecording { * TRUE. */ static DeleteTrack(RecordingToken: RecordingReference, TrackToken: TrackReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:DeleteTrack')(['RecordingToken','TrackToken'])(RecordingToken,TrackToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:DeleteTrack')({RecordingToken,TrackToken})) .map(mapResponseXmlToJson('trc:DeleteTrackResponse')) } @@ -120,7 +120,7 @@ export class ONVIFRecording { * GetTrackConfiguration shall retrieve the configuration for a specific track. */ static GetTrackConfiguration(RecordingToken: RecordingReference, TrackToken: TrackReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetTrackConfiguration')(['RecordingToken','TrackToken'])(RecordingToken,TrackToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetTrackConfiguration')({RecordingToken,TrackToken})) .map(mapResponseXmlToJson('trc:GetTrackConfigurationResponse')) } @@ -129,7 +129,7 @@ export class ONVIFRecording { * SetTrackConfiguration shall change the configuration of a track. */ static SetTrackConfiguration(RecordingToken: RecordingReference, TrackToken: TrackReference, TrackConfiguration: TrackConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trc:SetTrackConfiguration')(['RecordingToken','TrackToken','TrackConfiguration'])(RecordingToken,TrackToken,TrackConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('trc:SetTrackConfiguration')({RecordingToken,TrackToken,TrackConfiguration})) .map(mapResponseXmlToJson('trc:SetTrackConfigurationResponse')) } @@ -143,7 +143,7 @@ export class ONVIFRecording { * */ static CreateRecordingJob(JobConfiguration: RecordingJobConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trc:CreateRecordingJob')(['JobConfiguration'])(JobConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('trc:CreateRecordingJob')({JobConfiguration})) .map(mapResponseXmlToJson('trc:CreateRecordingJobResponse')) } @@ -155,7 +155,7 @@ export class ONVIFRecording { * other recording job. */ static DeleteRecordingJob(JobToken: RecordingJobReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:DeleteRecordingJob')(['JobToken'])(JobToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:DeleteRecordingJob')({JobToken})) .map(mapResponseXmlToJson('trc:DeleteRecordingJobResponse')) } @@ -164,7 +164,7 @@ export class ONVIFRecording { * GetRecordingJobs shall return a list of all the recording jobs in the device. */ static GetRecordingJobs() { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingJobs')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingJobs')({})) .map(mapResponseXmlToJson('trc:GetRecordingJobsResponse')) } @@ -176,7 +176,7 @@ export class ONVIFRecording { * */ static SetRecordingJobConfiguration(JobToken: RecordingJobReference, JobConfiguration: RecordingJobConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trc:SetRecordingJobConfiguration')(['JobToken','JobConfiguration'])(JobToken,JobConfiguration)) + return createStandardRequestBodyFromString(generateRequestElements('trc:SetRecordingJobConfiguration')({JobToken,JobConfiguration})) .map(mapResponseXmlToJson('trc:SetRecordingJobConfigurationResponse')) } @@ -185,7 +185,7 @@ export class ONVIFRecording { * GetRecordingJobConfiguration shall return the current configuration for a recording job. */ static GetRecordingJobConfiguration(JobToken: RecordingJobReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingJobConfiguration')(['JobToken'])(JobToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingJobConfiguration')({JobToken})) .map(mapResponseXmlToJson('trc:GetRecordingJobConfigurationResponse')) } @@ -196,7 +196,7 @@ export class ONVIFRecording { * mode. */ static SetRecordingJobMode(JobToken: RecordingJobReference, Mode: RecordingJobMode) { - return createStandardRequestBodyFromString(generateRequestElements('trc:SetRecordingJobMode')(['JobToken','Mode'])(JobToken,Mode)) + return createStandardRequestBodyFromString(generateRequestElements('trc:SetRecordingJobMode')({JobToken,Mode})) .map(mapResponseXmlToJson('trc:SetRecordingJobModeResponse')) } @@ -206,7 +206,7 @@ export class ONVIFRecording { * and state for each track of the recording job. */ static GetRecordingJobState(JobToken: RecordingJobReference) { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingJobState')(['JobToken'])(JobToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetRecordingJobState')({JobToken})) .map(mapResponseXmlToJson('trc:GetRecordingJobStateResponse')) } @@ -217,7 +217,7 @@ export class ONVIFRecording { * */ static ExportRecordedData(SearchScope: SearchScope, FileFormat: string, StorageDestination: StorageReferencePath, StartPoint?: string, EndPoint?: string) { - return createStandardRequestBodyFromString(generateRequestElements('trc:ExportRecordedData')(['SearchScope','FileFormat','StorageDestination','StartPoint','EndPoint'])(SearchScope,FileFormat,StorageDestination,StartPoint,EndPoint)) + return createStandardRequestBodyFromString(generateRequestElements('trc:ExportRecordedData')({SearchScope,FileFormat,StorageDestination,StartPoint,EndPoint})) .map(mapResponseXmlToJson('trc:ExportRecordedDataResponse')) } @@ -228,7 +228,7 @@ export class ONVIFRecording { * */ static StopExportRecordedData(OperationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trc:StopExportRecordedData')(['OperationToken'])(OperationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:StopExportRecordedData')({OperationToken})) .map(mapResponseXmlToJson('trc:StopExportRecordedDataResponse')) } @@ -239,7 +239,7 @@ export class ONVIFRecording { * */ static GetExportRecordedDataState(OperationToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trc:GetExportRecordedDataState')(['OperationToken'])(OperationToken)) + return createStandardRequestBodyFromString(generateRequestElements('trc:GetExportRecordedDataState')({OperationToken})) .map(mapResponseXmlToJson('trc:GetExportRecordedDataStateResponse')) } diff --git a/src/api/replay.ts b/src/api/replay.ts index fdee9bc..20b7bdb 100644 --- a/src/api/replay.ts +++ b/src/api/replay.ts @@ -10,7 +10,7 @@ export class ONVIFReplay { * Returns the capabilities of the replay service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('trp:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trp:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('trp:GetServiceCapabilitiesResponse')) } @@ -24,7 +24,7 @@ export class ONVIFReplay { * */ static GetReplayUri(StreamSetup: StreamSetup, RecordingToken: ReferenceToken) { - return createStandardRequestBodyFromString(generateRequestElements('trp:GetReplayUri')(['StreamSetup','RecordingToken'])(StreamSetup,RecordingToken)) + return createStandardRequestBodyFromString(generateRequestElements('trp:GetReplayUri')({StreamSetup,RecordingToken})) .map(mapResponseXmlToJson('trp:GetReplayUriResponse')) } @@ -36,7 +36,7 @@ export class ONVIFReplay { * */ static GetReplayConfiguration() { - return createStandardRequestBodyFromString(generateRequestElements('trp:GetReplayConfiguration')([])()) + return createStandardRequestBodyFromString(generateRequestElements('trp:GetReplayConfiguration')({})) .map(mapResponseXmlToJson('trp:GetReplayConfigurationResponse')) } @@ -48,7 +48,7 @@ export class ONVIFReplay { * */ static SetReplayConfiguration(Configuration: ReplayConfiguration) { - return createStandardRequestBodyFromString(generateRequestElements('trp:SetReplayConfiguration')(['Configuration'])(Configuration)) + return createStandardRequestBodyFromString(generateRequestElements('trp:SetReplayConfiguration')({Configuration})) .map(mapResponseXmlToJson('trp:SetReplayConfigurationResponse')) } diff --git a/src/api/search.ts b/src/api/search.ts index adbfd54..5ddc784 100644 --- a/src/api/search.ts +++ b/src/api/search.ts @@ -10,7 +10,7 @@ export class ONVIFSearch { * Returns the capabilities of the search service. The result is returned in a typed answer. */ static GetServiceCapabilities() { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetServiceCapabilities')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetServiceCapabilities')({})) .map(mapResponseXmlToJson('tse:GetServiceCapabilitiesResponse')) } @@ -20,7 +20,7 @@ export class ONVIFSearch { * operation is mandatory to support for a device implementing the recording search service. */ static GetRecordingSummary() { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetRecordingSummary')([])()) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetRecordingSummary')({})) .map(mapResponseXmlToJson('tse:GetRecordingSummaryResponse')) } @@ -30,7 +30,7 @@ export class ONVIFSearch { * is mandatory to support for a device implementing the recording search service. */ static GetRecordingInformation(RecordingToken: RecordingReference) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetRecordingInformation')(['RecordingToken'])(RecordingToken)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetRecordingInformation')({RecordingToken})) .map(mapResponseXmlToJson('tse:GetRecordingInformationResponse')) } @@ -44,7 +44,7 @@ export class ONVIFSearch { * recording search service. */ static GetMediaAttributes(Time: string, RecordingTokens?: RecordingReference) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetMediaAttributes')(['Time','RecordingTokens'])(Time,RecordingTokens)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetMediaAttributes')({Time,RecordingTokens})) .map(mapResponseXmlToJson('tse:GetMediaAttributesResponse')) } @@ -65,7 +65,7 @@ export class ONVIFSearch { * search service. */ static FindRecordings(Scope: SearchScope, KeepAliveTime: string, MaxMatches?: number) { - return createStandardRequestBodyFromString(generateRequestElements('tse:FindRecordings')(['Scope','KeepAliveTime','MaxMatches'])(Scope,KeepAliveTime,MaxMatches)) + return createStandardRequestBodyFromString(generateRequestElements('tse:FindRecordings')({Scope,KeepAliveTime,MaxMatches})) .map(mapResponseXmlToJson('tse:FindRecordingsResponse')) } @@ -86,7 +86,7 @@ export class ONVIFSearch { * This operation is mandatory to support for a device implementing the recording search service. */ static GetRecordingSearchResults(SearchToken: JobToken, MinResults?: number, MaxResults?: number, WaitTime?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetRecordingSearchResults')(['SearchToken','MinResults','MaxResults','WaitTime'])(SearchToken,MinResults,MaxResults,WaitTime)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetRecordingSearchResults')({SearchToken,MinResults,MaxResults,WaitTime})) .map(mapResponseXmlToJson('tse:GetRecordingSearchResultsResponse')) } @@ -109,7 +109,7 @@ export class ONVIFSearch { * recording search service. */ static FindEvents(StartPoint: string, Scope: SearchScope, SearchFilter: EventFilter, IncludeStartState: boolean, KeepAliveTime: string, EndPoint?: string, MaxMatches?: number) { - return createStandardRequestBodyFromString(generateRequestElements('tse:FindEvents')(['StartPoint','Scope','SearchFilter','IncludeStartState','KeepAliveTime','EndPoint','MaxMatches'])(StartPoint,Scope,SearchFilter,IncludeStartState,KeepAliveTime,EndPoint,MaxMatches)) + return createStandardRequestBodyFromString(generateRequestElements('tse:FindEvents')({StartPoint,Scope,SearchFilter,IncludeStartState,KeepAliveTime,EndPoint,MaxMatches})) .map(mapResponseXmlToJson('tse:FindEventsResponse')) } @@ -129,7 +129,7 @@ export class ONVIFSearch { * This operation is mandatory to support for a device implementing the recording search service. */ static GetEventSearchResults(SearchToken: JobToken, MinResults?: number, MaxResults?: number, WaitTime?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetEventSearchResults')(['SearchToken','MinResults','MaxResults','WaitTime'])(SearchToken,MinResults,MaxResults,WaitTime)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetEventSearchResults')({SearchToken,MinResults,MaxResults,WaitTime})) .map(mapResponseXmlToJson('tse:GetEventSearchResultsResponse')) } @@ -151,7 +151,7 @@ export class ONVIFSearch { * track in any recording on the device. */ static FindPTZPosition(StartPoint: string, Scope: SearchScope, SearchFilter: PTZPositionFilter, KeepAliveTime: string, EndPoint?: string, MaxMatches?: number) { - return createStandardRequestBodyFromString(generateRequestElements('tse:FindPTZPosition')(['StartPoint','Scope','SearchFilter','KeepAliveTime','EndPoint','MaxMatches'])(StartPoint,Scope,SearchFilter,KeepAliveTime,EndPoint,MaxMatches)) + return createStandardRequestBodyFromString(generateRequestElements('tse:FindPTZPosition')({StartPoint,Scope,SearchFilter,KeepAliveTime,EndPoint,MaxMatches})) .map(mapResponseXmlToJson('tse:FindPTZPositionResponse')) } @@ -172,7 +172,7 @@ export class ONVIFSearch { * track in any recording on the device. */ static GetPTZPositionSearchResults(SearchToken: JobToken, MinResults?: number, MaxResults?: number, WaitTime?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetPTZPositionSearchResults')(['SearchToken','MinResults','MaxResults','WaitTime'])(SearchToken,MinResults,MaxResults,WaitTime)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetPTZPositionSearchResults')({SearchToken,MinResults,MaxResults,WaitTime})) .map(mapResponseXmlToJson('tse:GetPTZPositionSearchResultsResponse')) } @@ -181,7 +181,7 @@ export class ONVIFSearch { * GetSearchState returns the current state of the specified search session. This command is deprecated . */ static GetSearchState(SearchToken: JobToken) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetSearchState')(['SearchToken'])(SearchToken)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetSearchState')({SearchToken})) .map(mapResponseXmlToJson('tse:GetSearchStateResponse')) } @@ -198,7 +198,7 @@ export class ONVIFSearch { * */ static EndSearch(SearchToken: JobToken) { - return createStandardRequestBodyFromString(generateRequestElements('tse:EndSearch')(['SearchToken'])(SearchToken)) + return createStandardRequestBodyFromString(generateRequestElements('tse:EndSearch')({SearchToken})) .map(mapResponseXmlToJson('tse:EndSearchResponse')) } @@ -220,7 +220,7 @@ export class ONVIFSearch { * SearchCapabilities structure return by the GetCapabilities command in the Device service. */ static FindMetadata(StartPoint: string, Scope: SearchScope, MetadataFilter: MetadataFilter, KeepAliveTime: string, EndPoint?: string, MaxMatches?: number) { - return createStandardRequestBodyFromString(generateRequestElements('tse:FindMetadata')(['StartPoint','Scope','MetadataFilter','KeepAliveTime','EndPoint','MaxMatches'])(StartPoint,Scope,MetadataFilter,KeepAliveTime,EndPoint,MaxMatches)) + return createStandardRequestBodyFromString(generateRequestElements('tse:FindMetadata')({StartPoint,Scope,MetadataFilter,KeepAliveTime,EndPoint,MaxMatches})) .map(mapResponseXmlToJson('tse:FindMetadataResponse')) } @@ -241,7 +241,7 @@ export class ONVIFSearch { * SearchCapabilities structure return by the GetCapabilities command in the Device service. */ static GetMetadataSearchResults(SearchToken: JobToken, MinResults?: number, MaxResults?: number, WaitTime?: string) { - return createStandardRequestBodyFromString(generateRequestElements('tse:GetMetadataSearchResults')(['SearchToken','MinResults','MaxResults','WaitTime'])(SearchToken,MinResults,MaxResults,WaitTime)) + return createStandardRequestBodyFromString(generateRequestElements('tse:GetMetadataSearchResults')({SearchToken,MinResults,MaxResults,WaitTime})) .map(mapResponseXmlToJson('tse:GetMetadataSearchResultsResponse')) } diff --git a/src/api/types.ts b/src/api/types.ts index 35aa706..bc50b32 100644 --- a/src/api/types.ts +++ b/src/api/types.ts @@ -148,8 +148,8 @@ export interface Vector1D { * Pan and tilt position. The x component corresponds to pan and the y component to tilt. */ export interface PTZVector { - readonly 'PanTilt': Vector2D; - readonly 'Zoom': Vector1D; + readonly 'PanTilt'?: Vector2D; + readonly 'Zoom'?: Vector1D; } /** @@ -158,9 +158,9 @@ export interface PTZVector { * */ export interface PTZStatus { - readonly 'Position': PTZVector; - readonly 'MoveStatus': PTZMoveStatus; - readonly 'Error': string; + readonly 'Position'?: PTZVector; + readonly 'MoveStatus'?: PTZMoveStatus; + readonly 'Error'?: string; readonly 'UtcTime': string; } @@ -169,8 +169,8 @@ export interface PTZStatus { * */ export interface PTZMoveStatus { - readonly 'PanTilt': MoveStatus; - readonly 'Zoom': MoveStatus; + readonly 'PanTilt'?: MoveStatus; + readonly 'Zoom'?: MoveStatus; } /** @@ -208,9 +208,9 @@ export interface ColorCovariance { * */ export interface Transformation { - readonly 'Translate': Vector; - readonly 'Scale': Vector; - readonly 'Extension': TransformationExtension; + readonly 'Translate'?: Vector; + readonly 'Scale'?: Vector; + readonly 'Extension'?: TransformationExtension; } /** @@ -247,10 +247,10 @@ export interface LocalOrientation { * Location on earth. */ export interface LocationEntity { - readonly 'GeoLocation': GeoLocation; - readonly 'GeoOrientation': GeoOrientation; - readonly 'LocalLocation': LocalLocation; - readonly 'LocalOrientation': LocalOrientation; + readonly 'GeoLocation'?: GeoLocation; + readonly 'GeoOrientation'?: GeoOrientation; + readonly 'LocalLocation'?: LocalLocation; + readonly 'LocalOrientation'?: LocalOrientation; } /** @@ -303,14 +303,14 @@ export interface DurationRange { * List of values. */ export interface IntList { - readonly 'Items': number; + readonly 'Items'?: number; } /** * */ export interface FloatList { - readonly 'Items': number; + readonly 'Items'?: number; } /** @@ -325,16 +325,16 @@ export interface AnyHolder { export interface VideoSource { readonly 'Framerate': number; readonly 'Resolution': VideoResolution; - readonly 'Imaging': ImagingSettings; - readonly 'Extension': VideoSourceExtension; + readonly 'Imaging'?: ImagingSettings; + readonly 'Extension'?: VideoSourceExtension; } /** * Optional configuration of the image sensor. To be used if imaging service 2.00 is supported. */ export interface VideoSourceExtension { - readonly 'Imaging': ImagingSettings20; - readonly 'Extension': VideoSourceExtension2; + readonly 'Imaging'?: ImagingSettings20; + readonly 'Extension'?: VideoSourceExtension2; } /** @@ -364,23 +364,23 @@ export interface AudioSource { */ export interface Profile { readonly 'Name': Name; - readonly 'VideoSourceConfiguration': VideoSourceConfiguration; - readonly 'AudioSourceConfiguration': AudioSourceConfiguration; - readonly 'VideoEncoderConfiguration': VideoEncoderConfiguration; - readonly 'AudioEncoderConfiguration': AudioEncoderConfiguration; - readonly 'VideoAnalyticsConfiguration': VideoAnalyticsConfiguration; - readonly 'PTZConfiguration': PTZConfiguration; - readonly 'MetadataConfiguration': MetadataConfiguration; - readonly 'Extension': ProfileExtension; + readonly 'VideoSourceConfiguration'?: VideoSourceConfiguration; + readonly 'AudioSourceConfiguration'?: AudioSourceConfiguration; + readonly 'VideoEncoderConfiguration'?: VideoEncoderConfiguration; + readonly 'AudioEncoderConfiguration'?: AudioEncoderConfiguration; + readonly 'VideoAnalyticsConfiguration'?: VideoAnalyticsConfiguration; + readonly 'PTZConfiguration'?: PTZConfiguration; + readonly 'MetadataConfiguration'?: MetadataConfiguration; + readonly 'Extension'?: ProfileExtension; } /** * Optional configuration of the Audio output. */ export interface ProfileExtension { - readonly 'AudioOutputConfiguration': AudioOutputConfiguration; - readonly 'AudioDecoderConfiguration': AudioDecoderConfiguration; - readonly 'Extension': ProfileExtension2; + readonly 'AudioOutputConfiguration'?: AudioOutputConfiguration; + readonly 'AudioDecoderConfiguration'?: AudioDecoderConfiguration; + readonly 'Extension'?: ProfileExtension2; } /** @@ -403,7 +403,7 @@ export interface ConfigurationEntity { export interface VideoSourceConfiguration { readonly 'SourceToken': ReferenceToken; readonly 'Bounds': IntRectangle; - readonly 'Extension': VideoSourceConfigurationExtension; + readonly 'Extension'?: VideoSourceConfigurationExtension; } /** @@ -415,16 +415,16 @@ export interface VideoSourceConfiguration { * */ export interface VideoSourceConfigurationExtension { - readonly 'Rotate': Rotate; - readonly 'Extension': VideoSourceConfigurationExtension2; + readonly 'Rotate'?: Rotate; + readonly 'Extension'?: VideoSourceConfigurationExtension2; } /** * Optional element describing the geometric lens distortion. Multiple instances for future variable lens support. */ export interface VideoSourceConfigurationExtension2 { - readonly 'LensDescription': LensDescription; - readonly 'SceneOrientation': SceneOrientation; + readonly 'LensDescription'?: LensDescription; + readonly 'SceneOrientation'?: SceneOrientation; } /** @@ -432,8 +432,8 @@ export interface VideoSourceConfigurationExtension2 { */ export interface Rotate { readonly 'Mode': RotateMode; - readonly 'Degree': number; - readonly 'Extension': RotateExtension; + readonly 'Degree'?: number; + readonly 'Extension'?: RotateExtension; } /** @@ -448,7 +448,7 @@ export interface RotateExtension { export interface LensProjection { readonly 'Angle': number; readonly 'Radius': number; - readonly 'Transmittance': number; + readonly 'Transmittance'?: number; } /** @@ -476,22 +476,22 @@ export interface LensDescription { export interface VideoSourceConfigurationOptions { readonly 'BoundsRange': IntRectangleRange; readonly 'VideoSourceTokensAvailable': ReferenceToken; - readonly 'Extension': VideoSourceConfigurationOptionsExtension; + readonly 'Extension'?: VideoSourceConfigurationOptionsExtension; } /** * Options of parameters for Rotation feature. */ export interface VideoSourceConfigurationOptionsExtension { - readonly 'Rotate': RotateOptions; - readonly 'Extension': VideoSourceConfigurationOptionsExtension2; + readonly 'Rotate'?: RotateOptions; + readonly 'Extension'?: VideoSourceConfigurationOptionsExtension2; } /** * Scene orientation modes supported by the device for this configuration. */ export interface VideoSourceConfigurationOptionsExtension2 { - readonly 'SceneOrientationMode': SceneOrientationMode; + readonly 'SceneOrientationMode'?: SceneOrientationMode; } /** @@ -499,8 +499,8 @@ export interface VideoSourceConfigurationOptionsExtension2 { */ export interface RotateOptions { readonly 'Mode': RotateMode; - readonly 'DegreeList': IntList; - readonly 'Extension': RotateOptionsExtension; + readonly 'DegreeList'?: IntList; + readonly 'Extension'?: RotateOptionsExtension; } /** @@ -516,7 +516,7 @@ export interface RotateOptionsExtension { */ export interface SceneOrientation { readonly 'Mode': SceneOrientationMode; - readonly 'Orientation': string; + readonly 'Orientation'?: string; } /** @@ -526,9 +526,9 @@ export interface VideoEncoderConfiguration { readonly 'Encoding': VideoEncoding; readonly 'Resolution': VideoResolution; readonly 'Quality': number; - readonly 'RateControl': VideoRateControl; - readonly 'MPEG4': Mpeg4Configuration; - readonly 'H264': H264Configuration; + readonly 'RateControl'?: VideoRateControl; + readonly 'MPEG4'?: Mpeg4Configuration; + readonly 'H264'?: H264Configuration; readonly 'Multicast': MulticastConfiguration; readonly 'SessionTimeout': string; } @@ -571,20 +571,20 @@ export interface H264Configuration { */ export interface VideoEncoderConfigurationOptions { readonly 'QualityRange': IntRange; - readonly 'JPEG': JpegOptions; - readonly 'MPEG4': Mpeg4Options; - readonly 'H264': H264Options; - readonly 'Extension': VideoEncoderOptionsExtension; + readonly 'JPEG'?: JpegOptions; + readonly 'MPEG4'?: Mpeg4Options; + readonly 'H264'?: H264Options; + readonly 'Extension'?: VideoEncoderOptionsExtension; } /** * Optional JPEG encoder settings ranges. */ export interface VideoEncoderOptionsExtension { - readonly 'JPEG': JpegOptions2; - readonly 'MPEG4': Mpeg4Options2; - readonly 'H264': H264Options2; - readonly 'Extension': VideoEncoderOptionsExtension2; + readonly 'JPEG'?: JpegOptions2; + readonly 'MPEG4'?: Mpeg4Options2; + readonly 'H264'?: H264Options2; + readonly 'Extension'?: VideoEncoderOptionsExtension2; } /** @@ -651,8 +651,8 @@ export interface H264Options2 { export interface VideoEncoder2Configuration { readonly 'Encoding': string; readonly 'Resolution': VideoResolution2; - readonly 'RateControl': VideoRateControl2; - readonly 'Multicast': MulticastConfiguration; + readonly 'RateControl'?: VideoRateControl2; + readonly 'Multicast'?: MulticastConfiguration; readonly 'Quality': number; } @@ -694,7 +694,7 @@ export interface AudioSourceConfiguration { */ export interface AudioSourceConfigurationOptions { readonly 'InputTokensAvailable': ReferenceToken; - readonly 'Extension': AudioSourceOptionsExtension; + readonly 'Extension'?: AudioSourceOptionsExtension; } /** @@ -718,7 +718,7 @@ export interface AudioEncoderConfiguration { * list of supported AudioEncoderConfigurations */ export interface AudioEncoderConfigurationOptions { - readonly 'Options': AudioEncoderConfigurationOption; + readonly 'Options'?: AudioEncoderConfigurationOption; } /** @@ -735,7 +735,7 @@ export interface AudioEncoderConfigurationOption { */ export interface AudioEncoder2Configuration { readonly 'Encoding': string; - readonly 'Multicast': MulticastConfiguration; + readonly 'Multicast'?: MulticastConfiguration; readonly 'Bitrate': number; readonly 'SampleRate': number; } @@ -761,13 +761,13 @@ export interface VideoAnalyticsConfiguration { * optional element to configure which PTZ related data is to include in the metadata stream */ export interface MetadataConfiguration { - readonly 'PTZStatus': PTZFilter; - readonly 'Events': EventSubscription; - readonly 'Analytics': boolean; + readonly 'PTZStatus'?: PTZFilter; + readonly 'Events'?: EventSubscription; + readonly 'Analytics'?: boolean; readonly 'Multicast': MulticastConfiguration; readonly 'SessionTimeout': string; - readonly 'AnalyticsEngineConfiguration': AnalyticsEngineConfiguration; - readonly 'Extension': MetadataConfigurationExtension; + readonly 'AnalyticsEngineConfiguration'?: AnalyticsEngineConfiguration; + readonly 'Extension'?: MetadataConfigurationExtension; } /** @@ -788,8 +788,8 @@ export interface PTZFilter { * Subcription handling in the same way as base notification subscription. */ export interface EventSubscription { - readonly 'Filter': any; - readonly 'SubscriptionPolicy': any; + readonly 'Filter'?: any; + readonly 'SubscriptionPolicy'?: any; } /** @@ -797,15 +797,15 @@ export interface EventSubscription { */ export interface MetadataConfigurationOptions { readonly 'PTZStatusFilterOptions': PTZStatusFilterOptions; - readonly 'Extension': MetadataConfigurationOptionsExtension; + readonly 'Extension'?: MetadataConfigurationOptionsExtension; } /** * List of supported metadata compression type. Its options shall be chosen from tt:MetadataCompressionType. */ export interface MetadataConfigurationOptionsExtension { - readonly 'CompressionType': string; - readonly 'Extension': MetadataConfigurationOptionsExtension2; + readonly 'CompressionType'?: string; + readonly 'Extension'?: MetadataConfigurationOptionsExtension2; } /** @@ -820,9 +820,9 @@ export interface MetadataConfigurationOptionsExtension2 { export interface PTZStatusFilterOptions { readonly 'PanTiltStatusSupported': boolean; readonly 'ZoomStatusSupported': boolean; - readonly 'PanTiltPositionSupported': boolean; - readonly 'ZoomPositionSupported': boolean; - readonly 'Extension': PTZStatusFilterOptionsExtension; + readonly 'PanTiltPositionSupported'?: boolean; + readonly 'ZoomPositionSupported'?: boolean; + readonly 'Extension'?: PTZStatusFilterOptionsExtension; } /** @@ -836,10 +836,10 @@ export interface PTZStatusFilterOptionsExtension { */ export interface VideoOutput { readonly 'Layout': Layout; - readonly 'Resolution': VideoResolution; - readonly 'RefreshRate': number; - readonly 'AspectRatio': number; - readonly 'Extension': VideoOutputExtension; + readonly 'Resolution'?: VideoResolution; + readonly 'RefreshRate'?: number; + readonly 'AspectRatio'?: number; + readonly 'Extension'?: VideoOutputExtension; } /** @@ -865,10 +865,10 @@ export interface VideoOutputConfigurationOptions { * If the device is able to decode Jpeg streams this element describes the supported codecs and configurations */ export interface VideoDecoderConfigurationOptions { - readonly 'JpegDecOptions': JpegDecOptions; - readonly 'H264DecOptions': H264DecOptions; - readonly 'Mpeg4DecOptions': Mpeg4DecOptions; - readonly 'Extension': VideoDecoderConfigurationOptionsExtension; + readonly 'JpegDecOptions'?: JpegDecOptions; + readonly 'H264DecOptions'?: H264DecOptions; + readonly 'Mpeg4DecOptions'?: Mpeg4DecOptions; + readonly 'Extension'?: VideoDecoderConfigurationOptionsExtension; } /** @@ -917,7 +917,7 @@ export interface AudioOutput { */ export interface AudioOutputConfiguration { readonly 'OutputToken': ReferenceToken; - readonly 'SendPrimacy': string; + readonly 'SendPrimacy'?: string; readonly 'OutputLevel': number; } @@ -926,7 +926,7 @@ export interface AudioOutputConfiguration { */ export interface AudioOutputConfigurationOptions { readonly 'OutputTokensAvailable': ReferenceToken; - readonly 'SendPrimacyOptions': string; + readonly 'SendPrimacyOptions'?: string; readonly 'OutputLevelRange': IntRange; } @@ -941,10 +941,10 @@ export interface AudioDecoderConfiguration { * If the device is able to decode AAC encoded audio this section describes the supported configurations */ export interface AudioDecoderConfigurationOptions { - readonly 'AACDecOptions': AACDecOptions; - readonly 'G711DecOptions': G711DecOptions; - readonly 'G726DecOptions': G726DecOptions; - readonly 'Extension': AudioDecoderConfigurationOptionsExtension; + readonly 'AACDecOptions'?: AACDecOptions; + readonly 'G711DecOptions'?: G711DecOptions; + readonly 'G726DecOptions'?: G726DecOptions; + readonly 'Extension'?: AudioDecoderConfigurationOptionsExtension; } /** @@ -1000,7 +1000,7 @@ export interface StreamSetup { */ export interface Transport { readonly 'Protocol': TransportProtocol; - readonly 'Tunnel': Transport; + readonly 'Tunnel'?: Transport; } /** @@ -1026,11 +1026,11 @@ export interface Scope { */ export interface NetworkInterface { readonly 'Enabled': boolean; - readonly 'Info': NetworkInterfaceInfo; - readonly 'Link': NetworkInterfaceLink; - readonly 'IPv4': IPv4NetworkInterface; - readonly 'IPv6': IPv6NetworkInterface; - readonly 'Extension': NetworkInterfaceExtension; + readonly 'Info'?: NetworkInterfaceInfo; + readonly 'Link'?: NetworkInterfaceLink; + readonly 'IPv4'?: IPv4NetworkInterface; + readonly 'IPv6'?: IPv6NetworkInterface; + readonly 'Extension'?: NetworkInterfaceExtension; } /** @@ -1038,9 +1038,9 @@ export interface NetworkInterface { */ export interface NetworkInterfaceExtension { readonly 'InterfaceType': any; - readonly 'Dot3': Dot3Configuration; - readonly 'Dot11': Dot11Configuration; - readonly 'Extension': NetworkInterfaceExtension2; + readonly 'Dot3'?: Dot3Configuration; + readonly 'Dot11'?: Dot11Configuration; + readonly 'Extension'?: NetworkInterfaceExtension2; } /** @@ -1077,9 +1077,9 @@ export interface NetworkInterfaceConnectionSetting { * Network interface name, for example eth0. */ export interface NetworkInterfaceInfo { - readonly 'Name': string; + readonly 'Name'?: string; readonly 'HwAddress': HwAddress; - readonly 'MTU': number; + readonly 'MTU'?: number; } /** @@ -1087,7 +1087,7 @@ export interface NetworkInterfaceInfo { */ export interface IPv6NetworkInterface { readonly 'Enabled': boolean; - readonly 'Config': IPv6Configuration; + readonly 'Config'?: IPv6Configuration; } /** @@ -1102,9 +1102,9 @@ export interface IPv4NetworkInterface { * List of manually added IPv4 addresses. */ export interface IPv4Configuration { - readonly 'Manual': PrefixedIPv4Address; - readonly 'LinkLocal': PrefixedIPv4Address; - readonly 'FromDHCP': PrefixedIPv4Address; + readonly 'Manual'?: PrefixedIPv4Address; + readonly 'LinkLocal'?: PrefixedIPv4Address; + readonly 'FromDHCP'?: PrefixedIPv4Address; readonly 'DHCP': boolean; } @@ -1112,13 +1112,13 @@ export interface IPv4Configuration { * Indicates whether router advertisment is used. */ export interface IPv6Configuration { - readonly 'AcceptRouterAdvert': boolean; + readonly 'AcceptRouterAdvert'?: boolean; readonly 'DHCP': IPv6DHCPConfiguration; - readonly 'Manual': PrefixedIPv6Address; - readonly 'LinkLocal': PrefixedIPv6Address; - readonly 'FromDHCP': PrefixedIPv6Address; - readonly 'FromRA': PrefixedIPv6Address; - readonly 'Extension': IPv6ConfigurationExtension; + readonly 'Manual'?: PrefixedIPv6Address; + readonly 'LinkLocal'?: PrefixedIPv6Address; + readonly 'FromDHCP'?: PrefixedIPv6Address; + readonly 'FromRA'?: PrefixedIPv6Address; + readonly 'Extension'?: IPv6ConfigurationExtension; } /** @@ -1134,7 +1134,7 @@ export interface NetworkProtocol { readonly 'Name': NetworkProtocolType; readonly 'Enabled': boolean; readonly 'Port': number; - readonly 'Extension': NetworkProtocolExtension; + readonly 'Extension'?: NetworkProtocolExtension; } /** @@ -1148,10 +1148,10 @@ export interface NetworkProtocolExtension { */ export interface NetworkHost { readonly 'Type': NetworkHostType; - readonly 'IPv4Address': IPv4Address; - readonly 'IPv6Address': IPv6Address; - readonly 'DNSname': DNSName; - readonly 'Extension': NetworkHostExtension; + readonly 'IPv4Address'?: IPv4Address; + readonly 'IPv6Address'?: IPv6Address; + readonly 'DNSname'?: DNSName; + readonly 'Extension'?: NetworkHostExtension; } /** @@ -1165,8 +1165,8 @@ export interface NetworkHostExtension { */ export interface IPAddress { readonly 'Type': IPType; - readonly 'IPv4Address': IPv4Address; - readonly 'IPv6Address': IPv6Address; + readonly 'IPv4Address'?: IPv4Address; + readonly 'IPv6Address'?: IPv6Address; } /** @@ -1190,8 +1190,8 @@ export interface PrefixedIPv6Address { */ export interface HostnameInformation { readonly 'FromDHCP': boolean; - readonly 'Name': string; - readonly 'Extension': HostnameInformationExtension; + readonly 'Name'?: string; + readonly 'Extension'?: HostnameInformationExtension; } /** @@ -1205,10 +1205,10 @@ export interface HostnameInformationExtension { */ export interface DNSInformation { readonly 'FromDHCP': boolean; - readonly 'SearchDomain': string; - readonly 'DNSFromDHCP': IPAddress; - readonly 'DNSManual': IPAddress; - readonly 'Extension': DNSInformationExtension; + readonly 'SearchDomain'?: string; + readonly 'DNSFromDHCP'?: IPAddress; + readonly 'DNSManual'?: IPAddress; + readonly 'Extension'?: DNSInformationExtension; } /** @@ -1222,9 +1222,9 @@ export interface DNSInformationExtension { */ export interface NTPInformation { readonly 'FromDHCP': boolean; - readonly 'NTPFromDHCP': NetworkHost; - readonly 'NTPManual': NetworkHost; - readonly 'Extension': NTPInformationExtension; + readonly 'NTPFromDHCP'?: NetworkHost; + readonly 'NTPManual'?: NetworkHost; + readonly 'Extension'?: NTPInformationExtension; } /** @@ -1238,9 +1238,9 @@ export interface NTPInformationExtension { */ export interface DynamicDNSInformation { readonly 'Type': DynamicDNSType; - readonly 'Name': DNSName; - readonly 'TTL': string; - readonly 'Extension': DynamicDNSInformationExtension; + readonly 'Name'?: DNSName; + readonly 'TTL'?: string; + readonly 'Extension'?: DynamicDNSInformationExtension; } /** @@ -1253,48 +1253,48 @@ export interface DynamicDNSInformationExtension { * Indicates whether or not an interface is enabled. */ export interface NetworkInterfaceSetConfiguration { - readonly 'Enabled': boolean; - readonly 'Link': NetworkInterfaceConnectionSetting; - readonly 'MTU': number; - readonly 'IPv4': IPv4NetworkInterfaceSetConfiguration; - readonly 'IPv6': IPv6NetworkInterfaceSetConfiguration; - readonly 'Extension': NetworkInterfaceSetConfigurationExtension; + readonly 'Enabled'?: boolean; + readonly 'Link'?: NetworkInterfaceConnectionSetting; + readonly 'MTU'?: number; + readonly 'IPv4'?: IPv4NetworkInterfaceSetConfiguration; + readonly 'IPv6'?: IPv6NetworkInterfaceSetConfiguration; + readonly 'Extension'?: NetworkInterfaceSetConfigurationExtension; } /** * */ export interface NetworkInterfaceSetConfigurationExtension { - readonly 'Dot3': Dot3Configuration; - readonly 'Dot11': Dot11Configuration; - readonly 'Extension': NetworkInterfaceSetConfigurationExtension2; + readonly 'Dot3'?: Dot3Configuration; + readonly 'Dot11'?: Dot11Configuration; + readonly 'Extension'?: NetworkInterfaceSetConfigurationExtension2; } /** * Indicates whether or not IPv6 is enabled. */ export interface IPv6NetworkInterfaceSetConfiguration { - readonly 'Enabled': boolean; - readonly 'AcceptRouterAdvert': boolean; - readonly 'Manual': PrefixedIPv6Address; - readonly 'DHCP': IPv6DHCPConfiguration; + readonly 'Enabled'?: boolean; + readonly 'AcceptRouterAdvert'?: boolean; + readonly 'Manual'?: PrefixedIPv6Address; + readonly 'DHCP'?: IPv6DHCPConfiguration; } /** * Indicates whether or not IPv4 is enabled. */ export interface IPv4NetworkInterfaceSetConfiguration { - readonly 'Enabled': boolean; - readonly 'Manual': PrefixedIPv4Address; - readonly 'DHCP': boolean; + readonly 'Enabled'?: boolean; + readonly 'Manual'?: PrefixedIPv4Address; + readonly 'DHCP'?: boolean; } /** * IPv4 address string. */ export interface NetworkGateway { - readonly 'IPv4Address': IPv4Address; - readonly 'IPv6Address': IPv6Address; + readonly 'IPv4Address'?: IPv4Address; + readonly 'IPv6Address'?: IPv6Address; } /** @@ -1303,16 +1303,16 @@ export interface NetworkGateway { export interface NetworkZeroConfiguration { readonly 'InterfaceToken': ReferenceToken; readonly 'Enabled': boolean; - readonly 'Addresses': IPv4Address; - readonly 'Extension': NetworkZeroConfigurationExtension; + readonly 'Addresses'?: IPv4Address; + readonly 'Extension'?: NetworkZeroConfigurationExtension; } /** * Optional array holding the configuration for the second and possibly further interfaces. */ export interface NetworkZeroConfigurationExtension { - readonly 'Additional': NetworkZeroConfiguration; - readonly 'Extension': NetworkZeroConfigurationExtension2; + readonly 'Additional'?: NetworkZeroConfiguration; + readonly 'Extension'?: NetworkZeroConfigurationExtension2; } /** @@ -1326,9 +1326,9 @@ export interface NetworkZeroConfigurationExtension2 { */ export interface IPAddressFilter { readonly 'Type': IPAddressFilterType; - readonly 'IPv4Address': PrefixedIPv4Address; - readonly 'IPv6Address': PrefixedIPv6Address; - readonly 'Extension': IPAddressFilterExtension; + readonly 'IPv4Address'?: PrefixedIPv4Address; + readonly 'IPv6Address'?: PrefixedIPv6Address; + readonly 'Extension'?: IPAddressFilterExtension; } /** @@ -1353,10 +1353,10 @@ export interface Dot11Configuration { */ export interface Dot11SecurityConfiguration { readonly 'Mode': Dot11SecurityMode; - readonly 'Algorithm': Dot11Cipher; - readonly 'PSK': Dot11PSKSet; - readonly 'Dot1X': ReferenceToken; - readonly 'Extension': Dot11SecurityConfigurationExtension; + readonly 'Algorithm'?: Dot11Cipher; + readonly 'PSK'?: Dot11PSKSet; + readonly 'Dot1X'?: ReferenceToken; + readonly 'Extension'?: Dot11SecurityConfigurationExtension; } /** @@ -1372,9 +1372,9 @@ export interface Dot11SecurityConfigurationExtension { * */ export interface Dot11PSKSet { - readonly 'Key': Dot11PSK; - readonly 'Passphrase': Dot11PSKPassphrase; - readonly 'Extension': Dot11PSKSetExtension; + readonly 'Key'?: Dot11PSK; + readonly 'Passphrase'?: Dot11PSKPassphrase; + readonly 'Extension'?: Dot11PSKSetExtension; } /** @@ -1405,10 +1405,10 @@ export interface Dot11Capabilities { */ export interface Dot11Status { readonly 'SSID': Dot11SSIDType; - readonly 'BSSID': string; - readonly 'PairCipher': Dot11Cipher; - readonly 'GroupCipher': Dot11Cipher; - readonly 'SignalStrength': Dot11SignalStrength; + readonly 'BSSID'?: string; + readonly 'PairCipher'?: Dot11Cipher; + readonly 'GroupCipher'?: Dot11Cipher; + readonly 'SignalStrength'?: Dot11SignalStrength; readonly 'ActiveConfigAlias': ReferenceToken; } @@ -1417,12 +1417,12 @@ export interface Dot11Status { */ export interface Dot11AvailableNetworks { readonly 'SSID': Dot11SSIDType; - readonly 'BSSID': string; - readonly 'AuthAndMangementSuite': Dot11AuthAndMangementSuite; - readonly 'PairCipher': Dot11Cipher; - readonly 'GroupCipher': Dot11Cipher; - readonly 'SignalStrength': Dot11SignalStrength; - readonly 'Extension': Dot11AvailableNetworksExtension; + readonly 'BSSID'?: string; + readonly 'AuthAndMangementSuite'?: Dot11AuthAndMangementSuite; + readonly 'PairCipher'?: Dot11Cipher; + readonly 'GroupCipher'?: Dot11Cipher; + readonly 'SignalStrength'?: Dot11SignalStrength; + readonly 'Extension'?: Dot11AvailableNetworksExtension; } /** @@ -1435,27 +1435,27 @@ export interface Dot11AvailableNetworksExtension { * Analytics capabilities */ export interface Capabilities { - readonly 'Analytics': AnalyticsCapabilities; - readonly 'Device': DeviceCapabilities; - readonly 'Events': EventCapabilities; - readonly 'Imaging': ImagingCapabilities; - readonly 'Media': MediaCapabilities; - readonly 'PTZ': PTZCapabilities; - readonly 'Extension': CapabilitiesExtension; + readonly 'Analytics'?: AnalyticsCapabilities; + readonly 'Device'?: DeviceCapabilities; + readonly 'Events'?: EventCapabilities; + readonly 'Imaging'?: ImagingCapabilities; + readonly 'Media'?: MediaCapabilities; + readonly 'PTZ'?: PTZCapabilities; + readonly 'Extension'?: CapabilitiesExtension; } /** * */ export interface CapabilitiesExtension { - readonly 'DeviceIO': DeviceIOCapabilities; - readonly 'Display': DisplayCapabilities; - readonly 'Recording': RecordingCapabilities; - readonly 'Search': SearchCapabilities; - readonly 'Replay': ReplayCapabilities; - readonly 'Receiver': ReceiverCapabilities; - readonly 'AnalyticsDevice': AnalyticsDeviceCapabilities; - readonly 'Extensions': CapabilitiesExtension2; + readonly 'DeviceIO'?: DeviceIOCapabilities; + readonly 'Display'?: DisplayCapabilities; + readonly 'Recording'?: RecordingCapabilities; + readonly 'Search'?: SearchCapabilities; + readonly 'Replay'?: ReplayCapabilities; + readonly 'Receiver'?: ReceiverCapabilities; + readonly 'AnalyticsDevice'?: AnalyticsDeviceCapabilities; + readonly 'Extensions'?: CapabilitiesExtension2; } /** @@ -1478,11 +1478,11 @@ export interface AnalyticsCapabilities { */ export interface DeviceCapabilities { readonly 'XAddr': string; - readonly 'Network': NetworkCapabilities; - readonly 'System': SystemCapabilities; - readonly 'IO': IOCapabilities; - readonly 'Security': SecurityCapabilities; - readonly 'Extension': DeviceCapabilitiesExtension; + readonly 'Network'?: NetworkCapabilities; + readonly 'System'?: SystemCapabilities; + readonly 'IO'?: IOCapabilities; + readonly 'Security'?: SecurityCapabilities; + readonly 'Extension'?: DeviceCapabilitiesExtension; } /** @@ -1505,17 +1505,17 @@ export interface EventCapabilities { * Number of input connectors. */ export interface IOCapabilities { - readonly 'InputConnectors': number; - readonly 'RelayOutputs': number; - readonly 'Extension': IOCapabilitiesExtension; + readonly 'InputConnectors'?: number; + readonly 'RelayOutputs'?: number; + readonly 'Extension'?: IOCapabilitiesExtension; } /** * */ export interface IOCapabilitiesExtension { - readonly 'Auxiliary': boolean; - readonly 'AuxiliaryCommands': AuxiliaryData; + readonly 'Auxiliary'?: boolean; + readonly 'AuxiliaryCommands'?: AuxiliaryData; readonly 'Extension': IOCapabilitiesExtension2; } @@ -1531,7 +1531,7 @@ export interface IOCapabilitiesExtension2 { export interface MediaCapabilities { readonly 'XAddr': string; readonly 'StreamingCapabilities': RealTimeStreamingCapabilities; - readonly 'Extension': MediaCapabilitiesExtension; + readonly 'Extension'?: MediaCapabilitiesExtension; } /** @@ -1545,10 +1545,10 @@ export interface MediaCapabilitiesExtension { * Indicates whether or not RTP multicast is supported. */ export interface RealTimeStreamingCapabilities { - readonly 'RTPMulticast': boolean; - readonly 'RTP_TCP': boolean; - readonly 'RTP_RTSP_TCP': boolean; - readonly 'Extension': RealTimeStreamingCapabilitiesExtension; + readonly 'RTPMulticast'?: boolean; + readonly 'RTP_TCP'?: boolean; + readonly 'RTP_RTSP_TCP'?: boolean; + readonly 'Extension'?: RealTimeStreamingCapabilitiesExtension; } /** @@ -1568,19 +1568,19 @@ export interface ProfileCapabilities { * Indicates whether or not IP filtering is supported. */ export interface NetworkCapabilities { - readonly 'IPFilter': boolean; - readonly 'ZeroConfiguration': boolean; - readonly 'IPVersion6': boolean; - readonly 'DynDNS': boolean; - readonly 'Extension': NetworkCapabilitiesExtension; + readonly 'IPFilter'?: boolean; + readonly 'ZeroConfiguration'?: boolean; + readonly 'IPVersion6'?: boolean; + readonly 'DynDNS'?: boolean; + readonly 'Extension'?: NetworkCapabilitiesExtension; } /** * */ export interface NetworkCapabilitiesExtension { - readonly 'Dot11Configuration': boolean; - readonly 'Extension': NetworkCapabilitiesExtension2; + readonly 'Dot11Configuration'?: boolean; + readonly 'Extension'?: NetworkCapabilitiesExtension2; } /** @@ -1601,7 +1601,7 @@ export interface SecurityCapabilities { readonly 'SAMLToken': boolean; readonly 'KerberosToken': boolean; readonly 'RELToken': boolean; - readonly 'Extension': SecurityCapabilitiesExtension; + readonly 'Extension'?: SecurityCapabilitiesExtension; } /** @@ -1609,7 +1609,7 @@ export interface SecurityCapabilities { */ export interface SecurityCapabilitiesExtension { readonly 'TLS1.0': boolean; - readonly 'Extension': SecurityCapabilitiesExtension2; + readonly 'Extension'?: SecurityCapabilitiesExtension2; } /** @@ -1617,7 +1617,7 @@ export interface SecurityCapabilitiesExtension { */ export interface SecurityCapabilitiesExtension2 { readonly 'Dot1X': boolean; - readonly 'SupportedEAPMethod': number; + readonly 'SupportedEAPMethod'?: number; readonly 'RemoteUserHandling': boolean; } @@ -1632,18 +1632,18 @@ export interface SystemCapabilities { readonly 'SystemLogging': boolean; readonly 'FirmwareUpgrade': boolean; readonly 'SupportedVersions': OnvifVersion; - readonly 'Extension': SystemCapabilitiesExtension; + readonly 'Extension'?: SystemCapabilitiesExtension; } /** * */ export interface SystemCapabilitiesExtension { - readonly 'HttpFirmwareUpgrade': boolean; - readonly 'HttpSystemBackup': boolean; - readonly 'HttpSystemLogging': boolean; - readonly 'HttpSupportInformation': boolean; - readonly 'Extension': SystemCapabilitiesExtension2; + readonly 'HttpFirmwareUpgrade'?: boolean; + readonly 'HttpSystemBackup'?: boolean; + readonly 'HttpSystemLogging'?: boolean; + readonly 'HttpSupportInformation'?: boolean; + readonly 'Extension'?: SystemCapabilitiesExtension2; } /** @@ -1738,8 +1738,8 @@ export interface ReceiverCapabilities { */ export interface AnalyticsDeviceCapabilities { readonly 'XAddr': string; - readonly 'RuleSupport': boolean; - readonly 'Extension': AnalyticsDeviceExtension; + readonly 'RuleSupport'?: boolean; + readonly 'Extension'?: AnalyticsDeviceExtension; } /** @@ -1752,16 +1752,16 @@ export interface AnalyticsDeviceExtension { * The log information as attachment data. */ export interface SystemLog { - readonly 'Binary': AttachmentData; - readonly 'String': string; + readonly 'Binary'?: AttachmentData; + readonly 'String'?: string; } /** * The support information as attachment data. */ export interface SupportInformation { - readonly 'Binary': AttachmentData; - readonly 'String': string; + readonly 'Binary'?: AttachmentData; + readonly 'String'?: string; } /** @@ -1789,7 +1789,7 @@ export interface BackupFile { * */ export interface SystemLogUriList { - readonly 'SystemLog': SystemLogUri; + readonly 'SystemLog'?: SystemLogUri; } /** @@ -1806,10 +1806,10 @@ export interface SystemLogUri { export interface SystemDateTime { readonly 'DateTimeType': SetDateTimeType; readonly 'DaylightSavings': boolean; - readonly 'TimeZone': TimeZone; - readonly 'UTCDateTime': DateTime; - readonly 'LocalDateTime': DateTime; - readonly 'Extension': SystemDateTimeExtension; + readonly 'TimeZone'?: TimeZone; + readonly 'UTCDateTime'?: DateTime; + readonly 'LocalDateTime'?: DateTime; + readonly 'Extension'?: SystemDateTimeExtension; } /** @@ -1867,7 +1867,7 @@ export interface TimeZone { */ export interface RemoteUser { readonly 'Username': string; - readonly 'Password': string; + readonly 'Password'?: string; readonly 'UseDerivedPassword': boolean; } @@ -1876,9 +1876,9 @@ export interface RemoteUser { */ export interface User { readonly 'Username': string; - readonly 'Password': string; + readonly 'Password'?: string; readonly 'UserLevel': UserLevel; - readonly 'Extension': UserExtension; + readonly 'Extension'?: UserExtension; } /** @@ -1891,11 +1891,11 @@ export interface UserExtension { * */ export interface CertificateGenerationParameters { - readonly 'CertificateID': string; - readonly 'Subject': string; - readonly 'ValidNotBefore': string; - readonly 'ValidNotAfter': string; - readonly 'Extension': CertificateGenerationParametersExtension; + readonly 'CertificateID'?: string; + readonly 'Subject'?: string; + readonly 'ValidNotBefore'?: string; + readonly 'ValidNotAfter'?: string; + readonly 'Extension'?: CertificateGenerationParametersExtension; } /** @@ -1924,7 +1924,7 @@ export interface CertificateStatus { * */ export interface CertificateWithPrivateKey { - readonly 'CertificateID': string; + readonly 'CertificateID'?: string; readonly 'Certificate': BinaryData; readonly 'PrivateKey': BinaryData; } @@ -1934,16 +1934,16 @@ export interface CertificateWithPrivateKey { */ export interface CertificateInformation { readonly 'CertificateID': string; - readonly 'IssuerDN': string; - readonly 'SubjectDN': string; - readonly 'KeyUsage': CertificateUsage; - readonly 'ExtendedKeyUsage': CertificateUsage; - readonly 'KeyLength': number; - readonly 'Version': string; - readonly 'SerialNum': string; - readonly 'SignatureAlgorithm': string; - readonly 'Validity': DateTimeRange; - readonly 'Extension': CertificateInformationExtension; + readonly 'IssuerDN'?: string; + readonly 'SubjectDN'?: string; + readonly 'KeyUsage'?: CertificateUsage; + readonly 'ExtendedKeyUsage'?: CertificateUsage; + readonly 'KeyLength'?: number; + readonly 'Version'?: string; + readonly 'SerialNum'?: string; + readonly 'SignatureAlgorithm'?: string; + readonly 'Validity'?: DateTimeRange; + readonly 'Extension'?: CertificateInformationExtension; } /** @@ -1966,11 +1966,11 @@ export interface CertificateInformationExtension { export interface Dot1XConfiguration { readonly 'Dot1XConfigurationToken': ReferenceToken; readonly 'Identity': string; - readonly 'AnonymousID': string; + readonly 'AnonymousID'?: string; readonly 'EAPMethod': number; - readonly 'CACertificateID': string; - readonly 'EAPMethodConfiguration': EAPMethodConfiguration; - readonly 'Extension': Dot1XConfigurationExtension; + readonly 'CACertificateID'?: string; + readonly 'EAPMethodConfiguration'?: EAPMethodConfiguration; + readonly 'Extension'?: Dot1XConfigurationExtension; } /** @@ -1983,9 +1983,9 @@ export interface Dot1XConfigurationExtension { * Confgiuration information for TLS Method. */ export interface EAPMethodConfiguration { - readonly 'TLSConfiguration': TLSConfiguration; - readonly 'Password': string; - readonly 'Extension': EapMethodExtension; + readonly 'TLSConfiguration'?: TLSConfiguration; + readonly 'Password'?: string; + readonly 'Extension'?: EapMethodExtension; } /** @@ -2043,12 +2043,12 @@ export interface DigitalInput { * */ export interface PTZNode { - readonly 'Name': Name; + readonly 'Name'?: Name; readonly 'SupportedPTZSpaces': PTZSpaces; readonly 'MaximumNumberOfPresets': number; readonly 'HomeSupported': boolean; - readonly 'AuxiliaryCommands': AuxiliaryData; - readonly 'Extension': PTZNodeExtension; + readonly 'AuxiliaryCommands'?: AuxiliaryData; + readonly 'Extension'?: PTZNodeExtension; } /** @@ -2057,8 +2057,8 @@ export interface PTZNode { * */ export interface PTZNodeExtension { - readonly 'SupportedPresetTour': PTZPresetTourSupported; - readonly 'Extension': PTZNodeExtension2; + readonly 'SupportedPresetTour'?: PTZPresetTourSupported; + readonly 'Extension'?: PTZNodeExtension2; } /** @@ -2072,8 +2072,8 @@ export interface PTZNodeExtension2 { */ export interface PTZPresetTourSupported { readonly 'MaximumNumberOfPresetTours': number; - readonly 'PTZPresetTourOperation': PTZPresetTourOperation; - readonly 'Extension': PTZPresetTourSupportedExtension; + readonly 'PTZPresetTourOperation'?: PTZPresetTourOperation; + readonly 'Extension'?: PTZPresetTourSupportedExtension; } /** @@ -2089,25 +2089,25 @@ export interface PTZPresetTourSupportedExtension { */ export interface PTZConfiguration { readonly 'NodeToken': ReferenceToken; - readonly 'DefaultAbsolutePantTiltPositionSpace': string; - readonly 'DefaultAbsoluteZoomPositionSpace': string; - readonly 'DefaultRelativePanTiltTranslationSpace': string; - readonly 'DefaultRelativeZoomTranslationSpace': string; - readonly 'DefaultContinuousPanTiltVelocitySpace': string; - readonly 'DefaultContinuousZoomVelocitySpace': string; - readonly 'DefaultPTZSpeed': PTZSpeed; - readonly 'DefaultPTZTimeout': string; - readonly 'PanTiltLimits': PanTiltLimits; - readonly 'ZoomLimits': ZoomLimits; - readonly 'Extension': PTZConfigurationExtension; + readonly 'DefaultAbsolutePantTiltPositionSpace'?: string; + readonly 'DefaultAbsoluteZoomPositionSpace'?: string; + readonly 'DefaultRelativePanTiltTranslationSpace'?: string; + readonly 'DefaultRelativeZoomTranslationSpace'?: string; + readonly 'DefaultContinuousPanTiltVelocitySpace'?: string; + readonly 'DefaultContinuousZoomVelocitySpace'?: string; + readonly 'DefaultPTZSpeed'?: PTZSpeed; + readonly 'DefaultPTZTimeout'?: string; + readonly 'PanTiltLimits'?: PanTiltLimits; + readonly 'ZoomLimits'?: ZoomLimits; + readonly 'Extension'?: PTZConfigurationExtension; } /** * Optional element to configure PT Control Direction related features. */ export interface PTZConfigurationExtension { - readonly 'PTControlDirection': PTControlDirection; - readonly 'Extension': PTZConfigurationExtension2; + readonly 'PTControlDirection'?: PTControlDirection; + readonly 'Extension'?: PTZConfigurationExtension2; } /** @@ -2120,9 +2120,9 @@ export interface PTZConfigurationExtension2 { * Optional element to configure related parameters for E-Flip. */ export interface PTControlDirection { - readonly 'EFlip': EFlip; - readonly 'Reverse': Reverse; - readonly 'Extension': PTControlDirectionExtension; + readonly 'EFlip'?: EFlip; + readonly 'Reverse'?: Reverse; + readonly 'Extension'?: PTControlDirectionExtension; } /** @@ -2153,8 +2153,8 @@ export interface Reverse { export interface PTZConfigurationOptions { readonly 'Spaces': PTZSpaces; readonly 'PTZTimeout': DurationRange; - readonly 'PTControlDirection': PTControlDirectionOptions; - readonly 'Extension': PTZConfigurationOptions2; + readonly 'PTControlDirection'?: PTControlDirectionOptions; + readonly 'Extension'?: PTZConfigurationOptions2; } /** @@ -2167,9 +2167,9 @@ export interface PTZConfigurationOptions2 { * Supported options for EFlip feature. */ export interface PTControlDirectionOptions { - readonly 'EFlip': EFlipOptions; - readonly 'Reverse': ReverseOptions; - readonly 'Extension': PTControlDirectionOptionsExtension; + readonly 'EFlip'?: EFlipOptions; + readonly 'Reverse'?: ReverseOptions; + readonly 'Extension'?: PTControlDirectionOptionsExtension; } /** @@ -2182,8 +2182,8 @@ export interface PTControlDirectionOptionsExtension { * Options of EFlip mode parameter. */ export interface EFlipOptions { - readonly 'Mode': EFlipMode; - readonly 'Extension': EFlipOptionsExtension; + readonly 'Mode'?: EFlipMode; + readonly 'Extension'?: EFlipOptionsExtension; } /** @@ -2196,8 +2196,8 @@ export interface EFlipOptionsExtension { * Options of Reverse mode parameter. */ export interface ReverseOptions { - readonly 'Mode': ReverseMode; - readonly 'Extension': ReverseOptionsExtension; + readonly 'Mode'?: ReverseMode; + readonly 'Extension'?: ReverseOptionsExtension; } /** @@ -2231,15 +2231,15 @@ export interface ZoomLimits { * */ export interface PTZSpaces { - readonly 'AbsolutePanTiltPositionSpace': Space2DDescription; - readonly 'AbsoluteZoomPositionSpace': Space1DDescription; - readonly 'RelativePanTiltTranslationSpace': Space2DDescription; - readonly 'RelativeZoomTranslationSpace': Space1DDescription; - readonly 'ContinuousPanTiltVelocitySpace': Space2DDescription; - readonly 'ContinuousZoomVelocitySpace': Space1DDescription; - readonly 'PanTiltSpeedSpace': Space1DDescription; - readonly 'ZoomSpeedSpace': Space1DDescription; - readonly 'Extension': PTZSpacesExtension; + readonly 'AbsolutePanTiltPositionSpace'?: Space2DDescription; + readonly 'AbsoluteZoomPositionSpace'?: Space1DDescription; + readonly 'RelativePanTiltTranslationSpace'?: Space2DDescription; + readonly 'RelativeZoomTranslationSpace'?: Space1DDescription; + readonly 'ContinuousPanTiltVelocitySpace'?: Space2DDescription; + readonly 'ContinuousZoomVelocitySpace'?: Space1DDescription; + readonly 'PanTiltSpeedSpace'?: Space1DDescription; + readonly 'ZoomSpeedSpace'?: Space1DDescription; + readonly 'Extension'?: PTZSpacesExtension; } /** @@ -2273,8 +2273,8 @@ export interface Space1DDescription { * 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. */ export interface PTZSpeed { - readonly 'PanTilt': Vector2D; - readonly 'Zoom': Vector1D; + readonly 'PanTilt'?: Vector2D; + readonly 'Zoom'?: Vector1D; } /** @@ -2283,20 +2283,20 @@ export interface PTZSpeed { * */ export interface PTZPreset { - readonly 'Name': Name; - readonly 'PTZPosition': PTZVector; + readonly 'Name'?: Name; + readonly 'PTZPosition'?: PTZVector; } /** * Readable name of the preset tour. */ export interface PresetTour { - readonly 'Name': Name; + readonly 'Name'?: Name; readonly 'Status': PTZPresetTourStatus; readonly 'AutoStart': boolean; readonly 'StartingCondition': PTZPresetTourStartingCondition; - readonly 'TourSpot': PTZPresetTourSpot; - readonly 'Extension': PTZPresetTourExtension; + readonly 'TourSpot'?: PTZPresetTourSpot; + readonly 'Extension'?: PTZPresetTourExtension; } /** @@ -2310,9 +2310,9 @@ export interface PTZPresetTourExtension { */ export interface PTZPresetTourSpot { readonly 'PresetDetail': PTZPresetTourPresetDetail; - readonly 'Speed': PTZSpeed; - readonly 'StayTime': string; - readonly 'Extension': PTZPresetTourSpotExtension; + readonly 'Speed'?: PTZSpeed; + readonly 'StayTime'?: string; + readonly 'Extension'?: PTZPresetTourSpotExtension; } /** @@ -2342,8 +2342,8 @@ export interface PTZPresetTourTypeExtension { */ export interface PTZPresetTourStatus { readonly 'State': PTZPresetTourState; - readonly 'CurrentTourSpot': PTZPresetTourSpot; - readonly 'Extension': PTZPresetTourStatusExtension; + readonly 'CurrentTourSpot'?: PTZPresetTourSpot; + readonly 'Extension'?: PTZPresetTourStatusExtension; } /** @@ -2356,10 +2356,10 @@ export interface PTZPresetTourStatusExtension { * Optional parameter to specify how many times the preset tour is recurred. */ export interface PTZPresetTourStartingCondition { - readonly 'RecurringTime': number; - readonly 'RecurringDuration': string; - readonly 'Direction': PTZPresetTourDirection; - readonly 'Extension': PTZPresetTourStartingConditionExtension; + readonly 'RecurringTime'?: number; + readonly 'RecurringDuration'?: string; + readonly 'Direction'?: PTZPresetTourDirection; + readonly 'Extension'?: PTZPresetTourStartingConditionExtension; } /** @@ -2389,11 +2389,11 @@ export interface PTZPresetTourSpotOptions { * A list of available Preset Tokens for tour spots. */ export interface PTZPresetTourPresetDetailOptions { - readonly 'PresetToken': ReferenceToken; - readonly 'Home': boolean; - readonly 'PanTiltPositionSpace': Space2DDescription; - readonly 'ZoomPositionSpace': Space1DDescription; - readonly 'Extension': PTZPresetTourPresetDetailOptionsExtension; + readonly 'PresetToken'?: ReferenceToken; + readonly 'Home'?: boolean; + readonly 'PanTiltPositionSpace'?: Space2DDescription; + readonly 'ZoomPositionSpace'?: Space1DDescription; + readonly 'Extension'?: PTZPresetTourPresetDetailOptionsExtension; } /** @@ -2406,10 +2406,10 @@ export interface PTZPresetTourPresetDetailOptionsExtension { * Supported range of Recurring Time. */ export interface PTZPresetTourStartingConditionOptions { - readonly 'RecurringTime': IntRange; - readonly 'RecurringDuration': DurationRange; - readonly 'Direction': PTZPresetTourDirection; - readonly 'Extension': PTZPresetTourStartingConditionOptionsExtension; + readonly 'RecurringTime'?: IntRange; + readonly 'RecurringDuration'?: DurationRange; + readonly 'Direction'?: PTZPresetTourDirection; + readonly 'Extension'?: PTZPresetTourStartingConditionOptionsExtension; } /** @@ -2450,17 +2450,17 @@ export interface FocusConfiguration { * Enabled/disabled BLC mode (on/off). */ export interface ImagingSettings { - readonly 'BacklightCompensation': BacklightCompensation; - readonly 'Brightness': number; - readonly 'ColorSaturation': number; - readonly 'Contrast': number; - readonly 'Exposure': Exposure; - readonly 'Focus': FocusConfiguration; - readonly 'IrCutFilter': IrCutFilterMode; - readonly 'Sharpness': number; - readonly 'WideDynamicRange': WideDynamicRange; - readonly 'WhiteBalance': WhiteBalance; - readonly 'Extension': ImagingSettingsExtension; + readonly 'BacklightCompensation'?: BacklightCompensation; + readonly 'Brightness'?: number; + readonly 'ColorSaturation'?: number; + readonly 'Contrast'?: number; + readonly 'Exposure'?: Exposure; + readonly 'Focus'?: FocusConfiguration; + readonly 'IrCutFilter'?: IrCutFilterMode; + readonly 'Sharpness'?: number; + readonly 'WideDynamicRange'?: WideDynamicRange; + readonly 'WhiteBalance'?: WhiteBalance; + readonly 'Extension'?: ImagingSettingsExtension; } /** @@ -2547,7 +2547,7 @@ export interface BacklightCompensationOptions { * */ export interface FocusOptions { - readonly 'AutoFocusModes': AutoFocusMode; + readonly 'AutoFocusModes'?: AutoFocusMode; readonly 'DefaultSpeed': FloatRange; readonly 'NearLimit': FloatRange; readonly 'FarLimit': FloatRange; @@ -2585,9 +2585,9 @@ export interface WhiteBalanceOptions { * */ export interface FocusMove { - readonly 'Absolute': AbsoluteFocus; - readonly 'Relative': RelativeFocus; - readonly 'Continuous': ContinuousFocus; + readonly 'Absolute'?: AbsoluteFocus; + readonly 'Relative'?: RelativeFocus; + readonly 'Continuous'?: ContinuousFocus; } /** @@ -2597,7 +2597,7 @@ export interface FocusMove { */ export interface AbsoluteFocus { readonly 'Position': number; - readonly 'Speed': number; + readonly 'Speed'?: number; } /** @@ -2607,7 +2607,7 @@ export interface AbsoluteFocus { */ export interface RelativeFocus { readonly 'Distance': number; - readonly 'Speed': number; + readonly 'Speed'?: number; } /** @@ -2623,9 +2623,9 @@ export interface ContinuousFocus { * */ export interface MoveOptions { - readonly 'Absolute': AbsoluteFocusOptions; - readonly 'Relative': RelativeFocusOptions; - readonly 'Continuous': ContinuousFocusOptions; + readonly 'Absolute'?: AbsoluteFocusOptions; + readonly 'Relative'?: RelativeFocusOptions; + readonly 'Continuous'?: ContinuousFocusOptions; } /** @@ -2635,7 +2635,7 @@ export interface MoveOptions { */ export interface AbsoluteFocusOptions { readonly 'Position': FloatRange; - readonly 'Speed': FloatRange; + readonly 'Speed'?: FloatRange; } /** @@ -2672,8 +2672,8 @@ export interface WhiteBalance { * */ export interface ImagingStatus20 { - readonly 'FocusStatus20': FocusStatus20; - readonly 'Extension': ImagingStatus20Extension; + readonly 'FocusStatus20'?: FocusStatus20; + readonly 'Extension'?: ImagingStatus20Extension; } /** @@ -2690,8 +2690,8 @@ export interface ImagingStatus20Extension { export interface FocusStatus20 { readonly 'Position': number; readonly 'MoveStatus': MoveStatus; - readonly 'Error': string; - readonly 'Extension': FocusStatus20Extension; + readonly 'Error'?: string; + readonly 'Extension'?: FocusStatus20Extension; } /** @@ -2704,43 +2704,43 @@ export interface FocusStatus20Extension { * Type describing the ImagingSettings of a VideoSource. The supported options and ranges can be obtained via the GetOptions command. */ export interface ImagingSettings20 { - readonly 'BacklightCompensation': BacklightCompensation20; - readonly 'Brightness': number; - readonly 'ColorSaturation': number; - readonly 'Contrast': number; - readonly 'Exposure': Exposure20; - readonly 'Focus': FocusConfiguration20; - readonly 'IrCutFilter': IrCutFilterMode; - readonly 'Sharpness': number; - readonly 'WideDynamicRange': WideDynamicRange20; - readonly 'WhiteBalance': WhiteBalance20; - readonly 'Extension': ImagingSettingsExtension20; + readonly 'BacklightCompensation'?: BacklightCompensation20; + readonly 'Brightness'?: number; + readonly 'ColorSaturation'?: number; + readonly 'Contrast'?: number; + readonly 'Exposure'?: Exposure20; + readonly 'Focus'?: FocusConfiguration20; + readonly 'IrCutFilter'?: IrCutFilterMode; + readonly 'Sharpness'?: number; + readonly 'WideDynamicRange'?: WideDynamicRange20; + readonly 'WhiteBalance'?: WhiteBalance20; + readonly 'Extension'?: ImagingSettingsExtension20; } /** * Optional element to configure Image Stabilization feature. */ export interface ImagingSettingsExtension20 { - readonly 'ImageStabilization': ImageStabilization; - readonly 'Extension': ImagingSettingsExtension202; + readonly 'ImageStabilization'?: ImageStabilization; + readonly 'Extension'?: ImagingSettingsExtension202; } /** * An optional parameter applied to only auto mode to adjust timing of toggling Ir cut filter. */ export interface ImagingSettingsExtension202 { - readonly 'IrCutFilterAutoAdjustment': IrCutFilterAutoAdjustment; - readonly 'Extension': ImagingSettingsExtension203; + readonly 'IrCutFilterAutoAdjustment'?: IrCutFilterAutoAdjustment; + readonly 'Extension'?: ImagingSettingsExtension203; } /** * Optional element to configure Image Contrast Compensation. */ export interface ImagingSettingsExtension203 { - readonly 'ToneCompensation': ToneCompensation; - readonly 'Defogging': Defogging; - readonly 'NoiseReduction': NoiseReduction; - readonly 'Extension': ImagingSettingsExtension204; + readonly 'ToneCompensation'?: ToneCompensation; + readonly 'Defogging'?: Defogging; + readonly 'NoiseReduction'?: NoiseReduction; + readonly 'Extension'?: ImagingSettingsExtension204; } /** @@ -2754,8 +2754,8 @@ export interface ImagingSettingsExtension204 { */ export interface ImageStabilization { readonly 'Mode': ImageStabilizationMode; - readonly 'Level': number; - readonly 'Extension': ImageStabilizationExtension; + readonly 'Level'?: number; + readonly 'Extension'?: ImageStabilizationExtension; } /** @@ -2769,9 +2769,9 @@ export interface ImageStabilizationExtension { */ export interface IrCutFilterAutoAdjustment { readonly 'BoundaryType': string; - readonly 'BoundaryOffset': number; - readonly 'ResponseTime': string; - readonly 'Extension': IrCutFilterAutoAdjustmentExtension; + readonly 'BoundaryOffset'?: number; + readonly 'ResponseTime'?: string; + readonly 'Extension'?: IrCutFilterAutoAdjustmentExtension; } /** @@ -2785,7 +2785,7 @@ export interface IrCutFilterAutoAdjustmentExtension { */ export interface WideDynamicRange20 { readonly 'Mode': WideDynamicMode; - readonly 'Level': number; + readonly 'Level'?: number; } /** @@ -2793,7 +2793,7 @@ export interface WideDynamicRange20 { */ export interface BacklightCompensation20 { readonly 'Mode': BacklightCompensationMode; - readonly 'Level': number; + readonly 'Level'?: number; } /** @@ -2801,17 +2801,17 @@ export interface BacklightCompensation20 { */ export interface Exposure20 { readonly 'Mode': ExposureMode; - readonly 'Priority': ExposurePriority; - readonly 'Window': Rectangle; - readonly 'MinExposureTime': number; - readonly 'MaxExposureTime': number; - readonly 'MinGain': number; - readonly 'MaxGain': number; - readonly 'MinIris': number; - readonly 'MaxIris': number; - readonly 'ExposureTime': number; - readonly 'Gain': number; - readonly 'Iris': number; + readonly 'Priority'?: ExposurePriority; + readonly 'Window'?: Rectangle; + readonly 'MinExposureTime'?: number; + readonly 'MaxExposureTime'?: number; + readonly 'MinGain'?: number; + readonly 'MaxGain'?: number; + readonly 'MinIris'?: number; + readonly 'MaxIris'?: number; + readonly 'ExposureTime'?: number; + readonly 'Gain'?: number; + readonly 'Iris'?: number; } /** @@ -2819,8 +2819,8 @@ export interface Exposure20 { */ export interface ToneCompensation { readonly 'Mode': string; - readonly 'Level': number; - readonly 'Extension': ToneCompensationExtension; + readonly 'Level'?: number; + readonly 'Extension'?: ToneCompensationExtension; } /** @@ -2834,8 +2834,8 @@ export interface ToneCompensationExtension { */ export interface Defogging { readonly 'Mode': string; - readonly 'Level': number; - readonly 'Extension': DefoggingExtension; + readonly 'Level'?: number; + readonly 'Extension'?: DefoggingExtension; } /** @@ -2857,43 +2857,43 @@ export interface NoiseReduction { * */ export interface ImagingOptions20 { - readonly 'BacklightCompensation': BacklightCompensationOptions20; - readonly 'Brightness': FloatRange; - readonly 'ColorSaturation': FloatRange; - readonly 'Contrast': FloatRange; - readonly 'Exposure': ExposureOptions20; - readonly 'Focus': FocusOptions20; - readonly 'IrCutFilterModes': IrCutFilterMode; - readonly 'Sharpness': FloatRange; - readonly 'WideDynamicRange': WideDynamicRangeOptions20; - readonly 'WhiteBalance': WhiteBalanceOptions20; - readonly 'Extension': ImagingOptions20Extension; + readonly 'BacklightCompensation'?: BacklightCompensationOptions20; + readonly 'Brightness'?: FloatRange; + readonly 'ColorSaturation'?: FloatRange; + readonly 'Contrast'?: FloatRange; + readonly 'Exposure'?: ExposureOptions20; + readonly 'Focus'?: FocusOptions20; + readonly 'IrCutFilterModes'?: IrCutFilterMode; + readonly 'Sharpness'?: FloatRange; + readonly 'WideDynamicRange'?: WideDynamicRangeOptions20; + readonly 'WhiteBalance'?: WhiteBalanceOptions20; + readonly 'Extension'?: ImagingOptions20Extension; } /** * Options of parameters for Image Stabilization feature. */ export interface ImagingOptions20Extension { - readonly 'ImageStabilization': ImageStabilizationOptions; - readonly 'Extension': ImagingOptions20Extension2; + readonly 'ImageStabilization'?: ImageStabilizationOptions; + readonly 'Extension'?: ImagingOptions20Extension2; } /** * Options of parameters for adjustment of Ir cut filter auto mode. */ export interface ImagingOptions20Extension2 { - readonly 'IrCutFilterAutoAdjustment': IrCutFilterAutoAdjustmentOptions; - readonly 'Extension': ImagingOptions20Extension3; + readonly 'IrCutFilterAutoAdjustment'?: IrCutFilterAutoAdjustmentOptions; + readonly 'Extension'?: ImagingOptions20Extension3; } /** * Options of parameters for Tone Compensation feature. */ export interface ImagingOptions20Extension3 { - readonly 'ToneCompensationOptions': ToneCompensationOptions; - readonly 'DefoggingOptions': DefoggingOptions; - readonly 'NoiseReductionOptions': NoiseReductionOptions; - readonly 'Extension': ImagingOptions20Extension4; + readonly 'ToneCompensationOptions'?: ToneCompensationOptions; + readonly 'DefoggingOptions'?: DefoggingOptions; + readonly 'NoiseReductionOptions'?: NoiseReductionOptions; + readonly 'Extension'?: ImagingOptions20Extension4; } /** @@ -2907,8 +2907,8 @@ export interface ImagingOptions20Extension4 { */ export interface ImageStabilizationOptions { readonly 'Mode': ImageStabilizationMode; - readonly 'Level': FloatRange; - readonly 'Extension': ImageStabilizationOptionsExtension; + readonly 'Level'?: FloatRange; + readonly 'Extension'?: ImageStabilizationOptionsExtension; } /** @@ -2922,9 +2922,9 @@ export interface ImageStabilizationOptionsExtension { */ export interface IrCutFilterAutoAdjustmentOptions { readonly 'BoundaryType': string; - readonly 'BoundaryOffset': boolean; - readonly 'ResponseTimeRange': DurationRange; - readonly 'Extension': IrCutFilterAutoAdjustmentOptionsExtension; + readonly 'BoundaryOffset'?: boolean; + readonly 'ResponseTimeRange'?: DurationRange; + readonly 'Extension'?: IrCutFilterAutoAdjustmentOptionsExtension; } /** @@ -2938,7 +2938,7 @@ export interface IrCutFilterAutoAdjustmentOptionsExtension { */ export interface WideDynamicRangeOptions20 { readonly 'Mode': WideDynamicMode; - readonly 'Level': FloatRange; + readonly 'Level'?: FloatRange; } /** @@ -2948,7 +2948,7 @@ export interface WideDynamicRangeOptions20 { */ export interface BacklightCompensationOptions20 { readonly 'Mode': BacklightCompensationMode; - readonly 'Level': FloatRange; + readonly 'Level'?: FloatRange; } /** @@ -2962,16 +2962,16 @@ export interface BacklightCompensationOptions20 { */ export interface ExposureOptions20 { readonly 'Mode': ExposureMode; - readonly 'Priority': ExposurePriority; - readonly 'MinExposureTime': FloatRange; - readonly 'MaxExposureTime': FloatRange; - readonly 'MinGain': FloatRange; - readonly 'MaxGain': FloatRange; - readonly 'MinIris': FloatRange; - readonly 'MaxIris': FloatRange; - readonly 'ExposureTime': FloatRange; - readonly 'Gain': FloatRange; - readonly 'Iris': FloatRange; + readonly 'Priority'?: ExposurePriority; + readonly 'MinExposureTime'?: FloatRange; + readonly 'MaxExposureTime'?: FloatRange; + readonly 'MinGain'?: FloatRange; + readonly 'MaxGain'?: FloatRange; + readonly 'MinIris'?: FloatRange; + readonly 'MaxIris'?: FloatRange; + readonly 'ExposureTime'?: FloatRange; + readonly 'Gain'?: FloatRange; + readonly 'Iris'?: FloatRange; } /** @@ -2980,9 +2980,9 @@ export interface ExposureOptions20 { * */ export interface MoveOptions20 { - readonly 'Absolute': AbsoluteFocusOptions; - readonly 'Relative': RelativeFocusOptions20; - readonly 'Continuous': ContinuousFocusOptions; + readonly 'Absolute'?: AbsoluteFocusOptions; + readonly 'Relative'?: RelativeFocusOptions20; + readonly 'Continuous'?: ContinuousFocusOptions; } /** @@ -2992,7 +2992,7 @@ export interface MoveOptions20 { */ export interface RelativeFocusOptions20 { readonly 'Distance': FloatRange; - readonly 'Speed': FloatRange; + readonly 'Speed'?: FloatRange; } /** @@ -3002,9 +3002,9 @@ export interface RelativeFocusOptions20 { */ export interface WhiteBalance20 { readonly 'Mode': WhiteBalanceMode; - readonly 'CrGain': number; - readonly 'CbGain': number; - readonly 'Extension': WhiteBalance20Extension; + readonly 'CrGain'?: number; + readonly 'CbGain'?: number; + readonly 'Extension'?: WhiteBalance20Extension; } /** @@ -3025,10 +3025,10 @@ export interface WhiteBalance20Extension { */ export interface FocusConfiguration20 { readonly 'AutoFocusMode': AutoFocusMode; - readonly 'DefaultSpeed': number; - readonly 'NearLimit': number; - readonly 'FarLimit': number; - readonly 'Extension': FocusConfiguration20Extension; + readonly 'DefaultSpeed'?: number; + readonly 'NearLimit'?: number; + readonly 'FarLimit'?: number; + readonly 'Extension'?: FocusConfiguration20Extension; } /** @@ -3048,9 +3048,9 @@ export interface FocusConfiguration20Extension { */ export interface WhiteBalanceOptions20 { readonly 'Mode': WhiteBalanceMode; - readonly 'YrGain': FloatRange; - readonly 'YbGain': FloatRange; - readonly 'Extension': WhiteBalanceOptions20Extension; + readonly 'YrGain'?: FloatRange; + readonly 'YbGain'?: FloatRange; + readonly 'Extension'?: WhiteBalanceOptions20Extension; } /** @@ -3069,11 +3069,11 @@ export interface WhiteBalanceOptions20Extension { * */ export interface FocusOptions20 { - readonly 'AutoFocusModes': AutoFocusMode; - readonly 'DefaultSpeed': FloatRange; - readonly 'NearLimit': FloatRange; - readonly 'FarLimit': FloatRange; - readonly 'Extension': FocusOptions20Extension; + readonly 'AutoFocusModes'?: AutoFocusMode; + readonly 'DefaultSpeed'?: FloatRange; + readonly 'NearLimit'?: FloatRange; + readonly 'FarLimit'?: FloatRange; + readonly 'Extension'?: FocusOptions20Extension; } /** @@ -3118,9 +3118,9 @@ export interface MessageExtension { * */ export interface ItemList { - readonly 'SimpleItem': any; - readonly 'ElementItem': any; - readonly 'Extension': ItemListExtension; + readonly 'SimpleItem'?: any; + readonly 'ElementItem'?: any; + readonly 'Extension'?: ItemListExtension; } /** @@ -3137,10 +3137,10 @@ export interface ItemListExtension { * */ export interface MessageDescription { - readonly 'Source': ItemListDescription; - readonly 'Key': ItemListDescription; - readonly 'Data': ItemListDescription; - readonly 'Extension': MessageDescriptionExtension; + readonly 'Source'?: ItemListDescription; + readonly 'Key'?: ItemListDescription; + readonly 'Data'?: ItemListDescription; + readonly 'Extension'?: MessageDescriptionExtension; } /** @@ -3157,9 +3157,9 @@ export interface MessageDescriptionExtension { * */ export interface ItemListDescription { - readonly 'SimpleItemDescription': any; - readonly 'ElementItemDescription': any; - readonly 'Extension': ItemListDescriptionExtension; + readonly 'SimpleItemDescription'?: any; + readonly 'ElementItemDescription'?: any; + readonly 'Extension'?: ItemListDescriptionExtension; } /** @@ -3179,8 +3179,8 @@ export interface Polyline { * */ export interface AnalyticsEngineConfiguration { - readonly 'AnalyticsModule': Config; - readonly 'Extension': AnalyticsEngineConfigurationExtension; + readonly 'AnalyticsModule'?: Config; + readonly 'Extension'?: AnalyticsEngineConfigurationExtension; } /** @@ -3193,8 +3193,8 @@ export interface AnalyticsEngineConfigurationExtension { * */ export interface RuleEngineConfiguration { - readonly 'Rule': Config; - readonly 'Extension': RuleEngineConfigurationExtension; + readonly 'Rule'?: Config; + readonly 'Extension'?: RuleEngineConfigurationExtension; } /** @@ -3219,9 +3219,9 @@ export interface Config { */ export interface ConfigDescription { readonly 'Parameters': ItemListDescription; - readonly 'Messages': any; + readonly 'Messages'?: any; readonly 'ParentTopic': string; - readonly 'Extension': ConfigDescriptionExtension; + readonly 'Extension'?: ConfigDescriptionExtension; } /** @@ -3234,9 +3234,9 @@ export interface ConfigDescriptionExtension { * Lists the location of all schemas that are referenced in the rules. */ export interface SupportedRules { - readonly 'RuleContentSchemaLocation': string; - readonly 'RuleDescription': ConfigDescription; - readonly 'Extension': SupportedRulesExtension; + readonly 'RuleContentSchemaLocation'?: string; + readonly 'RuleDescription'?: ConfigDescription; + readonly 'Extension'?: SupportedRulesExtension; } /** @@ -3252,9 +3252,9 @@ export interface SupportedRulesExtension { * the ONVIF schema file MUST be explicitly listed. */ export interface SupportedAnalyticsModules { - readonly 'AnalyticsModuleContentSchemaLocation': string; - readonly 'AnalyticsModuleDescription': ConfigDescription; - readonly 'Extension': SupportedAnalyticsModulesExtension; + readonly 'AnalyticsModuleContentSchemaLocation'?: string; + readonly 'AnalyticsModuleDescription'?: ConfigDescription; + readonly 'Extension'?: SupportedAnalyticsModulesExtension; } /** @@ -3275,7 +3275,7 @@ export interface PolygonConfiguration { */ export interface PolylineArray { readonly 'Segment': Polyline; - readonly 'Extension': PolylineArrayExtension; + readonly 'Extension'?: PolylineArrayExtension; } /** @@ -3316,11 +3316,11 @@ export interface CellLayout { * Configuration of the streaming and coding settings of a Video window. */ export interface PaneConfiguration { - readonly 'PaneName': string; - readonly 'AudioOutputToken': ReferenceToken; - readonly 'AudioSourceToken': ReferenceToken; - readonly 'AudioEncoderConfiguration': AudioEncoderConfiguration; - readonly 'ReceiverToken': ReferenceToken; + readonly 'PaneName'?: string; + readonly 'AudioOutputToken'?: ReferenceToken; + readonly 'AudioSourceToken'?: ReferenceToken; + readonly 'AudioEncoderConfiguration'?: AudioEncoderConfiguration; + readonly 'ReceiverToken'?: ReferenceToken; readonly 'Token': ReferenceToken; } @@ -3337,7 +3337,7 @@ export interface PaneLayout { */ export interface Layout { readonly 'PaneLayout': PaneLayout; - readonly 'Extension': LayoutExtension; + readonly 'Extension'?: LayoutExtension; } /** @@ -3350,8 +3350,8 @@ export interface LayoutExtension { * This type contains the Audio and Video coding capabilities of a display service. */ export interface CodingCapabilities { - readonly 'AudioEncodingCapabilities': AudioEncoderConfigurationOptions; - readonly 'AudioDecodingCapabilities': AudioDecoderConfigurationOptions; + readonly 'AudioEncodingCapabilities'?: AudioEncoderConfigurationOptions; + readonly 'AudioDecodingCapabilities'?: AudioDecoderConfigurationOptions; readonly 'VideoDecodingCapabilities': VideoDecoderConfigurationOptions; } @@ -3360,7 +3360,7 @@ export interface CodingCapabilities { */ export interface LayoutOptions { readonly 'PaneLayoutOptions': PaneLayoutOptions; - readonly 'Extension': LayoutOptionsExtension; + readonly 'Extension'?: LayoutOptionsExtension; } /** @@ -3374,7 +3374,7 @@ export interface LayoutOptionsExtension { */ export interface PaneLayoutOptions { readonly 'Area': Rectangle; - readonly 'Extension': PaneOptionExtension; + readonly 'Extension'?: PaneOptionExtension; } /** @@ -3442,10 +3442,10 @@ export interface RecordingSummary { * A structure for defining a limited scope when searching in recorded data. */ export interface SearchScope { - readonly 'IncludedSources': SourceReference; - readonly 'IncludedRecordings': RecordingReference; - readonly 'RecordingInformationFilter': XPathExpression; - readonly 'Extension': SearchScopeExtension; + readonly 'IncludedSources'?: SourceReference; + readonly 'IncludedRecordings'?: RecordingReference; + readonly 'RecordingInformationFilter'?: XPathExpression; + readonly 'Extension'?: SearchScopeExtension; } /** @@ -3481,7 +3481,7 @@ export interface MetadataFilter { */ export interface FindRecordingResultList { readonly 'SearchState': SearchState; - readonly 'RecordingInformation': RecordingInformation; + readonly 'RecordingInformation'?: RecordingInformation; } /** @@ -3489,7 +3489,7 @@ export interface FindRecordingResultList { */ export interface FindEventResultList { readonly 'SearchState': SearchState; - readonly 'Result': FindEventResult; + readonly 'Result'?: FindEventResult; } /** @@ -3508,7 +3508,7 @@ export interface FindEventResult { */ export interface FindPTZPositionResultList { readonly 'SearchState': SearchState; - readonly 'Result': FindPTZPositionResult; + readonly 'Result'?: FindPTZPositionResult; } /** @@ -3526,7 +3526,7 @@ export interface FindPTZPositionResult { */ export interface FindMetadataResultList { readonly 'SearchState': SearchState; - readonly 'Result': FindMetadataResult; + readonly 'Result'?: FindMetadataResult; } /** @@ -3548,10 +3548,10 @@ export interface FindMetadataResult { export interface RecordingInformation { readonly 'RecordingToken': RecordingReference; readonly 'Source': RecordingSourceInformation; - readonly 'EarliestRecording': string; - readonly 'LatestRecording': string; + readonly 'EarliestRecording'?: string; + readonly 'LatestRecording'?: string; readonly 'Content': Description; - readonly 'Track': TrackInformation; + readonly 'Track'?: TrackInformation; readonly 'RecordingStatus': RecordingStatus; } @@ -3585,7 +3585,7 @@ export interface TrackInformation { */ export interface MediaAttributes { readonly 'RecordingToken': RecordingReference; - readonly 'TrackAttributes': TrackAttributes; + readonly 'TrackAttributes'?: TrackAttributes; readonly 'From': string; readonly 'Until': string; } @@ -3595,10 +3595,10 @@ export interface MediaAttributes { */ export interface TrackAttributes { readonly 'TrackInformation': TrackInformation; - readonly 'VideoAttributes': VideoAttributes; - readonly 'AudioAttributes': AudioAttributes; - readonly 'MetadataAttributes': MetadataAttributes; - readonly 'Extension': TrackAttributesExtension; + readonly 'VideoAttributes'?: VideoAttributes; + readonly 'AudioAttributes'?: AudioAttributes; + readonly 'MetadataAttributes'?: MetadataAttributes; + readonly 'Extension'?: TrackAttributesExtension; } /** @@ -3611,7 +3611,7 @@ export interface TrackAttributesExtension { * Average bitrate in kbps. */ export interface VideoAttributes { - readonly 'Bitrate': number; + readonly 'Bitrate'?: number; readonly 'Width': number; readonly 'Height': number; readonly 'Encoding': string; @@ -3622,7 +3622,7 @@ export interface VideoAttributes { * The bitrate in kbps. */ export interface AudioAttributes { - readonly 'Bitrate': number; + readonly 'Bitrate'?: number; readonly 'Encoding': string; readonly 'Samplerate': number; } @@ -3667,7 +3667,7 @@ export interface GetRecordingsResponseItem { * Configuration of a track. */ export interface GetTracksResponseList { - readonly 'Track': GetTracksResponseItem; + readonly 'Track'?: GetTracksResponseItem; } /** @@ -3685,8 +3685,8 @@ export interface RecordingJobConfiguration { readonly 'RecordingToken': RecordingReference; readonly 'Mode': RecordingJobMode; readonly 'Priority': number; - readonly 'Source': RecordingJobSource; - readonly 'Extension': RecordingJobConfigurationExtension; + readonly 'Source'?: RecordingJobSource; + readonly 'Extension'?: RecordingJobConfigurationExtension; } /** @@ -3704,10 +3704,10 @@ export interface RecordingJobConfigurationExtension { * device to obtain data from a profile that exists on the local device. */ export interface RecordingJobSource { - readonly 'SourceToken': SourceReference; - readonly 'AutoCreateReceiver': boolean; - readonly 'Tracks': RecordingJobTrack; - readonly 'Extension': RecordingJobSourceExtension; + readonly 'SourceToken'?: SourceReference; + readonly 'AutoCreateReceiver'?: boolean; + readonly 'Tracks'?: RecordingJobTrack; + readonly 'Extension'?: RecordingJobSourceExtension; } /** @@ -3731,8 +3731,8 @@ export interface RecordingJobTrack { export interface RecordingJobStateInformation { readonly 'RecordingToken': RecordingReference; readonly 'State': RecordingJobState; - readonly 'Sources': RecordingJobStateSource; - readonly 'Extension': RecordingJobStateInformationExtension; + readonly 'Sources'?: RecordingJobStateSource; + readonly 'Extension'?: RecordingJobStateInformationExtension; } /** @@ -3754,7 +3754,7 @@ export interface RecordingJobStateSource { * */ export interface RecordingJobStateTracks { - readonly 'Track': RecordingJobStateTrack; + readonly 'Track'?: RecordingJobStateTrack; } /** @@ -3763,7 +3763,7 @@ export interface RecordingJobStateTracks { export interface RecordingJobStateTrack { readonly 'SourceTag': string; readonly 'Destination': TrackReference; - readonly 'Error': string; + readonly 'Error'?: string; readonly 'State': RecordingJobState; } @@ -3796,7 +3796,7 @@ export interface AnalyticsEngine { */ export interface AnalyticsDeviceEngineConfiguration { readonly 'EngineConfiguration': EngineConfiguration; - readonly 'Extension': AnalyticsDeviceEngineConfigurationExtension; + readonly 'Extension'?: AnalyticsDeviceEngineConfigurationExtension; } /** @@ -3817,8 +3817,8 @@ export interface EngineConfiguration { * */ export interface AnalyticsEngineInputInfo { - readonly 'InputInfo': Config; - readonly 'Extension': AnalyticsEngineInputInfoExtension; + readonly 'InputInfo'?: Config; + readonly 'Extension'?: AnalyticsEngineInputInfoExtension; } /** @@ -3842,7 +3842,7 @@ export interface AnalyticsEngineInput { export interface SourceIdentification { readonly 'Name': string; readonly 'Token': ReferenceToken; - readonly 'Extension': SourceIdentificationExtension; + readonly 'Extension'?: SourceIdentificationExtension; } /** @@ -3855,8 +3855,8 @@ export interface SourceIdentificationExtension { * */ export interface MetadataInput { - readonly 'MetadataConfig': Config; - readonly 'Extension': MetadataInputExtension; + readonly 'MetadataConfig'?: Config; + readonly 'Extension'?: MetadataInputExtension; } /** @@ -3873,7 +3873,7 @@ export interface AnalyticsEngineControl { readonly 'EngineConfigToken': ReferenceToken; readonly 'InputToken': ReferenceToken; readonly 'ReceiverToken': ReferenceToken; - readonly 'Multicast': MulticastConfiguration; + readonly 'Multicast'?: MulticastConfiguration; readonly 'Subscription': Config; readonly 'Mode': ModeOfOperation; } @@ -3890,7 +3890,7 @@ export interface AnalyticsStateInformation { * */ export interface AnalyticsState { - readonly 'Error': string; + readonly 'Error'?: string; readonly 'State': string; } @@ -3898,10 +3898,10 @@ export interface AnalyticsState { * 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. */ export interface ActionEngineEventPayload { - readonly 'RequestInfo': Envelope; - readonly 'ResponseInfo': Envelope; - readonly 'Fault': Fault; - readonly 'Extension': ActionEngineEventPayloadExtension; + readonly 'RequestInfo'?: Envelope; + readonly 'ResponseInfo'?: Envelope; + readonly 'Fault'?: Fault; + readonly 'Extension'?: ActionEngineEventPayloadExtension; } /** @@ -3922,8 +3922,8 @@ export interface AudioClassCandidate { * Array of audio class label and class probability */ export interface AudioClassDescriptor { - readonly 'ClassCandidate': AudioClassCandidate; - readonly 'Extension': AudioClassDescriptorExtension; + readonly 'ClassCandidate'?: AudioClassCandidate; + readonly 'Extension'?: AudioClassDescriptorExtension; } /** @@ -3944,8 +3944,8 @@ export interface ActiveConnection { * */ export interface ProfileStatus { - readonly 'ActiveConnections': ActiveConnection; - readonly 'Extension': ProfileStatusExtension; + readonly 'ActiveConnections'?: ActiveConnection; + readonly 'Extension'?: ProfileStatusExtension; } /** @@ -3970,8 +3970,8 @@ export interface OSDReference { */ export interface OSDPosConfiguration { readonly 'Type': string; - readonly 'Pos': Vector; - readonly 'Extension': OSDPosConfigurationExtension; + readonly 'Pos'?: Vector; + readonly 'Extension'?: OSDPosConfigurationExtension; } /** @@ -3999,13 +3999,13 @@ export interface OSDColor { */ export interface OSDTextConfiguration { readonly 'Type': string; - readonly 'DateFormat': string; - readonly 'TimeFormat': string; - readonly 'FontSize': number; - readonly 'FontColor': OSDColor; - readonly 'BackgroundColor': OSDColor; - readonly 'PlainText': string; - readonly 'Extension': OSDTextConfigurationExtension; + readonly 'DateFormat'?: string; + readonly 'TimeFormat'?: string; + readonly 'FontSize'?: number; + readonly 'FontColor'?: OSDColor; + readonly 'BackgroundColor'?: OSDColor; + readonly 'PlainText'?: string; + readonly 'Extension'?: OSDTextConfigurationExtension; } /** @@ -4019,7 +4019,7 @@ export interface OSDTextConfigurationExtension { */ export interface OSDImgConfiguration { readonly 'ImgPath': string; - readonly 'Extension': OSDImgConfigurationExtension; + readonly 'Extension'?: OSDImgConfigurationExtension; } /** @@ -4054,9 +4054,9 @@ export interface ColorOptions { * Describe the option of the color and its transparency. */ export interface OSDColorOptions { - readonly 'Color': ColorOptions; - readonly 'Transparent': IntRange; - readonly 'Extension': OSDColorOptionsExtension; + readonly 'Color'?: ColorOptions; + readonly 'Transparent'?: IntRange; + readonly 'Extension'?: OSDColorOptionsExtension; } /** @@ -4070,12 +4070,12 @@ export interface OSDColorOptionsExtension { */ export interface OSDTextOptions { readonly 'Type': string; - readonly 'FontSizeRange': IntRange; - readonly 'DateFormat': string; - readonly 'TimeFormat': string; - readonly 'FontColor': OSDColorOptions; - readonly 'BackgroundColor': OSDColorOptions; - readonly 'Extension': OSDTextOptionsExtension; + readonly 'FontSizeRange'?: IntRange; + readonly 'DateFormat'?: string; + readonly 'TimeFormat'?: string; + readonly 'FontColor'?: OSDColorOptions; + readonly 'BackgroundColor'?: OSDColorOptions; + readonly 'Extension'?: OSDTextOptionsExtension; } /** @@ -4089,7 +4089,7 @@ export interface OSDTextOptionsExtension { */ export interface OSDImgOptions { readonly 'ImagePath': string; - readonly 'Extension': OSDImgOptionsExtension; + readonly 'Extension'?: OSDImgOptionsExtension; } /** @@ -4105,9 +4105,9 @@ export interface OSDConfiguration { readonly 'VideoSourceConfigurationToken': OSDReference; readonly 'Type': OSDType; readonly 'Position': OSDPosConfiguration; - readonly 'TextString': OSDTextConfiguration; - readonly 'Image': OSDImgConfiguration; - readonly 'Extension': OSDConfigurationExtension; + readonly 'TextString'?: OSDTextConfiguration; + readonly 'Image'?: OSDImgConfiguration; + readonly 'Extension'?: OSDConfigurationExtension; } /** @@ -4129,9 +4129,9 @@ export interface OSDConfigurationOptions { readonly 'MaximumNumberOfOSDs': MaximumNumberOfOSDs; readonly 'Type': OSDType; readonly 'PositionOption': string; - readonly 'TextOption': OSDTextOptions; - readonly 'ImageOption': OSDImgOptions; - readonly 'Extension': OSDConfigurationOptionsExtension; + readonly 'TextOption'?: OSDTextOptions; + readonly 'ImageOption'?: OSDImgOptions; + readonly 'Extension'?: OSDConfigurationOptionsExtension; } /** @@ -4152,8 +4152,8 @@ export interface FileProgress { * Exported file name and export progress information */ export interface ArrayOfFileProgress { - readonly 'FileProgress': FileProgress; - readonly 'Extension': ArrayOfFileProgressExtension; + readonly 'FileProgress'?: FileProgress; + readonly 'Extension'?: ArrayOfFileProgressExtension; } /** @@ -4167,8 +4167,8 @@ export interface ArrayOfFileProgressExtension { */ export interface StorageReferencePath { readonly 'StorageToken': ReferenceToken; - readonly 'RelativePath': string; - readonly 'Extension': StorageReferencePathExtension; + readonly 'RelativePath'?: string; + readonly 'Extension'?: StorageReferencePathExtension; } /** @@ -4205,8 +4205,8 @@ export interface Body { export interface Fault { readonly 'faultcode': any; readonly 'faultstring': string; - readonly 'faultactor': string; - readonly 'detail': detail; + readonly 'faultactor'?: string; + readonly 'detail'?: detail; } /** diff --git a/src/soap/request.ts b/src/soap/request.ts index 543168b..15ee18d 100644 --- a/src/soap/request.ts +++ b/src/soap/request.ts @@ -107,26 +107,20 @@ export interface IXmlContainer { readonly xmlDocument: Document } -// tslint:disable-next-line:readonly-array -export const generateRequestElements = (reqNode: string) => (parameterNodes: string[]) => (...params: any[]) => { - return !params.length - ? `<${reqNode} />` - : `<${reqNode}>${params.map((param, index) => { - const type = typeof param - const insertIntoRootNode = (inner: string) => `<${parameterNodes[index]}>${inner}` - - switch (type) { - case 'undefined': return '' - case 'boolean': return insertIntoRootNode(param) - case 'object': return insertIntoRootNode(Object.keys(param).reduce((acc, key) => { - const val = (param as any)[key] - return val - ? (acc || '') + `<${key}>${(param as any)[key]}` - : (acc || '') - }, '')) - default: return insertIntoRootNode(param) - } - }).join('')}` +export const generateRequestElements = (reqNode: string) => (params: any) => { + const reducer = (obj: any) => (base: string) => (value?: string): any => Object + .keys(obj) + .reduce((acc, key) => { + const value = typeof obj[key] === 'string' + ? obj[key] + : undefined + + return value + ? acc.replace('><', `><${key}>${value}<`) + : acc.replace('><', '>' + reducer(obj[key])(key)() + '<') + }, value ? `<${base}>${value}` : `<${base}>`) + + return reducer(params)(reqNode)() } export const createStandardRequestBody =